Siirry sisältöön. | Siirry navigointiin

Jyväskylän yliopiston Koppa

HUOM! Kopan käyttö päättyy 31.7.2024! Lue lisää.


Navigation

Fysiikan kandidaatintutkielmien LaTeX-dokumenttiluokka

tekijä: Jussi Maunuksela — Viimeisin muutos sunnuntai 06. maaliskuuta 2016, 11.11
LaTeX-tiedostopohjat Jyväskylän yliopiston fysiikan kandidaatintutkielmien tekemistä varten.

LaTeX-tiedostopohjat

jyflluk.cls
LaTeX-dokumenttiluokka fysiikan kandidaatintutkielmia varten. Luokka käyttää UTF-8 merkistökoodausta. (viim. päivitys 10.11.2015)
LuK-malli.tex
Mallitutkielman pelkistettu versio dokumenttiluokan käytön harjoitteluun.
LuK-malli3.tex
Mallitutkielma dokumenttiluokan käyttöön.
LuK-malli3.pdf
Mallitutkielman PDF-tiedosto.
jyfl-logo.png
Mallitutkielman kansilehdellä käytetyn logon PNG-tiedosto.
tutkinnot.pdf
LuK-malli.bib
Mallitutkielman lähdeviitteet BibTeX-tietokantana.

Paketit

Tähän tullaan listaamaan dokumenttiluokassa käytössä olevat paketit:

amsmath
Matemaattisten kaavojen kirjoittamiseen tarkoitettu lisäpaketti. (Tulossa)
icomma
Älykkäät pilkut desimaalilukuihin sekä matemaattisiin kaavoihin. (Lisätty 10.11.2015)

Ohjelmia

MikTeX
Ilmainen LaTeX-ohjelmisto Microsoft Windows -käyttöjärjestelmille.
TeXnicCenter
LaTeX-käyttöön suunniteltu tekstieditori.
ShareLaTeX
Verkkosovelluksena toteutettu LaTeX-ohjelmisto, jota voi käyttää selaimen kautta.

Varsinainen tekstiosa

Tekstin kokonaisrakenteen jäsentäminen

Harjoitellaan aluksi varsinaisen tekstiosan jäsentämistä käyttäen luentokalvosarjassa esitetyn Tieteellisen työn rakenne 1:den otsikoita eli johdanto, teoreettinen tausta, menetelmät ja aineisto, tulokset ja päätäntö. Kopioi LuK-malli.tex tiedostoon rakenteiden

\begin{document}

ja

\end{document}

väliin seuraava mallikoodi:

% --------------------------------------------------------------------------
% VARSINAINEN TEKSTIOSA
% --------------------------------------------------------------------------

\section{Johdanto}
\label{sec:johdanto}

Johdannon tehtävänä on nimensä mukaisesti johdatella lukija käsillä olevan tutkimuksen maailmaan.

\section{Teoreettinen tausta}
\label{sec:teoreettinen-tausta}

Teoreettinen tausta tarkoittaa keskeisten teorioiden ja tutkimuksen esittelyä.

\section{Menetelmät ja aineisto}
\label{sec:menetelmat-ja-aineisto}

Menetelmät ja aineisto on tutkimuksen eri vaiheiden ja käytyn aineiston kuvaamista. Menetelmät osio on hyödyllinen lukijoille, jotka ovat kiinnostuneitä käyttämistäsi menetelmistä tai toistamaan suorittamasi tutkimuksen.

\section{Tulokset}
\label{sec:tulokset}

Tulokset esittelee ja kommentoi tutkimuksen tuloksia normaalisti tutkimusongelmien esittämisjärjestyksessä.

\section{Päätäntö}
\label{sec:paatanto}

Loppuluvussa arvioidaan tutkimusta ja sen tuloksia.

Huom. Sisäisissä viittauksissa käytettävä \section rakenteen nimiö (engl. label) annetaan \label{sec:nimio} rakenteella, missä lyhenne "sec:" auttaa erottamaan eri tyyppisiin rakenteisiin viittaavat nimiöt toisistaan. Esim. kaavaan, taulukoon tai kuvioon viittaavan nimiön alussa käytetään vastaavasti lyhennettä "eq:", "tab:" tai "fig:".

Huom. Kappaleen vaihto saadaan aikaan tyhjällä rivillä. Usealla peräkkäisellä tyhjällä rivillä on sama vaikutus kuin yhdellä.

Tekstin kokonaisrakenteen jäsentämisharjoituksen lopuksi käännä LuK-malli.tex tiedosto PDF-tiedostoksi ja avaa luomasi tiedosto.

Matemaattiset kaavat

