Tarkistuslista

Tällä sivulla on joitain tavallisia virheitä, jotka voivat jäädä helposti itseltä huomaamatta, ellei niihin erikseen kiinnitä huomiota.

Teknisiä yksityiskohtia

Seuraavassa on koottuna asioita, joissa tehdään helposti pieniä teknisiä virheitä Latexin kanssa.

Tavutus. Latex tavuttaa tekstin automaattisesti. Tavalliset suomenkieliset sanat menevät kyllä yleensä oikein, mutta yhdyssanojen ja vierasperäisten sanojen kohdalla Latex voi erehtyä.

Huomaa erityisesti, että tekstissäsi voi olla mukana englanninkielisiä sanoja. Jos annat Latexin tavuttaa ne suomen kielen sääntöjen mukaan, tulos on yleensä väärä. Oikean kielen voi tarvittaessa kertoa babel-pakkauksen (dokumentaatio) komennolla \foreignlanguage. Pauli Miettinen antoi seuraavan vinkin: englanninkielisten termien esittelemiseen voi määritellä oman komennon (esimerkiksi \engl) tähän tapaan:

Älä unohda lähdeluetteloa; lähdeluettelossa on lähes aina englanninkielisiä sanoja, joita Latex yrittää tavuttaa. Näihin esimerkiksi \foreignlanguage-komennon soveltaminen voi olla vaikeaa. Yksinkertaisinta lienee tarkistaa kaikki tavurajat lopullisesta versiosta, ja ohjeistaa ongelmallisten sanojen oikea tavutus tarvittaessa \hyphenation-komennolla; samalla komennolla voit myös estää jonkin ongelmallisen sanan tavutuksen kokonaan.

Englannin tavutussääntöjä harvat osaavat. Helpointa on toki estää englanninkielisten sanojen tavutus kokonaan. Jos haluat käyttää tavutusta, tarkista tavurajat aina sanakirjasta kunkin sanan osalta erikseen. Esimerkiksi Oxford Advanced Learner’s Dictionary ja Merriam-Webster Online Dictionary näyttävät sanojen tavutuksen. Huomaa, että englannin kielen tavutuskäytäntöjä on useita.

Rivitys. Latex ei aina saa rivitettyä tekstiä kauniisti, vaan jokin sana voi vuotaa hiukan sivun oikean reunan yli. Erityisen tavallista tämä on paljon kaavoja sisältävän tekstin kohdalla. Latex kyllä varoittaa näistä kaikista. Lue Latexin antamat varoitukset ja korjaa kaikki ongelmakohdat. Joskus riittää pelkkä tavutusvihjeiden lisääminen, mutta välillä ainoa ratkaisu on tekstin muokkaaminen sellaiseksi, että ongelman saa kierrettyä.

Lähdeluettelo. Tarkista, että lähteistä on mukana kaikki tarvittavat tiedot, ja eri lähteet on esitetty yhtenäisesti. Englanninkielisten artikkelien nimissä yleensä käytetään pieniä kirjaimia ("Foo bar of baz"), mutta lehtien ja kirjojen nimissä puolestaan isoja kirjaimia ("Foo Bar of Baz"). Huomaa, että konferenssijulkaisukin on kirja ja konferenssijulkaisussa oleva yksittäinen artikkeli on artikkeli.

Muista, että Bibtex muuntaa artikkelien nimissä olevat suojaamattomat isot kirjaimet automaattisesti pieniksi. Tarkista siis, ettei artikkelien nimessä olevat oleelliset isot kirjaimet ole hukkuneet, ja suojaa ne tarvittaessa {}-merkeillä. Esimerkkejä tällaisista suojattavista isoista kirjaimista ovat lyhenteet ja ihmisten nimet. Huomaa, että artikkelien otsikoissa esiintyy kohtalaisen usein isolla kirjaimella kirjoitettavia ihmisten nimistä johdettuja termejä: Steiner trees, Bayesian networks ja Markov chains.

Katso myös, mitä merkkiä olet käyttänyt lähdeluettelossa ilmoittamaan sivunumerovälejä. Oikea tapa Bibtexissä on 117--126; Latexissahan kaksi peräkkäistä yhdysmerkkiä tarkoittaa väliviivaa. (Useimmat Bibtex-tyylit kyllä korjaavat myös yhden yhdysmerkin väliviivaksi, mutta eivät kuitenkaan korjaa esimerkiksi ylimääräisiä välilyöntejä, joten kannattaa oppia alusta asti tarkkailemaan sitä, miten on sivunumerovälit kirjoittanut.)

