Tutkimussuunnitelma ja kandidaatintutkielma (pdf)LaTeXilla

Kurssi Korpissa:

TIEA301 Kandidaattiseminaari

Päivitetty versio tästä ohjeistuksesta on saatavilla tehtävien muodossa osoitteessa https://tim.jyu.fi/view/users/samonkol/tiea301-tutkimussuunnitelma

(pdf)LaTeX-demo/ohjaus

Tee Windowsissa näkyvälle U-levylle hakemisto, jossa testaat tutkimussuunnitelma- ja tutkielmapohjia. U-levyn sisällön pitäisi näkyä myös suorakäyttökoneilla (charra.it.jyu.fi, halava.cc.jyu.fi, jalava.cc.jyu.fi) kotihakemistossasi. Tarvittaessa tiedostojen siirtäminen suorakäyttökoneiden ja paikallisen koneen välillä onnistuu esim. WinSCP-ohjelma avulla.

Tutkimussuunnitelma- ja tutkielmapohjat

Kopioi hakemistoosi seuraavat tiedostot:

• suunnitelma-report-manualbib.tex (käyttää LaTeXin perusdokumenttiluokkaa report) on perusversio tutkimussuunnitelman kirjoittamiseen.
• kanditutkielma-gradu3-manualbib.tex (käyttää gradu3.cls-dokumenttiluokkaa), joka on pohja kandidaatintutkielmaa varten
• tietotekniikan laitoksen gradu3.cls-dokumenttiluokka

Tuorein versio gradu3.cls-paketista esimerkkeineen ja manuaaleineen on ladattavissa Yousourcesta. Ohjeita paketin purkamiseen.

Suunnitelmasta tutkielmaksi

• Tutkimussuunnitelman omasta aiheestaan kirjoittaneet kopioivat suunnitelmastan tutkielmapohjaan.
• Jos olet käyttänyt tutkimussuunnitelmatekstissäsi \citep- ja \citet-viittauksia, niin tutkielmapohjassa pitää olla \usepackage{natbib} ennen \begin{document}-komentoa.
• Jos kirjoitat lähdeluettelon käsin, voit katsoa ohjeita Timo Männikön tekemästä mallitiedostosta Lähdeviittaukset author-date-järjestelmässä
• Jos luot lähdeluettelon automaattisesti biberillä, niin katso ohjeet alempaa tältä sivulta (lähdekoodit näet tiedostoista suunnitelma-report-biber.tex ja kanditutkielma-gradu3-biber.tex).

PdfLaTeX

Tutustutaan aluksi tiedoston suunnitelma-report-manualbib.tex avulla tex-dokumentin perusrakenteeseen ja kääntämiseen pdf:ksi.

Huom.! Jos ä- ja ö-kirjaimet eivät näytä toivotunlaisilta, niin ongelma korjaantunee vaihtamalla tex-tiedostossa latin1:n paikalle utf8 (tai päinvastoin).

Unix/Linux-käyttöjärjestelmässä (esim. suorakäyttökoneet charra.it.jyu.fi, halava.cc.jyu.fi, jalava.cc.jyu.fi) komentorivillä

• lähdekoodia työstetään jollain tekstieditorilla (esim. emacs)

emacs suunnitelma-report-manualbib.tex

• käännetään pdf-muotoon pdfLaTeXilla

pdflatex suunnitelma-report-manualbib.tex

• valmiin pdf:n (pitäisi näyttää tältä) katselemiseen soveltuvat esim. acroread tai xpdf (ainakin acroread asennettuna charrassa; ei toimi merkkipohjaisen pääteyhteyden kautta, vaan tarvitsee graafisen käyttöliittymän)

xpdf TIEA217-suunnitelma-report-manualbib.pdf

acroread TIEA217-suunnitelma-report-manualbib.pdf

Windows-käyttöjärjestelmässä MiKTeX-ohjelmalla

• lähdekoodia työstetään jollain tekstieditorilla (esim. TeXworks)
• käännetään pdf-muotoon pdfLaTeXilla (TeXworksin "play"-nappulan komento Typeset (Ctrl+T))
• valmiin pdf:n katselemiseen soveltuu esim. Adobe Reader (pdf:n valmistuttua dokumentti aukeaa automaattisesti TeXworksin esikatseluikkunaan).

Pilvipalveluita hyödyntäen, esim.

