UUDEN DOKUMENTIN LUOMINEN

Hakemisto dokumentti sisältää yhden dokumentin tarvitsemat perustiedostot.
Tarkoitus on, ettei näihin tehdä muutoksia, vaan dokumentin kirjoitus
aloitetaan kopioimalla hakemiston tiedostot uuteen hakemistoon. Esimerkiksi
projektisuunnitelma aloitettaisiin seuraavalla komennolla:

	cp -r dokumentti projektisuunnitelma

Tämän jälkeen projektisuunnitelma-hakemisto sisältää seuraavat tiedostot:

Makefile
	Sisältää dokumentin tuottamiseen liittyviä säännöksiä. Näiden
	muuttaminen vaatii asiantuntemusta.

dokumentti.tex
	Dokumentin runko. Tänne kirjoitetaan dokumentin nimi.

liitteet.tex
	Liitteet. Perusversio ei sisällä liitteitä.

sisalto.tex
	Varsinainen sisältö. Suurin osa tekstistä tulee tänne. Katso
	mallitiedoston esimerkit!

versio.tex
	Versiohistoria löytyy täältä. Kun dokumentista toimitetaan versio
	asiakkaalle, vastuuhenkilölle tai ohjaajalle tarkistettavaksi, tulee
	dokumentin versionumeroa nostaa.



KÄYTTÖOHJE

Komento make tuottaa pdf-tiedoston dokumentti.pdf.

Seuraavat komennot ovatmyös hyödyllisiä:

make clean
	Poistaa tilapäistiedostot. Jos huomaat, ettei tekemäsi muutos näy,
	käytä tätä komentoa, jonka jälkeen dokumentti muodostetaan alusta
	asti uudelleen.

make ps
	Tuottaa pdf-tiedostosta PostScript-tiedoston.

make vihko
	Tuottaa PostScript-tiedoston nimeltä dokumentti-vihko.ps, joka
	kaksipuoleisesti tulostettuna voidaan taittaa vihkoksi. Säästä
	paperia ja käytä tätä kun tulostat omaa käyttöä varten.

Make-ohjelma tulee käynnistää siinä hakemistossa, missä dokumentin Makefile
sijaitsee.

Kaikille asiakirjoille yhteiset käsitteet määritellään tiedostossa
asetukset.tex, joka löytyy pohjat-hakemistosta. Asetuksina kirjataan
esimerkiksi projektin nimi ja projektiryhmän jäsenet. Samasta hakemistosta
löytyy tiedosto lahteet.bib, joka sisältää eri dokumenttien lähdeviitteet.

Hakemistosta pohjat löytyy myös tiedosto sanasto.tex, johon kootaan kaikki
dokumenteissa tarvittavat sanamääritelmät aakkosjärjestykseen. Katso ohjeet
sanaston käyttöönottamiseksi dokumenteissa kyseisestä tiedostosta.

Dokumenttipohja perustuu Tieteellisen kirjoittamisen kurssin vastaavaan
tyylitiedostoon. Pohjaa kehitetään kevään 2004 aikana opiskelijoilta saadun
palautteen pohjalta. Kehitysideoita voi lähettää sähköpostilla osoitteeseen
ohtu@cs.helsinki.fi.



TYYLIOHJEITA

- Käytä asiakirjoissa aina Latin1-koodausta (iso-8859-1).

- Pyri välttämään lihavoinnin, kursivoinnin ym. muotoilujen käyttöä - luodaan
sen sijaan käyttötarkoituksen mukaan oma komento.

- Jätä ennen otsikoita (\section, \subsection jne.) kolme riviä tyhjää, jotta
otsikko on helpompi paikallistaa lähdetiedostosta.

- Älä rivitä kappaleita, LaTeX huolehtii siitä itse. Näin kappaleita on
selkeämpi muokata.