LaTeXin matematiikkamoodia voidaan voi käyttää sekä tekstin seassa että erikseen ladottavissa kaavoissa. Harjoitellaan seuraavaksi matemaattisten kaavojen käyttöä osana virkerakennetta.Kopioi seuraavat mallikoodit LuK-malli.tex tiedostoon luvun Teoreettinen tausta alakohdiksi.

Numeroitu kaava tekstissä erikseen ladottuna:

\subsection{Ideaalikaasuseokset}
\label{sec:ideaalikaasuseokset}

Ideaalikaasun tilanyhtälön mukaan on komponentin $i$ osatiheys
%
\begin{equation}
\label{eq:ideaalikaasun-tilanyhtalo}
\rho_i = \frac{p_i M_i}{R T}\;,
\end{equation}
%
missä $p_i$ on komponentin $i$ osapaine ja $R$ on yleinen kaasuvakio.

Huom. Tyhjä rivi tekstin ja erikseen ladottavan kaavan välissä saa aikaan kappaleen vaihdon. Tämä estetään kommentoimalla rivi eli %-merkillä rivin alussa.

Tekstiviittaus kaavaan saadaan \ref{eq:nimio} rakenteella:

Komponentin $i$ mooliosuudelle $y_i = n_i/n$ saadaan yhtälöstä (\ref{eq:ideaalikaasun-tilanyhtalo}) Daltonin yhtälö
%
\begin{equation}
\label{eq:daltonin-yhtalo}
y_i = \frac{p_i}{p}\;.
\end{equation}

Jos kaava on osa virkettä eli esiintyy tekstissä, sen yhteydessä käytetään välimerkkiä normaalisti.Kaava voidaan kirjoitetaan erilliseksi numeroiduksi kaavaksi, johon tekstissä viitataan numerolla. Tällöin voidaan perustella, että loppuun ei kuulu välimerkkiä, kun ei ole mitään virkettäkään.

Koko seoksen tiheys ja kokonaispaine voidaan laskea vastaavasti kaavoilla~(\ref{eq:seoksen-tiheys}) ja (\ref{eq:seoksen-kokonaispaine}).

\begin{eqnarray}
\rho & = & \sum_i \rho_i \label{eq:seoksen-tiheys} \\
p & = & \sum_i p_i \label{eq:seoksen-kokonaispaine}
\end{eqnarray}

Lisätietoja: LaTeX/Mathematics - WikiBooks

Taulukot

Antti-Juhani Kaijanaho on luetellut kirjassaan LaTeX ja AMS-LaTeX - Opus asiatekstin ladonnasta (2003) yksinkertaiset nyrkkisäännöt helppolukuisten ja selkeiden taulukoiden tekemiseen:

  1. Älä käytä pystyviivoja.
  2. Älä käytä kaksoisviivoja.
  3. Kirjoita yksiköt kunkin sarakkeen otsikkoon, älä taulukoitavan materiaalin sekaan.
  4. Kirjoita aina desimaalipilkun eteen jotakin: mieluummin "0,1" kuin ",1".
  5. Älä käytä mitään "ks. yllä" -merkintää. Yleensä tyhjä paikka riittää. Kun se ei riitä, pitää toistaa.

Esim. selkeästä taulukosta, joka on ladottu tekstin sekaan table rakenteella.

\begin{table}[h]
\centering
\caption{Selkeä hinnasto}
\label{tab:esim-taulukosta}
\begin{tabular}{llr} \toprule
\multicolumn{2}{c}{Artikkeli} \\ \cmidrule{r}{1-2}
Eläin & Kuvaus & hinta (mk) \\ \midrule
Hyttynen & grammoittain & 41,50 \\
& kappaleelta & 0,05 \\
Gnu & täytetty & 360,00 \\
Emu & täytetty & 121,30 \\
Vyötiäinen & pakastettu & 38,40 \\ \bottomrule
\end{tabular}
\end{table}

Huom. Taulukon ladontaan on käytetty booktabs -pakettia.

Tähän taulukkoon voidaan viitata komennolla \ref{tab:esim-taulukosta}, esim.

Taulukko~\ref{tab:esim-taulukosta} on esimerkki selkeästä taulukosta.

Lisätietoja: LaTeX/Tables - Wikibooks

Kuviot

Kuvien ladonta tekstin joukkoon tapahtuu figure rakenteella. Esimerkkiin liittyvät kuvan voit ladata tästä.