• ShareLaTeX (ja GitHub)
• VerbTeX (mobiililaitteille)
• Huom.! Pilvipalvelut soveltuvat toistaiseksi lähinnä LaTeXin perusdokumenttiluokkia hyödyntävien dokumenttien luomiseen.

Kun kääntäminen pdf:ksi onnistuu, voidaan jatkaa tex-dokumentin rakenteeseen perehtymistä tiedoston kanditutkielma-gradu3-manualbib.tex avulla (avaa ko. tiedosto ja käännä se pdf:ksi).

Sisäiset viittaukset

Etsi tiedostosta kanditutkielma-gradu3-manualbib.tex (emacsissa haku tapahtuu komennolla Ctrl+s) kohdat, joissa käytetään seuraavia sisäisiä viittauksia:

• Makroilla \label ja \ref voi toteuttaa sisäisiä viittauksia lukuihin, kuviin, taulukoihin, ym.
• Matemaattisten kaavojen yhteydessä käytetään yleensä makron \ref sijasta makroa \eqref, jolloin numero tulee sulkujen sisään. Silloin käytetään myös amsmath-pakettia, joka otetaan käyttöön lisäämällä tiedoston alkupuolelle komento \usepackage{amsmath}.

Sisäisten viittausten päivittämiseksi dokumentti pitää kääntää pdf-muotoon kahdesti.

• Ensimmäisellä PdfLaTeX-käännöksellä muodostuu mm. sisäisiin viittauksiin liittyviä (esim. aux-, log- ja toc-päätteisiä) aputiedostoja.
• Ensimmäisen PdfLaTeX-käännöksen jälkeen tekstissä on vielä kysymysmerkkejä mm. kokonaissivumäärän, kaavaan ja lukuun viittauksen sekä lähdeviitteiden kohdalla.
• Sisällysluettelo muodostuu vasta toisella kääntämiskerralla.
• Pdf-tiedoston eroja ensimmäisen ja toisen kääntämiskerran jälkeen voi tarkatella poistamalla aux-, log- ja toc-päätteiset aputiedostot ja kääntämällä tiedoston uudelleen.

Koska mallidokumentissa on viittauksia kuviin ja taulukoihin, joita ei dokumentissa ole, kääntäjä antaa varoituksia vielä toisenkin PdfLaTeX-käännöksen jälkeen.

• Pdf-dokumentissa kuvan ja taulukon numeron paikalla tekstissä on vielä kaksi kysymysmerkkiä.

Seuraavaksi opetellaan lisäämään kuvia ja taulukoita.

Kuvat

Kopioi hakemistoosi Unixin gnuplot-ohjelmalla piirretty kuva kuvaajat.pdf.

• Liitä kuva tutkielmadokumenttiin lisäämällä tutkielma.tex-tiedostoon, kolmannen luvun alkuun,

  \begin{figure}[t] % kuvan sijoittaminen: h=here, t=top, b=bottom, p=page
  \centering        % voi käyttää myös yhdistelmiä, esim. htp
  \includegraphics[width=10cm]{kuvaajat.pdf} % kuvatiedoston nimi on kuvaajat.pdf
  \caption{Kuvateksti.} \label{kuvaviite}
  \end{figure}
  

• Kuvien liittämiseksi tiedoston alussa on oltava komento \usepackage{graphicx}, jolla graphicx-laajennuspaketti otetaan käyttöön.
• Kuvaan voi nyt viitata tekstissä \ref{kuvaviite}-komennolla.

Lisää dokumenttiisi myös (Unixin Xfig-ohjelmalla piirretty) kuva alueet.pdf ja hieman tekstiä, johon sisältyy viittaus kyseiseen kuvaan.

PdfLaTeXia käytettäessä dokumenttiin sisällytettävät kuvatiedostot voivat olla pdf-, png- tai jpg-muodossa. Ps- tai eps-formaatissa olevan kuvan voi muuttaa pdf-muotoon esim. Unixissa komentorivillä toimivilla ohjelmilla ps2pdf, epstopdf tai convert. Kuvaformaattien muunnoksia voi tehdä myös kuvankäsittelyohjelmilla (esim. GIMP).

Monimutkaisempia esimerkkejä löytyy esim. LaTeX Wikibookin kohdasta Importing Graphics.

Taulukot

