Dokumentteja ja Subversionia

Kirjoittanut Mikko Leino
VersioKuvaus
1.0Ensimmäinen versio netissä
1.01Linkkien korjaus

Yritän tässä selittää kuinka uusia dokumentteja luodaan projektillemme. Samalla tulee opetelluksi (tai kerratuksi!) SVN:in perusteet.

Aluksi on haettava työkopio SVN:ista dokumentit-hakemistosta. Se tapahtuu näin:

svn checkout file:///home/group/pusu/svn/dokumentit

Jos työskentelet kotoa käsin, niin polku on svn+ssh://OMATUNNUS@shell.cs.helsinki.fi/home/group/pusu/svn/dokumentit. Ensimmäisen kerran jälkeen ei tarvitse enää checkoutata (suomeksi?) vaan uusimman version voi hakea suoraan komennolla:

svn update

Sait ainakin seuraavat hakemistot reposta (suomeksi?):

dokumentit
dokumentit/dokumentti
dokumentit/pohjat

Hakemistossa pohjat on kaikille dokumenteille yhteisiä asetuksia sun muuta tärkeää :-) Dokumentti-hakemistossa on pohja (onkohan nämä nyt nimetty vähän epäselvästi?) uusille luotaville dokumenteille.

Aloitetaan uuden dokumentin työstäminen kopiomalla pohja:

cp -r dokumentti esimerkkidokumentti

Nyt sait uuden hakemiston, jonka sisältö on seuraavanlainen:

esimerkkidokumentti/Makefile
esimerkkidokumentti/dokumentti.tex
esimerkkidokumentti/liitteet.tex
esimerkkidokumentti/sisalto.tex
esimerkkidokumentti/versio.tex

Makefile huolehtii pdf:n luomisesta. Dokumentti.tex on dokumentin runko. Liitteet.tex tiedostoon kirjoitetaan dokumentin mahdollisesti sisältämät liitteet (ylläri?). Sisalto.tex on dokumentin varsinainen sisältö, suurin osa tekstistä menee sinne. Versio.tex:iin kirjoitetaan dokumentin versionumerot.

Ensiksi nimeämme dokumentti.tex:n, esimerkiksi näin:

mv dokumentti.tex esimerkkidokumentti.tex

Tämän jälkeen muutamme Makefilestä rivin:

DOCNAME = dokumentti

Siihen kuuluu dokumenttimme tiedostonimi ilman päätettä, eli tässä esimerkissä:

DOCNAME = esimerkkidokumentti

Olethan tarkkana, ettei rivin perään jää välilyöntejä tai make antaa virhettä.

Sitten lisäämme esimerkkidokumentti.tex:iin dokumenttimme otsikon. Se löytyy tämän näköiseltä riviltä:

\title{Dokumentin otsikko}

Esimerkissämme se voisi olla:

\title{Esimerkkidokumentti}

Versio.tex:iin pitää päivittää oikea versionumero. Tiedoston muoto on:

1.0 & 6.9.2007 & Ensimmäinen versio \\
1.1 & 7.9.2007 & Toinen versio \\

Nyt onkin aika kirjoittaa varsinainen dokumentti! Se menee sisalto.tex:iin. Sisalto.tex on tynkä dokumentti, jossa on esimerkki yleisimmistä jutuista, otsikoista yms. Lisäksi lopussa on hyödyllisiä linkkejä, jos LaTeX on uusi tuttavuus.

Kun sisalto.tex on valmis on aika tehdä pdf tai esikatsella tuloksia. Katsotaanpa mitä make:lla voi tehdä.

make

Tekee esimerkkidokumentti.ps-tiedoston.

make esimerkkidokumentti-2.ps

Tekee PostScript-tiedoston, jossa on kaksi sivua arkilla. Kätevä omaan käyttöön ja säästää luontoa! Jei!

make pdf

Tekee esimerkkidokumentti.pdf-tiedoston.

make clean

Poistaa kaikki make:n tekemät tiedostot. Paljon tilapäistiedostoja ja tehdyt ps:t ja pdf:t. Kokeile tätä, jos muutoksesi eivät näy.

Kun olet tyytyväinen tuotokseesi on aika laittaa uusi dokumentti versionhallinnan piiriin. Komenna:

svn add dokumentit/esimerkkidokumentti

Viimeiseksi viedään muutokset repoon. Näin se käy:

svn commit --message="Esimerkkidokumentin ensimmäinen versio!"

Valmis! Nyt sumppia.

Viitteitä parempaa sisältöön

SVN

LaTeX