\begin{figure}[htp]
   \centering
   \includegraphics[width=\textwidth]{tutkinnot}
   \caption{Valmistuneiden kandidaatintutkielmien jakauma tekijän opiskeluvuoden mukaan Jyväskylän yliopiston fysiikan laitoksella 2014 ($n = 42$); tutkintojen jakauma opiskeluvuoden mukaan ($n = 29$; tilanne 4.3.2015), kun tutkielma on valmistunut 2014. (Kuva: Jussi Maunuksela, 2015)}
   \label{fig:esim-kuvio}
\end{figure}

Tähän kuvioon voidaan viitata komennolla \ref{fig:esim-kuvio}, esim.

Kuvioiden ladonnassa on monta eri tapaa (kuvio~\ref{fig:esim-kuvio}).

Lisätietoja:

Tutkielman loppuosa

Lähteet (BibTeX)

Lähdeluettelo muotoilun ja BibTeX-tietokannan määrittely tulevat dokumentin loppuun ennen rakennetta \end{document} seuraavasti:

% --------------------------------------------------------------------------
% LOPPUOSA: LÄHTEET
% --------------------------------------------------------------------------
\bibliographystyle{finabbrv}   % Käytettävä viittausjärjestelmä
\bibliography{LuK-malli}           % BibTeX-tietokanta

Jos tekstiviittauksia ei ole vielä tehty niin BibTeX-tietokannassa olevat lähteet saa tulostettua ennen lähdeluettelon määrittelyä tulevalla komennolla

\nocite{*}

Lähteet (BibLaTeX)

Lähdeluettelon muotoilun ja BibTeX-tietokannan määrittely tulevat dokumentin alkuun ennen rakennetta \begin{document} seuraavasti:

%----------------------------------------------------------------------------------------
% LÄHDELUETTELON MUOTOILU
%----------------------------------------------------------------------------------------
\usepackage{csquotes}
\usepackage[backend=biber,style=numeric-comp,sorting=none,maxnames=3,minnames=1,firstinits=true]{biblatex}
\DefineBibliographyStrings{finnish}{%
    references = {Lähteet},%
    mathesis = {pro gradu~-tutkielma},%
    phdthesis = {väitöskirja}
}
\addbibresource{LuK-malli.bib}

Lähdeluettelon tulostaminen tapahtuu dokumentin loppuun ennen rakennetta \end{document} tulevalla komennolla:

% --------------------------------------------------------------------------
% LÄHTEET
% --------------------------------------------------------------------------
\printbibliography

Jos tekstiviittauksia ei ole vielä tehty niin BibTeX-tietokannassa olevat lähteet saa tulostettua ennen lähdeluettelon määrittelyä tulevalla komennolla

\nocite{*}

Liitteet

LaTeX-dokumentissa liitteet kirjoitetaan käskyn

\appendix

jälkeen käyttäen käskyä \section. Esim. lähteiden määrittelyn jälkeen tulevasta tekstistä

% --------------------------------------------------------------------------
% LIITTEET
% --------------------------------------------------------------------------
\appendix

\section{Ensimmäinen liite}
\label{sec:ensimmainen-liite}

\section{Toinen liite}
\label{sec:toinen-liite}

Tutkielman alkuosa

Sisällysluettelo

LaTeX tekee valmiin sisällysluettelon kirjoittajan jäsentelyn mukaisesti, kun dokumentin sisältöön lisätään rakenne

\tableofcontents

Lisätään LuK-malli.tex tiedostoon rakenteen \begin{document}  perään ja ennen varsinaista tekstiosaa seuraava mallikoodi:

% --------------------------------------------------------------------------
% SISÄLLYS
% --------------------------------------------------------------------------
\tableofcontents

Huom. LaTeX lisää sisällysluettelon tekstin alkuun ja päivittää luettelon sisällön automaattisesti joka kerta kääntäessäsi tiedoston, mutta tulostuva luettelo päivittyy vasta seuraavan kerran kun käännät LuK-malli.tex tiedoston.

Tiivistelmä ja abstract

LaTeX on valmiina rakenteita tiivistelmien luomista varten, mutta niiden sisältö ja muotoilu poikkeaa Fysiikan laitoksen ohjeista tiivistelmälle. Tämän vuoksi teemme omat määritelmät sekä tiivistelmä että abstract sivuille. Tiivistelmätiedoissa on

  1. Sivun otsikko eli Tiivistelmä tai Abstract
  2. Bibliografiset tiedot eli tekijä, kirjoituksen nimi, kirjoituksen tyyppi, suorituspaikka, valmistumisvuosi sekä tekstin laajuus (sivumäärä)
  3. Tiivistelmän teksti
  4. Avainsanat

Tiivistelmä ja abstract tulevat dokumentin alkuun ennen sisällysluetteloa. Määrittele ensin suomenkielisen tiivistelmän otsikko:

%----------------------------------------------------------------------------------------
% TIIVISTELMÄ
%----------------------------------------------------------------------------------------
\section*{Tiivistelmä}
\addcontentsline{toc}{section}{Tiivistelmä}

Huom. Rakenteen \section perässä oleva "*"-merkki estää otsikon numeroinnin, jolloin otsikko ei automaattisesti tule sisällysluetteloon. Jos otsikko halutaan lisätä sisällysluetteloon niin se tehdään erillisellä komennolla, mikä tapahtuu rakenteella \addcontentsline{}{}{}.

Tämän jälkeen lisäämme bibliografiset tiedot:

% Bibliografiset tiedot
Opiskelija, Olli\\
Kandidaatin tutkielman ulkoasu ja sisältö\\
LuK-tutkielma\\
Fysiikan laitos, Jyväskylän yliopisto, 2015, \pageref{LastPage}~sivua

Huom. Tutkielman sivujen lukumäärä saadaan komennolla \pageref{LastPage}.

Seuraavaksi lisäämme tiivistelmän tekstin, jota ennen tulee korkeampi tyhjä rivi komennolla \bigskip:

\bigskip

% Tiivistelmän teksti
Heti opinnäytteen nimiölehden jälkeen sijoitettava tiivistelmä on yhdelle paperille mahtuva ja tavallisesti enintään 250 sanaa sisältävä yhteenveto, joka hyvin tiiviissä muodossa informoi kirjoituksesta. On tärkeää, että tiivistelmä laaditaan huolellisesti, koska sen välityksellä tieto kirjoituksesta leviää eri tietokantojen kautta. Sen tulee olla laadittu niin, että se sellaisenaan voidaan julkaista tietokannoissa. Tiivistelmään alkuun on merkittävä opinnäytteen bibliografiset tiedot ja sen lopussa mainitaan sitä kuvaavat avainsanat. Tiivistelmiä on kahta tyyppiä. Informatiivinen tiivistelmä on tärkein. Se kertoo, mitä ja miten on tutkittu ja mitkä ovat tulokset. Indikatiivinen tiivistelmä osoittaa, mitä kirjoituksessa on käsitelty. Se on sisällöltään yleisempi kuin informatiivinen tiivistelmä, eikä se kerro tuloksista. Tiivistelmän loppuun liitetään aihetta kuvaavat 3--5 avainsanaa helpottamaan tietokantajärjestelmien työtä. Avainsanat voidaan antaa vapaasti asiasisällön mukaan tai poimia termit alan kontrolloiduista sanastoista kuten Yleisestä suomalaisesta asiasanastosta YSA. Opinnäytteen tunnistamiseksi tarvittavat bibliografiset tiedot annetaan tiivistelmän alussa. Tarvittavat tiedot ovat kirjoittajan suku- ja etunimi, opinnäytteen otsikko, opinnäytteen tyyppi, ainelaitoksen nimi, yliopiston nimi, valmistumisvuosi ja työn sivujen lukumäärä (ilman liitesivuja).

Lopuksi tiivistelmän tekstin perään lisäämme tutkielmaan kuvaavat avainsanat:

\bigskip

% Avainsanat
Avainsanat: Opinnäyte, tiivistelmä, kirjoittaminen, ohjeet

Englanninkielinen tiivistelmä eli abstract tehdään vastaavalla tavoin suomenkielisen tiivistelmän perään:

%----------------------------------------------------------------------------------------
%    ABSTRACT
%----------------------------------------------------------------------------------------
\section*{Abstract}
\addcontentsline{toc}{section}{Abstract}

% Bibliographic information
Opiskelija, Olli\\
Outlook and content of Bachelor's Thesis \\
Bachelor’s thesis \\
Department of Physics, University of Jyväskylä, 2015, \pageref{LastPage}~pages.

\bigskip

% Abstract text
\begin{otherlanguage}{english}
This should be written in English.
\end{otherlanguage}

\bigskip

% Keywords
Keywords: Thesis, abstract, writing, instructions

Huom. LuK-tutkielman oletuskielenä on suomi, minkä vuoksi pidemmille englanniksi kirjoitetuille tekstinpätkille tulee määritellä erikseen käytetty kieli rakenteella \begin{otherlanguage}{language} ... \end{otherlanguage}.

Esipuhe (valinnainen)

Esipuhetta käytetään yleisemmin lisensiaatintöissä ja väitöskirjoissa. Tyypillisessä esipuheessa tekijä useimmin kiittää yhteistyötahojaan ja erilaisia tukijoukkoja eli kaikkia niitä, jotka ovat olleet mukana prosessin kuluessa. Lisäksi esipuheessa voidaan määritellä tutkimus, korostaa sen tiettyjä näkökulmia, verrata sitä muihin tutkimuksiin sekä esittää tutkimuksen syntyyn johtaneita seikkoja.