Lisää kolmannen luvun alkuun myös taulukko kopioimalla siihen alla oleva koodin pätkä

\begin{table}[htp]
\centering
\caption{Taulukkoseloste.} \label{taulukkoviite}
\bigskip
\begin{tabular}{ccc} % sarakkeen tasaus: c=center, l=left, r=right
\hline
1 & 2 & 3 \\
\hline
yksi & kaksi & kolme \\
ett & två & tre \\
one & two & three \\
\hline
\end{tabular}
\end{table}

Yksinkertaisia taulukoita voi luoda myös osoitteessa http://www.tablesgenerator.com/latex_tables olevalla työkalulla. Monimutkaisempia esimerkkejä löytyy esim. LaTeX Wikibookin kohdasta Tables

Luetelmat

• Numeroimaton luetelma toteutetaan itemize-ympäristöllä. Kokeile esim. liittämällä tutkielmapohjaan seuraava tekstinpätkä:

  Simulointimallien pohjalta voidaan tehdä tietokoneohjelmia, joiden avulla esim.
  \begin{itemize}
  \item ennustetaan säätilaa
  \item luodaan tietokonepelejä ja elokuvatehosteita
  \item ohjataan teollisuusprosesseja
  \item tutkitaan maanjäristysaaltojen etenemistä
  \item kehitetään äänentoistolaitteita ja meluvalleja.
  \end{itemize}
  

• Vaihda itemize-ympäristön tilalle enumerate-ympäristö, niin saat numeroidun luetelman.
• Määrittelyjä voidaan toteuttaa description-ympäristössä. Kokeile esim. seuraavasti:

  \begin{description}
  \item[PDF] Portable Document Format
  \end{description}
  

Matemaattiset kaavat

• Tutkielmapohjassa on tekstin seassa esiintyvä kaava dollarimerkkien sisällä ja omalla rivillään esitetty (numeroitu) kaava equation-ympäristössä.
• Monirivisissä kaavoissa kannattaa käyttää align-ympäristöä. Testaa sitä liittämällä tutkielmapohjaan

  \begin{align}
  \label{aaltoyhtalo}
  -\frac{\omega^2}{c^2}p-\nabla^2 p & = f_1 && \textrm{ alueessa }\Omega,\\
  \label{reunaehto}
  p & =0 && \textrm{ reunalla } \Gamma_0.
  \end{align}
  

• Jos kaavaa ei halua numeroida, voi käyttää align*- tai equation*-ympäristöä. Kokeile esim. liittämällä tutkielmapohjaan

  \begin{align*}
  \int_{\Gamma} \frac{\partial p}{\partial \vec{n}} q \, ds
  \end{align*}
  

• Pitkänpuoleinen johdanto LaTeX2e:n käyttöön antaa hyviä esimerkkejä erilaisten kaavojen ladonnasta. Siihen kannattaa tutustua erityisesti, jos opinnäytetyössä on matemaatttista sisältöä.
• Symboleja voi etsiä esim. Detexifyn avulla tai The Comprehensive LaTeX Symbol List -oppaasta.

Lähdeviitteet

Lähdeluettelo toteutetaan dokumentin loppuun (ennen \end{document}-komentoa) thebibliography-ympäristössä (ks. esimerkki tiedoston tutkielma.tex lopusta).

• Jokainen viite aloitetaan \bibitem{}-komennolla, jonka argumenttina on kyseisen teoksen viiteavain

  \begin{thebibliography}{}
  
  \bibitem[Kirjoittaja(vuosiluku)]{viiteavain}
  Sukunimi, Etunimi vuosi. \textit{Teoksen/artikkelin otsikko}. 
  Lehden nimi, vuosikerta, numero, sivunumerot. 
  Mahdollinen lisätieto. Paikkakunta: Kustantaja.
  
  \end{thebibliography}
  

• Lähdeluettelossa oleviin teoksiin viitataan tekstissä komennolla \cite{viiteavain}

Huom.! Eri tieteenaloilla on erilaisia tapoja ja vakiintuneita järjestyksiä lähdeviitteissä esitettyjen tietojen esittämiseen. Myös viittamiskäytänteet (nimellä, numerolla) vaihtelevat samankin tieteenalan sisällä. Siksi on tarpeen automatisoida lähdeluettelon luominen niin, että lähdeluettelon tyylin muuttaminen on helppoa.

Biber

