Dokumentin nimi LOGO:) Tampereen teknillinen yliopisto. Ryhmä XXX: Projektiryhmän nimi Projektin nimi

Transkriptio

1 Tampereen teknillinen yliopisto Ohjelmistotekniikan laitos OHJ-3500 Ohjelmistotuotannon projektityö LOGO:) Ryhmä XXX: Projektiryhmän nimi Projektin nimi Dokumentin nimi Jakelu: (Ryhmä) (Kurssihenkilökunta) (Asiakas) Ryhmä Teemu Teekkari Tiina Teekkari Ahto Simakuutio Alfred J. Nussi Vastuuhenkilö: Teemu Teekkari Tila: Dokumenttipohja Versio: 1.2 Muokattu:

2 Versiohistoria Versio: Pvm: Tekijä: Kuvaus (muutokset, korjaukset): R1 Dokumenttipohja luotu R1 Muokattu pohja yleiseen jakeluun P. Koivuniemi Muutoksia pohjaan ja jokunen lisäys R13 pohjan perusteella T. Lainio Viittaustyyli muutettu ja pohja muokattu käyttämään monen sivun taulukoita sekä Latin9-koodausta. Muokattu: /9

3 Sisältö 1 Johdanto Tarkoitus ja kattavuus Määritelmät, termit ja lyhenteet Viittaukset Yleiskatsaus dokumenttiin Kuvat Esimerkkikuva Esimerkkitaulukko Viittaaminen Kuinka viitataan Erikoisemmat viittaukset Otsikko Otsikko Otsikko Otsikko Otsikko Liitteet 9 Liite A: Esimerkki Liite B: Puulistaus Muokattu: /9

4 Luku 1 Johdanto 1.1 Tarkoitus ja kattavuus Tämä L A TEX-dokumenttipohja on tarkoitettu kaikille, jotka tuntevat tarvetta sen käyttöön. Dokumenttipohjaa saa muokata ja levittää vapaasti. Tätä dokumenttipohjaa käyttivät vuoden projektityökurssilla Vesa Poikajärvi, Tuukka Rouvinen, Janne Sikiö, Jouni Sonninen sekä Ari Takku. Pohja on muokattu vuoden 1999 pohjan avulla. Lisäksi kiitokset Pekka Virtaselle ja Mikko Matilaiselle, joilta on myös saatu apuja pohjan luomiseen. Tämän jälkeen pohjaa on muokannut kesällä 2004 projektityökurssin puolesta Pasi Koivuniemi. Tätä dokumenttipohjaa käyttivät ja muokkasivat vuoden projektityökurssilla Teppo Lainio, Juhani Lauteala, Risto Oikarinen, Jarno Mannelin ja Iiro Vidberg. 1.2 Määritelmät, termit ja lyhenteet Taulukko 1.1: Dokumentissa käytettävät termit ja määritelmät Lyhenne: Selitys: HTML Hypertext Markup Language, versio HTTP Hypertext Transfer Protocol 1.1, RFC 2616 Jatkuu seuraavalla sivulla... Muokattu: /9

5 Termi: Java JRE Taulukko 1.1 Jatkoa Selitys: Sun Microsystemsin alustariippumaton ohjelmointikieli Java Runtime Environment, Javan ajoympäristö Viittaukset [Code 00] Code Conventions for the Java TM Programming Language. Sun Microsystems, Inc., CodeConvTOC.doc.html. Sivuilla käyty viimeksi: [W3C 99] W3C. HTML 4.01 Specification. Internet, w3.org/tr/1999/rec-html /. Sivuilla käyty viimeksi: Yleiskatsaus dokumenttiin Tässä dokumentissa on vain malli, miten dokumentin rungon voisi tehdä. Muokattu: /9

6 Luku 2 Kuvat 2.1 Esimerkkikuva LOGO:) Kuva 2.1: Projektiryhmän logo. Kuten kuvasta 2.1 näkee, on ryhmällä ollut hyvä mielikuvitus logoa tehdessä. Kyseinen kuva on selkeyden vuoksi rajattu kehyksin. 2.2 Esimerkkitaulukko Taulukko 2.1: Tieteellisiä yksiköitä Mitattava suure: Yksikön nimi: Yksikön tunnus: Lämpötila Perunankeittoyksikkö Likviditeetti My precious e (op) Vuosikurssi n C Projektin edetessä ryhmä saattaa tarvita taulukossa 2.1 esiteltyjä poikkitieteellisiä yksiköitä. Muokattu: /9

7 Luku 3 Viittaaminen 3.1 Kuinka viitataan Voi olla, että dokumenttia tehdessä pitää viitata johonkin julkaisuun tai vaikkapa Internet-sivustoon. Tämä onnistuu lisäämällä tarvittavat tiedot viittaukset/viittaukset.bib-tiedostoon. Tämä dokumentti käyttää viittaustyylinä tiedostosta wmaainf.bst löytyvää tyyliä wmaainf. HTML [W3C 99] on hyvin suosittu merkkauskieli. Kuitenkin Javalla koodatessa on syytä muistaa tyyliohjeet [Code 00]. 3.2 Erikoisemmat viittaukset Eri dokumenttien väliset ristiviittaukset onnistuvat esimerkiksi L A TEX-paketin xr avulla. Viittaukset saa käyttöön komennon \externaldocument{} avulla. Tarkemmat ohjeet selviävät kyseisen paketin manuaalista. Muokattu: /9

8 Luku 4 Otsikko 1 Tässä luvussa esitellään L A TEX:n eri otsikkotasoja. 4.1 Otsikko Otsikko Otsikko Otsikko 5 Muokattu: /9

9 Liitteet Liite: Kuvaus: Sivuja: Liite A Esimerkki 1 Liite B Puulistaus 1 Muokattu: /9

10 Ryhmä XXX. Projektin nimi Esimerkki Liite A Esimerkki 1/1

11 Ryhmä XXX. Projektin nimi Puulistaus Liite B Puulistaus Joskus on tarpeen esittää listoja puumaisessa rakenteessa. Se onnistuu seuraavasti. Puun eri tasojen väliin jäävää väliä saa säädettyä tämän liitteen lähdekoodista. B.1 Listaus Juuri1 Juuri2 Lehti1 Lehti2 Juuri3 Lehti3 Kommentti 1/1