Abstractin ja sisällysluettelon väliin tulevan esipuheen määrittely näyttää tältä:

% --------------------------------------------------------------------------
% ESIPUHE
% --------------------------------------------------------------------------
\section*{Esipuhe}
\addcontentsline{toc}{section}{Esipuhe}

% Esipuheen teksti
Esipuheen teksti tulee tähän.

\bigskip

% Esipuheen päiväys
Jyväskylässä 4. maaliskuuta 2015

\bigskip

% Tekijä
Olli Opiskelija

Nimiölehti

Nimiölehden eli kansilehden kohdalla on sama tilanne kuin tiivistelmän kohdalla eli, että LaTeXilla on valmiit rakenteet kansilehteä varten, mutta ne eivät ole ohjeiden mukaisia. Tämän vuoksi teemme kansilehdelle omat määrittelymme, jotta nimön tulisivat seuraavat asiat:

  1. Tutkielman nimi
  2. Tutkielman tekijä
  3. Tutkielman tyyppi
  4. Työn valmistumisajankohta
  5. Suorittamispaikka
  6. Työn ohjaaja(t)

Kansilehden määrittely ja teksti tulevat ennen rakennetta \begin{document} ja niiden tekemiseen käytetään seuraavaa mallikoodia:

%----------------------------------------------------------------------------------------
% KANSILEHDEN MUOTOILU JA TEKSTI
%----------------------------------------------------------------------------------------
\newcommand*{\titleJYFL}{\begingroup  % Create the command for including the title page in the document
\hbox{                                    % Horizontal box
\hspace*{0.1\textwidth}                   % Whitespace to the left of the title page
\rule{1pt}{\textheight}                   % Vertical line
\hspace*{0.05\textwidth}                  % Whitespace between the vertical line and title page text
\parbox[b]{0.8\textwidth}{                % Paragraph box which restricts text to less than the width of the page

% Tutkielman nimi
{\noindent\LARGE\bfseries Kandidaatin tutkielman\\[0.5\baselineskip] ulkoasu ja sisältö}\\[2\baselineskip]
%
% Tutkielman tyyppi ja päiväys
{\large LuK-tutkielma, \today}\\[3.5\baselineskip]
%
% Tutkielman tekijä
{\normalsize Tekijä:}\\[0.5\baselineskip]
{\large \textsc{Olli Opiskelija}}\\[1\baselineskip]
%
% Työn ohjaajat
{\normalsize Ohjaaja:}\\[0.5\baselineskip]
{\large \textsc{Matti Meikäläinen}}
%
% Tyhjä väli ohjaajan nimen ja yliopiston logon välille - älä poista seuraavaa tyhjää riviä!

\vspace{0.2\textheight}
% Yliopiston logo, nimi ja ainelaitos
\includegraphics[height=27mm]{jyfl-logo.png}
}
}        
\endgroup}

Kansilehden tekeminen tapahtuu rakenteen \begin{doument} perään tulevalla komennolla

%----------------------------------------------------------------------------------------
% KANSILEHTI
%----------------------------------------------------------------------------------------
\titleJYFL

Kirjallisuus

  1. T. Oetiker ym. The Not So Short Introduction to LaTeX2e - Or LaTeX2e in 157 minutes. Version 5.04, 29.1.2014. Saatavilla: http://www.ctan.org/tex-archive/info/lshort/english/. Haettu 5.3.2015.
  2. K. Reckdahl. Using Imported Graphics in LaTeX and pdfLaTeX. Version 3.0.1, 12.1.2006. Saatavilla: ftp://ctan.tug.org/tex-archive/info/epslatex.pdf. Haettu 5.3.2015.
  3. LaTeX WikiBook. Saatavilla: http://en.wikibooks.org/wiki/LaTeX. Viitattu 5.3.2015.
  4. A.-J. Kaijanaho. LaTeX ja AMS-LaTeX: opus asiatekstin ladonnasta. 2. korj. painos. Jyväskylä: Jyväskylän yliopisto, 2003. Saatavilla: Jyväskylän yliopiston verkkokauppa, https://kirjasto.jyu.fi/kauppa/tuotteet/latex-ja-ams-latex. Haettu 5.3.2015.
  5. L. Lamport. LaTeX: a document preparation system. Reading (MA) : Addison-Wesley, 1994. Saatavuus: JYKDOK, https://jyu.finna.fi/Record/jykdok.480437. Haettu 6.3.2015.