---

Tekijä: Antti-Juhani Kaijanaho ja Vesa Lappalainen

Yhteystiedot: Ag C416.1,

Ohjaaja: Ohjaamaton työ

Työn nimi: Gradun kirjoittaminen TIMillä

Title in English: Usage of the gradu3 document class for LaTeX theses

Työ: pro gradu -tutkielma

Suuntautumisvaihtoehto: Kaikki suuntautumisvaihtoehdot

Sivumäärä: ?

Tiivistelmä: Tämä kirjoitelma on esimerkki siitä, kuinka TIMillä kirjoitetaan gradua. Se sisältää myös käyttöohjeet ja tutkielman rakennetta koskevia ohjeita.

Tutkielman tiivistelmä on tyypillisesti lyhyt esitys, jossa kerrotaan tutkielman taustoista, tavoitteesta, tutkimusmenetelmistä, saavutetuista tuloksista, tulosten tulkinnasta ja johtopäätöksistä. Tiivistelmän tulee olla niin lyhyt, että se, englanninkielinen abstrakti ja muut metatiedot mahtuvat kaikki samalle sivulle.

Avainsanat: TIM, LaTeX, gradu3, pro gradu -tutkielmat, kandidaatintutkielmat, käyttöohje

Abstract: This document is a sample gradu3 thesis document class document. It also functions as a user manual and supplies guidelines for structuring a thesis document.

The English abstract of a thesis should usually say exactly the same things as the Finnish tiivistelmä.

Keywords: TIM, LaTeX, gradu3, Master's Theses, Bachelor's Theses, user's guide

1. Johdanto

Tutkielman varsinainen teksti alkaa aina luvulla ”Johdanto”. Sen kirjoittamisen voi hyvin jättää aivan tutkielman kirjoitusprosessin loppuvaiheisiin.

Johdanto kannattaa aloittaa napakasti esittämällä heti alussa tutkielman pääväite tai tutkimuskysymys. Tämän jälkeen kannattaa selventää asioita määrittelemällä tarvittavat käsitteet.¹ Johdannossa voit myös kertoa, miksi väite on käytännön tai tieteen (tai parhaimmillaan molempien) kannalta relevantti ja mielenkiintoinen. Erinomaista olisi, jos kertoisit johdannossa lyhyesti myös, mikä on tutkielmasi kontribuutio eli mitä sellaista tietoa tutkielmasi sisältää, jonka olet itse selvittänyt sen sijaan että olisit sen lähteestä lukenut. Kontribuutio voi hyvin olla myös se, että olet itse tarkastanut jonkin lähteestä löytyneen väitteen todenperäisyyden. Johdannon lopuksi on tapana esitellä lyhyesti tutkielman rakenne – mitä missäkin luvussa käsitellään.