Tarkista, ettei lähdeluettelossa ole lähteitä, joihin ei tekstistä viitata lainkaan. Jos käytät työskentelyssä systemaattisesti Latexia, Bibtexiä ja Rubberia, tätä virhettä ei normaalisti pääse syntymään. Varmuuden vuoksi voi vielä tehdä lopullisen version kääntämisen puhtaalta pöydältä: poista ensin kaikki väliaikaistiedostot komennolla ”rubber --clean teksti.tex” ja aja sitten käännös uudestaan komennolla ”rubber -Wall teksti.tex”.

Kaavat. Kirjoita kaikki matemaattinen notaatio kaavana, ja kirjoita kaavat oikein. Jos käytät Latexia, varmistu, että jokainen matemaattinen merkki on kirjoitettu matematiikkamoodissa, esimerkiksi $$-merkkien sisällä. Älä puhu joukosta A tai x-akselista, vaan joukosta $A$ ja $x$-akselista. Älä käytä oikeiden matemaattisten merkintöjen sijaan korviketta. Merkki * tai kirjain x ei ole kertolaskun merkki normaalissa matemaattisessa tekstissä; tulo kirjoitetaan yleensä ilman mitään merkkiä, esimerkiksi $ab$, tai jos kertomerkkiä ei voi jättää pois, esimerkiksi $2 \times 3$ tai $2 \cdot 3$.

Muista myös, että $esim$ ladotaan siten, että se näyttää tulolta e kertaa s kertaa i kertaa m. Jos tarkoititkin funktiota nimeltä esim, tulos on väärä; luultavasti $\textrm{esim}$ tai AMS-lisäpaketeilla $\operatorname{esim}$ on lähempänä haluamaasi. Samaan tapaan $PSPACE$ näyttää hyvin pahalta.

Fontit. Huomaa tiedoston esimerkki.tex kohta \usepackage{ae,aecompl}. Ilman tätä komentoa Latex käyttää bittikarttafontteja, jotka näyttävät hyvin onnettomilta erityisesti Adobe Readerin vanhemmissa versioissa.

(Jos tekniset yksityiskohdat kiinnostavat, lue lyhyt2e.pdf. Tiivistettynä kyse on tästä: Komento \usepackage[T1]{fontenc} vaaditaan, jotta skandinaavisia merkkejä sisältävien sanojen tavutus onnistuisi; laitoksen tyyli asettaa tämän automaattisesti. Tämä komento puolestaan valitsee kirjasimen, josta ei ole muuta kuin bittikarttaversio. Pakkaus ae korjaa tämän.)

Fonttien tarkistamiseen on olemassa helppo komentorivityökalu: pdffonts. Normaalisti tulosteessa pitäisi näkyä vain Type 1 -fontteja; tämä tarkoittaa käytännössä skaalautuvaa vektorifonttia. Jos tulosteessa näkyy Type 3 -fontteja, jossain on vikaa; nämä ovat käytännössä niitä ei-toivottuja bittikarttafontteja.

Sivunumerot. Laitoksen tyylipohjassa pitää korjata sivunumerointi, jos työssä ei ole sisällysluetteloa. Muuten sivunumeroinniksi tulee "i", "ii", jne. Tarvittava komento on \pagenumbering{arabic}.

Sivun koko. Tarkista, että pdf-tiedoston sivun koko on A4 eli 297 mm × 210 mm. Sivukoon voi tarkistaa esim. Adobe Readerista (File / Document properties) tai komentorivityökalulla pdfinfo. Jos teet suoraan pdflatexilla pdf-tiedoston, tämän pitäisi olla suoraan kunnossa. Jos sen sijaan teet vaikeasti (ensin latexilla dvi-tiedosto, sitten dvips:llä PostScript-tiedosto ja lopuksi ps2pdf:llä pdf-tiedosto), voit joutua huolehtimaan erikseen, että käytät dvips-komennossa parametria -t a4.

Kieli

Oikeinkirjoitus. Hyvä lähde oikeinkirjoituksen kertaamiseen on tuore Kielitoimiston oikeinkirjoitusopas (2007). Kannattaa palauttaa mieleen esimerkiksi pilkkusäännöt; virheitä tulee helposti esimerkiksi rinnastuskonjunktiolla yhdistettyjen päälauseiden sekä rinnastuskonjunktiolla yhdistettyjen sivulauseiden pilkutuksessa.

Sanakirjat. Tavallisten suomen kielen sanojen oikeinkirjoituksen, taivutuksen ja merkityksen voi tarkistaa Kielitoimiston sanakirjasta (2006). Tämä sanakirja on myös osa MOT-sanakirjastoa, johon on pääsy yliopiston verkosta.