• Kokeillaan lähdeluettelon tekoa automaattisemmin BibTeX-formaatissa olevan lähdetietokannan LaTeXin ymmärtämään muotoon kääntävällä biber-ohjelmalla .
• Huom.! MikTex for Windows 64-bit ei sisällä Biberiä. MikTex 2.9 (tai uudemmassa) 32-bittisessä versiossa Biber on mukana. Tarvittaessa Biberin voi päivittää uusimpaan versioon.
• Lähdeluettelo tehdään tietotekniikan laitoksella syksyllä 2012 käyttöön otetun opinnäyteluokan mukaisesti chicago-tyylillä. Jos tyylitiedosto puuttuu, saat virheilmoituksen File biblatex-chicago.sty not found.
• Kotikoneelle tyylipaketin saa osoitteesta http://www.ctan.org/pkg/biblatex-chicago.
• Jos biblatex-chicago-tyyliä ei saa käyttöön Agoran mikroluokassa olevalta koneelta, voi ottaa yhteyttä IT-palveluihin/Agoran lähitukeen.
• Kopioi hakemistoosi tiedosto suunnitelma-report-biber.tex tai tee se seuraavasti:
• Kopioi tiedosto suunnitelma-report-manualbib.tex hakemistoosi nimellä suunnitelma-report-biber.tex ja toimi seuraavasti:
• Poista thebibliography-ympäristö kokonaan tai laita se kommentteihin lisäämällä jokaisen rivin alkuu %-merkki.
• Määrää thebibliography-ympäristön sijasta (ennen komentoa \end{document}) lähdeluettelon paikka komennolla

  \printbibliography
  

• Korvaa ennen \begin{document}-komentoa oleva tyylimäärittely \usepackage{natbib} määrittämällä tyyliksi biblatex-chicago ja antamalla bib-päätteinen lähdetietokannan tiedostonimi seuraavasti:

  \usepackage[authordate,backend=biber,noibid]{biblatex-chicago} %tyyli
  \addbibresource{esimerkki.bib} % Lähdetietokannan tiedostonimi
  

• Kopioi hakemistoosi tiedosto esimerkki.bib, jossa lähteet on lueteltu tietyssä formaatissa.
• Käännä; komentorivillä tämä tapahtuu komennoilla

  pdflatex suunnitelma-report-biber
  biber suunnitelma-report-biber
  pdflatex suunnitelma-report-biber
  pdflatex suunnitelma-report-biber
  

• Kopioi hakemistoosi tiedosto kanditutkielma-gradu3-biber.tex tai tee vastaavan sisältöinen tutkielma.tex seuraavasti:
• Kopioi tiedosto kanditutkielma-gradu3-manualbib.tex hakemistoosi nimellä tutkielma.tex
• Poista \documentclass-riviltä optio manualbib.
• Oletustyyliksi on tiedostossa gradu3.cls määritelty biblatex-chicago. Korvaa ennen \begin{document}-komentoa oleva tyylimäärittely \usepackage{natbib} määrittämällä antamalla bib-päätteinen lähdetietokannan tiedostonimi seuraavasti:

  \addbibresource{esimerkki.bib} % Lähdetietokannan tiedostonimi
  

• Määrää thebibliography-ympäristön sijasta (ennen komentoa \end{document}) lähdeluettelon paikka komennolla

  \printbibliography
  

• Kopioi hakemistoosi tiedosto esimerkki.bib (ellei se jo hakemistossasi ole).
• Käännä (pdflatex, biber, pdflatex, pdflatex).
• Komento biber tutkielma tekee blg- ja bbl-päätteiset aputiedostot. Näistä tutkielma.bbl sisältää thebibliography-ympäristössä ne lähteet, joihin tutkielma.tex-tiedostossa on viitattu. Seuraava PdfLaTeX-käännös lisää lähteet pdf-dokumentin loppuun ja viimeinen PdfLaTeX-käännös päivittää sisäiset viittaukset.

• Eri tyylit tuottavat erilaisen lähdeluettelon. Bib-tiedoston, annetun tyylin ja Biberin avulla tehtyä opinnäytetyön lähdeluettelon tyyliä ei ole tarkoitus editoida käsin. Muotoilut ovat automaattisesti oikeita ja pilkut ja pisteet ovat juuri niissä kohdissa, joissa niiden kuuluukin kyseistä tyyliä käytettäessä olla.