Tämä malli käsittelee Jyväskylän yliopiston tietotekniikan oppiaineessa tehtävien kandidaatintutkielmien ja pro gradu -töiden laatimista avustavaa LaTeX-kirjoitelmaluokkaa gradu3 (versio 3.7). Apua sen käyttämiseen voit saada Tutkielma-TeX-postituslistalta (http://lists.jyu.fi/mailman/listinfo/tutkielma-tex). Kommentteja, parannusehdotuksia ja bugiraportteja voit lähettää myös minulle suoraan.

Tämä malli olettaa, että tunnet LaTeX-järjestelmän käytön perusasiat. Alkuperäinen LaTeX-kirja (Lamport 1994) on järjestelmän virallinen käyttöopas. Olen myös itse kirjoittanut aiheesta opaskirjan (Kaijanaho 2003).² Hyvä suomenkielinen, vapaasti verkosta saatavilla oleva opas on Pitkänpuoleinen johdanto LaTeXe:n käyttöön (Oetiker ym. 2005). Muista lukea tämän mallin ladotun version (PDF tms) lisäksi sen LaTeX-lähdekoodi!

Huomaa, että tämän mallin esittämät ohjeet eivät ole millään tavalla virallisia. Noudata aina ohjaajasi neuvoja vaikka ne poikkeaisivatkin tämän mallin ohjeista.

1=opus_kissa

---

1. Määritelmät vasta väitteen jälkeen! Äläkä jaarittele johdannossa.↩︎

2. Monet TeX- ja LaTeX-kirjat käyttävät kansikuviensa aiheena kissaeläintä. Oman monisteeni kansikuva oli varsin abstrakti kisuli, ks. kuvio 1.↩︎

2. Tutkielman rakenne

Yhteensä tutkielmassa on hyvä olla 5–9 numeroitua lukua, siis Johdanto ja Yhteenveto mukaan lukien. Tarvittaessa voit käyttää alilukuja tarkempaan jäsentelyyn.

Johdannon ja Yhteenvedon väliin jääviä lukuja kutsutaan toisinaan tutkielman käsittelyosaksi. Usein sen katsotaan jakaantuvan vielä kahtia, jolloin käsittelyosa alkaa teoriaosalla ja päättyy joko päälauseeseen, konstruktiiviseen osaan tai empiiriseen osaan.

2.1 Teoriaosa

Tutkielman teoriaosan tarkoituksena on esitellä tutkielmassa tarvittava teoreettinen tausta. Tämä on syytä tehdä vähintään sillä tarkkuudella, että tutkielman lukija pystyy pelkästään tutkielman itsensä perusteella ymmärtämään kaikki tutkielmassa käytettävät erityiskäsitteet ja -menetelmät. Hyvässä tutkielmassa on myös perusteltu (vaihtoehdot kirjallisuudesta esille tuoden), miksi juuri nämä käsitteet ja menetelmät on työssä käytössä.

Teoriataustan järkevä esitys- ja käyttötapa riippuu siitä, minkä tyyppisestä tutkimuksesta tutkielmassasi on kyse. Matemaattis-teoreettisen työn teoriaosa on aivan eri näköinen kuin konstruktiivisen ohjelmistonkehitystyön teoriaosa; näistä myös eroaa olennaisesti ihmistieteellisiin traditioihin nojautuvan määrällisen tai laadullisen tutkimustuön teoriaosa. Muita samantyyppisiä tutkielmia ja julkaistuja tutkimusraportteja lukemalla saat kyllä käsityksen siitä, mitä omalta työltäsi vaaditaan.

2.2 Teorian jälkeen

Teoriaosan jälkeen tulee työsi varsinainen kontribuutio:

• Matemaattis-teoreettisessa työssä se on yleensä jono itse laatimiasi määritelmiä ja lemmoja, jotka kulminoituvat työn päälauseen todistukseen.

• Konstruktiivisessa työssä se on itse laatimasi tietokoneohjelma tai muu artefakti.

• Empiirisessä työssä se on jotain empiiristä tutkimusmenetelmää soveltamalla saavutettu joukko empiirisiä tuloksia.

Tutkielmassa kontribuutio esitellään varsin tarkasti, tehdyt valinnat perustellen. Erityisesti matemaattis-teoreettisissa ja empiirisissä töissä on syytä noudattaa kulloisenkin tutkimustradition käytänteitä – esimerkiksi ihmistieteellinen koeasetelma on kuvattava tarkasti.

3. Lähteiden käyttö

Teoriaosa perustuu lähes aina yksinomaan lähdekirjallisuuteen. Myös kontribuutio-osassa on lähteiden käyttö toisinaan tarpeen.

Muista varoa plagiointia. Jos kopioit joko sellaisenaan tai lievästi muutettuna (tai esimerkiksi englannista suomennettuna) tekstiä jostain lähteestä, tee selväksi, että olet tehnyt niin. Merkitse lainaukset (lainausmerkeillä tai muulla selkeällä tavalla) ja anna täsmällinen lähdeviite. Jos et lainaa sanatarkasti, merkitse tekemäsi muutokset. Useimmissa tilanteissa on kuitenkin parempi esittää asia omin sanoin, mieluiten useamman lähteen perusteella. Merkitse tällöinkin käyttämäsi lähteet.

Lähdeluettelon laadintaan gradu3 käyttää automaattisesti BibLaTeX-järjestelmää (Lehman ym. 2012) ja sen Chicago-tyyliä (Fussner 2012). Tämän automatiikan saa pois documentclass -optiolla manualbib, mutta tällöin joudut itse huolehtimaan lähdeluettelon muotoilusta eivätkä tässä luvussa esitetyt tekniikat ole (välttämättä) käytettävissä. Huomaa, että tietotekniikan oppiaineen graduissa on suositeltavaa käyttää Chicago-tyylistä lähdeluetteloa.

3.1 Lähdeviittaukset

Lähteisiin voit viitata kahdella tavalla. Ensinnäkin voit käyttää lähdettä lauseen subjektina: (Aho ym. 2007, luku 8.8.4) kuvaavat lyhyesti graafinvärityksen käyttämisen kääntäjän rekisterinvalinnassa. Tällöin viittaukseen käytetään textcite-komentoa. Toisekseen lähdeviite voi olla sivuhuomautus, jota ei ääneen luettaessa mainita: Graafinväritys on yksi mahdollinen tapa valita rekisterit (Aho ym. 2007, luku 8.8.4). Tämä toteutetaan parencite-komennolla.

Sekä textcite- että parencite-komennot ottavat kolme parametria, joista kaksi on valinnaisia. Ensimmäinen on lähdeviittauksen koodi, toinen on (valinnainen) parametri on esihuomautus ja kolmas (valinnainen) parametri on jälkihuomautus (ks. Lehman ym. 2012, luku 3.7). Huomaa että järjestys on erilainen kuin LaTeXin \parencite-komennossa. Edellisen virkkeen lähdeviite tehtiin seuraavalla komennolla:

 %%parencite("biblatex-manual","ks. ", "luku 3.7")%%

Jos komennolle annetaan vain yksi valinnainen argumentti, se tulkitaan esihuomautukseksi. Jos halutaan antaa vain jälkihuomautus ilman jälkihuomautusta, on esihuomautus jätettävä tyhjäksi:

%%parencite("aho-compilers", "", "luku 8.8.4")%%

Seuraava ei vielä toimi TIMissä:
On myös mahdollista viitata useampaan lähteeseen samassa viittauksessa [ks.][luku 3.7]biblatex-manual [ks. lähteiden käytöstä yleisesti myös][luku 5.3.2] biblatex-chicago-manual. Tämä tehdään komennolla \parencites, jolle annetaan kutakin lähdettä kohti samat argumentit kuin yksittäiselle \parencite-komennolle. Komento on hyvä (mutta ei pakko) päättää \relax-komentoon, jotta yllätyksiltä vältyttäisiin.

\parencites%
  [ks.][luku~3.7]{biblatex-manual}%
  [ks.~lähteiden käytöstä yleisesti myös][luku~5.3.2]%
    {biblatex-chicago-manual}%
\relax.

Jos jaat \parencites-komennon usealle riville, päätä rivit kommenttimerkillä (kuten yllä), jotta tulokseen ei ilmaantuisi ylimääräisiä välilyöntejä.

3.2 Lähdetietokanta

Lähteet lisätään erilliseen BibTeX-tiedostomuodossa olevaan lähdetietokantaan. Sen laatimisessa voit käyttää apuna monia lähteidenhallintajärjestelmiä, mutta sen voi laatia myös käsin. Tietokannan nimi kirjoitetaan asetusten texmacros-kohtaan:

texmacros: 
  texbibname: 'lahteet.bib'
  texfiles:
    - kurssit/tie/tutkielmat/gradu/tex/malliopas/gradu3.cls
    - lahteet.bib

Voidaan käyttää myös mihin tahansa muualle tehtyä .bib-tiedostoa ja antaa sen täydellinen osoite texfiles-listaan lahteet.bib tilalle.

TIMissä kirjoitettussa .bib-tiedostoon voi kunkin lähteen laittaa omaan TIM-lohkoonsa ja lohkojen väliin voi lisätä #-alkuislla otsikoilla halutessaan jaksotusta. Tämä toimii, mikäli dokumentin asaetuksissa on:

``` {settings=""}
texplain: .bib
```

BibTeX-muotoinen lähdetietokanta on erityisellä tavalla muotoiltu tekstitiedosto. Se koostuu tietueista, jotka alkavat @-merkillä ja sitä seuraavalla tietuetyypin nimellä. Muu osa tietueesta kirjoitetaan aaltosulkeiden sisään. Esimerkiksi edellä mainittu kääntäjäkirja (Aho ym. 2007) voidaan esittää seuraavanlaisena tietueena:

@Book{aho-compilers,
  author =       {Alfred V. Aho and Monica S. Lam and Ravi Sethi and
                  Jeffrey D. Ullman},
  title =        {Compilers},
  subtitle =     {Principles, Techniques, \& Tools},
  publisher =    {Pearson Addison Wesley},
  year =         2007,
  address =      {Boston},
  edition =      2
}

Tämän tietueen tyyppi on book, joka tarkoittaa luonnollisestikin kirjaa. Aaltosulkeiden sisällä oleva ensimmäinen sana on tietueen koodi, jota käytetään \textcite- ja \parencite-komennoissa. Sen jälkeen tulee pilkku ja joukko nimettyjä kenttiä kuten kirjan kirjoittaja (author), nimi (title), alaotsikko (subtitle) ja julkaisija (publisher). Kenttien sisällöt laitetaan aaltosulkeisiin, tosin pelkkiä numeroita sisältävät kentät voi kirjoittaa ilmankin.

Kirjoittajien nimet kirjoitetaan tietuekenttään pääosin täysin tavanomaisella tavalla. Vaihtoehtoisesti nimi voidaan esittää myös muodossa sukunimi-pilkku-etunimi (Aho, Alfred V.), ja joissakin erityistapauksissa (esimerkiksi moniosainen väliviivaton sukunimi) se on myös pakko tehdä niin. Jos kirjoittajia on useita, heidän nimensä erotetaan sanalla and (jota ei pidä suomentaa!). Jos kaikkia kirjoittajia ei luetella, laitetaan viimeisen nimen perään (ilman lainausmerkkejä) ”and others”.

Jos lähteen tekijäksi on merkitty jokin organisaatio, sen nimi pitää kirjoittaa ylimääräisiin aaltosulkeisiin (esim. Unicode Consortium 2012):

@Book{unicode620,
  author =       {{Unicode Consortium}},
  title =        {The Unicode Standard, Version 6.2.0},
  year =         {2012},
  url =          {http://www.unicode.org/versions/Unicode6.2.0/},
  urldate =      {2013-01-29}
}

Jos lähteellä ei jostain syystä ole lainkaan nimettyä tekijää, tulee author-kenttä jättää kokonaan pois, jolloin lähdeviitteeseen tulee tekijän tilalle otsikko (esim. O 2011):

@Book{presidential-novel,
  title =        {O},
  subtitle =     {A Presidential Novel},
  publisher =    {Simon \& Schuster},
  year =         {2011},
}

Tieteellinen lehtiartikkeli (esim. Strachey 2000) kirjoitetaan esimerkiksi seuraavanlaiseksi tietueeksi:

@Article{strachey-fundamentals,
  author =       {Christopher Strachey},
  title =        {Fundamental Concepts in Programming Languages},
  journal =      {Higher-Order and Symbolic Computation},
  year =         2000,
  volume =       13,
  number =       {1--2},
  pages =        {11--49},
  doi =          {10.1023/A:1010000313106}
}

Huomaa erityisesti kenttä doi, johon voi kirjoittaa artikkelin digitaalisen tunnisteen (Digital Object Identifier, DOI). Se on yleensä parempi valinta kuin mikään URL, koska DOI on pysyvä artikkelin tunnistetieto. Useimmat DOIt on lisäksi muutettavissa URLiksi lisäämällä sen alkuun http://dx.doi.org/.

Jos netissä olevan lähteen DOI ei ole tiedossa (tai sitä ei ole lainkaan), voi käyttää url-kenttää ja sen kaverina urldate-kenttää, jolla ilmaistaan (muodossa VVVV–KK–PP) verkossa olevan lähteen viittauspäivä. Linkki kannattaa valita huolella siten, että se on mahdollisimman tarkka ja mahdollisimman pitkään voimassa – jos sivulla on erikseen osoitettu pysyvä linkki (engl. permanent link), sitä on syytä käyttää.

Viitattaessa WWW-sivuun, joka ei ole kirja tai artikkeli tai muukaan julkaisu, voidaan käyttää online-tietuetyyppiä (esim. Debian Social Contract 2004):

@Online{debian-social-contract,
  title =        {Debian Social Contract},
  year =         {2004},
  url =          {http://www.debian.org/social_contract.en.html},
  urldate =      {2013-01-29}
}

Jotkin lähteet ovat toimitettuja kokoomateoksia, jotka koostuvat itsenäisistä artikkeleista. Yleensä tällöin viitataan johonkin sen osa-artikkeliin (esim. Prechelt) eikä koko kokoomateokseen. Tällöin sekä teos että viitatut artikkelit lisätään tietokantaan omina tietueinaan, ja kussakin artikkelitietueessa viitataan kokoomateokseen käyttäen crossref-kenttää:¹

@Collection{making-software,
  editor =       {Andy Oram and Greg Wilson},
  title =        {Making Software},
  subtitle =     {What Really Works, and Why We Believe It},
  publisher =    {O'Reilly},
  year =         2011
}
@InCollection{prechelt-credibility,
  author =       {Lutz Prechelt and Marian Petre},
  title =        {Credibility, or Why Should I Insist on Being
                  Convinced},
  crossref =     {making-software},
  pages =        {17--34}
}

Huomaa, kuinka kokoomateoksella on toimittajia (editor) eikä tekijöitä (author).

Tarkempia tietoja lähdetietokannan rakenteesta löytyy BibTeXin manuaalista (Patashnik 1988), BibLaTeXin manuaalista (luku 2 Lehman ym. 2012) sekä BibLaTeX-Chicagon manuaalista (luvut 5.1–5.2 Fussner 2012). Lisää esimerkkejä löydät myös tämän oppaan lähdekoodista.

---

1. Sallittua on myös yhdistää artikkeli ja kokoomateos yhdeksi InCollection-tietueeksi, esimerkiksi jos kokoomateoksesta viitataan vain yhteen artikkeeliin. Tällöin kokoomateoksen nimi tulee booktitle-kenttään eikä crossref-kenttää käytetä.↩︎

3.3 Lähdeluettelo

Lähdeluettelo syntyy TIMissä automaattisesti kun tiedosto tulostetaan gradu-templatella.

3.4 Tiedossa olevat ongelmat

Lähdeluettelon ja lähdeviitteiden toiminta ei ole toistaiseksi aivan virheetöntä. (???)

4. Tutkielmapohjan erityispiirteet

4.1 gradu vs. report

Pääsääntöisesti gradu3 käyttäytyy kuten LaTeXin mukana tuleva report-kirjoitelmaluokka. Eroja kuitenkin on:

• Sinun ei tarvitse ladata inputenc-, fontenc- eikä babel-pakettia.

  • Käyttämäsi merkistö sinun pitää ilmoittaa \documentclass-komennon optiona. Nykyään utf8 on yleensä sopiva valinta, joskin joissakin tilanteissa latin1 tai latin9 voi tulla myös kyseeseen.
  • Jos tutkielmasi on englanninkielinen, ilmoita se \documentclass-komennon optiolla english.

• Jos tutkielmasi on kandidaatintutkielma, käytä \documentclass-komennon optiota bachelor.

• Ilmoita tutkielmasi metatiedot dokumentin asetuksissa esitetyillä komennoilla. asetukset tulevat joko macros tai texmacros alle. Myös molempiin voi kirjoittaa asetuksen jos haluaa sen toimivat eri tavalla PDF-tulostuksessa.

Metatietojen ilmoituskomennot

Komento	Tarkoitus
textitle	Työn otsikko (älä käytä \thanks-komentoa)
textranslatedtitle	Suomenkielisen työn englanninkielinen otsikko, englanninkielisen työn suomenkielinen otsikko
texstudyline	Suuntautumisvaihtoehtosi (ei pakollinen, jos käytät bachelor-optiota)
textiivistelma	Suomenkielinen tiivistelmä
texabstract	Englanninkielinen abstrakti
texavainsanat	Suomenkieliset avainsanat
texkeywords	Englanninkieliset avainsanat
texauthor	Kirjoittajan nimi (jos useita, anna kukin omana komentonaan– \and-komentoa ei tueta)
texcontactinformation	Kirjoittajan yhteystiedot
texsupervisor	Tutkielman ohjaaja (jos useita, anna kukin omana komentonaan; ei pakollinen, jos käytät bachelor-optiota)

• Voit \maketitle-komennon jälkeen halutessasi kirjoittaa esipuheen. Sen otsikon saat komennolla \preface.
• Mahdollisen esipuheen jälkeen voit kirjoittaa termiluettelon käyttämällä thetermlist-ympäristöä. Sen sisällä voit käyttää \item[termi]-komentoa merkitsemään määriteltävän termin.
• Käytä \maketitle-komennon ja mahdollisten esipuheen ja termiluettelon jälkeen \mainmatter-komentoa. Se laatii automaattisesti tarvittavat sisällys-, kuvio- ja taulukkoluettelot.
• Komentoja \subsubsection, \paragraph ja \subparagraph ei tueta.
• Liitteet eivät ole lukuja (\chapter) vaan alilukuja (\section).
• Lähdeluettelon ja lähdeviitteiden tekemisestä kerrottiin edellisessä luvussa.

4.2 TIM-gradupohjassa huomioitavaa

4.2.1 Liiteet

Liitteiden sisällä ei saa käyttää enää päätason otsikkoa #.

Mikäli itse haluaa numeroida liitteen, on liitteen otsikkoriviin laitettava .nonumber, esim:

## Liite 1 {.nonumber}

4.2.2 Kuvien sijoittelu

Kuvat onkin oletuksena tarkoitettu painotuotteissa kelluviksi, jolloin sivu pystytään jakamaan tasapainoisemmin. TIM gradutyyliin on oletuksena laitettu että kuvat ovat inline.

Tätä voi säätää lisäämällä

texmacros: 
   texfigurepos: "H"  % kuvat saavat olla omalla kohdallaan

Tällöin on syytä olla myös:

texmacros: 
  texmacros: |!!
\raggedbottom               % sivuja ei pakoteta täyteen pituuteen
!!

Pakottaminen muuhun paikkaan

texmacros: 
   texfigurepos: "tb"  % kuvien pitää olla ylhäällä tai alhaalla

Kuvien sijaintia voi säätää myös:

texmacros: 
  texmacros: |!!
\floatplacement{figure}{H}  % kuvat eivät saa kellua
\raggedbottom               % sivuja ei pakoteta täyteen pituuteen
!!

4.2.3 Kuvien automaattinen nimeäminen

Periaatteessa LaTeX nimeää ja numeroi kuvat itse, mutta jos haluaa ne nimetä käsin ja numeroida käsin, pitää automaatti poistaa attribuutilla:

texmacros:
   texcaption: 0

Tämä kannattaa tehdä jos käyttää esim TIMin automaattinumerointia.

4.2.4 Kuvien koko

Kuvat saattavat mennä väärään kokoon jos niiden kuvainfo on väärin tai kuvat ovat muuten liian isoja. Tähän voi auttaa pakottamalla kuvat tiettyyn kokoon:

![Kuvio 1. Opuksen kissa](https://tim.jyu.fi/images/156775/opus-kissa.png){width=35em height=25em}

Tuossa pitää sitten itse katsoa alkuperäisen kuvan kuvasuhde jotta saa korkeuden oikein, muuten kuva vääristyy.

Jos käyttää kuvan kokoon vaikuttavia attribuutteja on LaTeX-pohjassa oltava (ks. määritys kuvasuhteiden säilyttämiselle

\setkeys{Gin}{width=\maxwidth,height=\maxheight,keepaspectratio}

5. Yhteenveto

Tutkielman viimeinen luku on Yhteenveto. Sen on hyvä olla lyhyt; siinä todetaan, mitä tutkielmassa esitetyn nojalla voidaan sanoa johdannon väitteen totuudesta tai tutkimuskysymyksen vastauksesta. Yhteenvedossa tuodaan myös esille tutkielman heikkoudet (erityisesti tekijät, jotka heikentävät tutkielman tulosten luotettavuutta), ellei niitä ole jo aiemmin tuotu esiin esimerkiksi Pohdinta-luvussa. Tässä luvussa voidaan myös tuoda esille, mitä tutkimusta olisi tämän tutkielman tulosten valossa syytä tehdä seuraavaksi.

Jos Yhteenveto alkaa pitkittyä, se kannattaa jakaa kahtia niin, että tulosten tulkinta otetaan omaksi Pohdinta-luvukseen, jolloin Yhteenvedosta tulee varsin lyhyt ja lakoninen.

Yhteenvedon jälkeen tulee -komennolla laadittu lähdeluettelo ja sen jälkeen mahdolliset liitteet.