Termien suomennokset. Viimeisimmille tietojenkäsittelytieteen erikoistermeille ei välttämättä ole vielä vakiintunutta suomennosta, ja sellaisen voi joutua keksimään itsekin. Huomaa kuitenkin, että erityisesti teoreettisemmissa artikkeleissa esiintyvät termit voivat olla hyvinkin vakiintuneita matematiikan termejä tai suoraan niistä johdettuja termejä. Näille on usein olemassa vakiintuneet suomennokset; kannattaa tutustua esimerkiksi matematiikan laitoksen kurssimateriaaliin ja suomenkielisiin oppikirjoihin. Esimerkiksi ”connected graph” on suomeksi ”yhtenäinen verkko”; muun suomennoksen käyttö antaa helposti kuvan siitä, ettei kirjoittaja tunne alan peruskäsitteitä. Oppimateriaalissa mainittujen sanastojen lisäksi seuraavista voi olla hyötyä:

Oikoluku. Muista ajaa tekstin vihoviimeinen lopullinen versio vielä kerran oikolukuohjelman läpi. Kirjoitusvirheet, jotka saa kiinni oikolukuohjelmalla, ovat turhia virheitä. Kirjoitusvirheitä syntyy yllättävän helposti juuri siihen viimeiseen pieneen muutokseen, jonka tekee muuten valmiiseen tekstiin.

Tekstin rakenne

Esitysjärjestys ja määritelmät. Tekstin ensimmäistä luonnosta kirjoitettaessa asiat tulevat yleensä paperille oikeassa järjestyksessä, mutta kun tekstiä on aikansa muokannut, saatetaankin epähuomiossa käyttää termiä ennen kuin se on määritelty. Itse ei näitä välttämättä huomaa, sillä määritelmät ovat toki kirjoittajalle tuttuja. Kannattaa erikseen tarkistaa kaikkien keskeisten käsitteiden, symbolien ja vastaavien osalta, että ne tulevat huolella määritellyiksi sopivassa paikassa ennen ensimmäistä käyttöä. Toisaalta kannattaa myös tarkistaa, ettei määrittele turhaan mitään termiä, jota ei kirjoituksessa tarvita.

Alaviitteet. On joitain tilanteita, joissa alaviite voi olla oikeasti paikallaan. Jos haluaa esimerkiksi mainita, mistä web-osoitteesta jokin työssä käytetty data on haettavissa, osoitteen kirjoittaminen alaviitteeseen voi olla tyylikkäämpää kuin osoitteen kirjoittaminen suoraan tekstiin. Useimmiten alaviitteet ovat kuitenkin tarpeettomia; ne sekoittavat tekstin rakennetta ja hidastavat lukemista.

Kuvat ja taulukot

Tarkista, että kuvat ja vastaavat on luettavissa ja ymmärrettävissä sekä näytöllä että mustavalkoisessa tulosteessa vaivattomasti.

Kuvaajat. Tarkista, että jokaisessa kuvaajassa on molemmilla akseleilla selitteet: sekä mitattu suure että mittayksikkö. Merkitse nämä itse kuvaajaan; älä tyydy kirjoittamaan selityksiä kuvatekstiin.

Taulukot. Älä ylikäytä taulukoissa erilaisia viivoja, värejä ja sekalaisia korostustapoja. Hillitty tyyli, reilu tyhjän tilan käyttö ja muutama harkittu vaakaviiva riittää yleensä pitkälle; booktabs-pakkauksen dokumentaatiossa on joitain hyviä neuvoja. Katso, että jokainen sarake on tasattu järkevästi; esimerkiksi desimaaliluvut olisi syytä tasata desimaalipilkun kohdalta. Mieti, mitä taulukon tietoja lukija haluaisi tyypillisesti verrata keskenään ja tarkista, että tämä onnistuu helposti. Mieti, voisiko taulukon saada esitettyä selkeämmin, jos siinä vaihtaisi rivit ja sarakkeet keskenään; esimerkiksi päällekkäisissä taulukon soluissa olevien lukujen vertaaminen toisiinsa on paljon helpompaa kuin vierekkäisissä soluissa olevien lukujen vertailu.

Tiivistelmäsivu

ACM-luokitus. Lue huolella ACM:n ohjeet siitä, miten ACM:n luokittelujärjestelmää käytetään. Jos käytetään kolmannen tason luokkia, oikea muoto on ”G.2.2 [Discrete Mathematics]: Graph Theory”. Hakasulkeisiin tulee siis toisen tason otsikko ja kaksoispisteen jälkeen kolmannen tason otsikko.

Kiitokset: Pauli Miettiselle \foreignlanguage-vinkistä.