Viitteidenhallintaa

• Emacsilla bib-tiedostoa editoidessa voi hyödyntää valikkoa, josta saa käyttöön valmiit pohjat eri tyyppisille lähdeviittauksille.
• Kirjastojen, tieteellisten julkaisusarjojen kustantajien ym. tietokannoista julkaisujen tiedot saa usein BibTeX-datana ("Download Citation", "Export Citation" tai "Export Formats"). Kokeile hakemalla osoitteessa http://dx.doi.org/10.1016/j.medengphy.2007.12.008 olevan julkaisun BibTeX-tiedot (sivun yläreunassa Export, formaatiksi valitaan BibTeX format).
• Viitteiden hallintaan on olemassa ohjelmia, joista viitteet saa BibTeX-tiedostoksi (esim. RefWorks ja JabRef). Viitteidenhallintaohjelman käyttö voi olla aiheellista, jos käytössä on useita kymmeniä tai satoja viitteitä. BibTeX-datan lisäksi viitetietoja on mahdollista ladata esim. suoraan RefWorksiin.
• Aiemmin Biberin sijasta on käytetty BibTeXia lähdeluettelon laatimiseen. Lisätietoja BibTeXin käyttöön liittyen on mm. osoitteessa https://trac.cc.jyu.fi/projects/it/wiki/BibTeX. Tämä käytäntö on vielä voimassa useissa kansainvälisissä julkaisusarjoissa.

Tex-tiedostoon tehdyt muutokset

• Kahden tex-tiedoston erot näyttävän tex-tiedoston saa tehtyä Latexdiffillä, jota voi käyttää myös online-versiona osoitteessa http://3142.nl/latex-diff/.
• Kun palautat seminaarin vaiheissa TP3: Sisältö ja TP4: Viimeistely opinnäytetyöversiosi lisäksi kahden viimeisimmän version välisen diff-tiedoston (pdf:ksi käännettynä) Optimaan, niin saat ohjaajalta kommentit nopeammin.
• Erityisesti kuvissa ja ristiviittauksissa tehdyt muutokset saattavat aiheuttaa Latexdiffillä tehdyn tiedoston pdf:ksi kääntämisen aikana virheitä.
• Komentorivillä kääntäessä voi yrittää pakottaa käännöstä tapahtumaan virheistä huolimatta r-kirjainta painamalla.
• Jos et saa käännettyä pdf:ksi Latexdiffillä tekemääsi tiedostoa, niin voit palauttaa Latexdiffillä tekemäsi tex-tiedoston.

Esitysgrafiikka

Jos tutkimussuunnitelma ja tutkielma on tehty texittelemällä, siitä saa näppärästi kopioitua pääkohdat seminaariesitelmää varten laatittavaan esitykseen.

• Kopioi beamer-dokumenttiluokkaa hyödyntävä mallitiedosto http://users.jyu.fi/~samonkol/opetus/pdflatex/beamer-esimerkki.tex ja käännä se pdf:ksi. Lisätietoja beamer-dokumenttiluokasta: Beamer User Guide.
• Jos aihe ei sisällä matemaattisia kaavoja, saattaa Microsoft PowerPoint tai OpenOffice Impress olla hyvä vaihtoehto esitysgrafiikan työstämiseen.

Tekstinkäsittelymäisempää texittelyä

• LyX

Muunnokset mm. tekstinkäsittelyohjelmien ja tex-tiedostojen välillä (eivät useimmiten toimi ihan toivotusti)

• Rtf- ja tex-tiedostojen välillä muuntaminen esim. ohjelmilla rtf2latex2e ja tex2rtf/latex2rtf.
• LibreOfficella avatun tiedoston voi muuntaa tex-tiedostoksi Writer2LaTeXilla.
• Wordilla tehtyjä dokumentteja voi muuntaa tex-tiedostoiksi docx2tex-ohjelmalla.
• Internetissä toimiva PDF to Word -muunnin.
• Wordilla tehdyn dokumentin siirtäminen LyXiin: Importing Word Documents Into LyX.
• Muunnos voidaan tehdä myös html-version kautta esim. htlatexilla.
• Pandoc on useiden eri formaattien välillä toimiva muunnin.
• Lisää vinkkejä löytyy sivulta Converters between LaTeX and PC Textprocessors.