Tekstin rakenne, ristiviitteet ja lähdeviitteet¶

LaTeX soveltuu hyvin isojen ja mutkikkaiden teknisten dokumenttien luontiin. Keskeinen väline tällaisissa teksteissä on mahdollisuus viitata tekstin osasta toiseen.

Väliotsikot¶

Tuodaan ensin hiukan tekstiin rakennetta. Komennolla \section voi tuottaa luvun ja vastaavasti esimerkiksi \subsection tuottaa aliluvun:

\documentclass[a4paper,12pt]{article}
\usepackage[finnish]{babel}
\usepackage[T1]{fontenc}
\usepackage{microtype}

\begin{document}

\section{Johdanto}

Tässä esitellään pian hyödyllinen tulos, kunhan opimme tarvittavat LaTeX-komennot.

\section{Sovellus}

Tässä taas esittelemme sen sovelluksia.

\end{document}

Käännettynä lopputulos näyttää tältä:

$../_images/latex-12.png$

Teoreemat¶

Matemaattisessa tekstissä tarvitaan usein teoreemoja, korollaareja, lemmoja ja sen kaltaisia otuksia. Niitä voi tuottaa esimerkiksi amsthm-paketin avulla (ks. dokumentaatio). Tässä \newtheorem-komennolla kerromme, että theorem-ympäristö luo teoreemoja ja corollary-ympäristö luo korollaareja. Valinta [section] kertoo, että nämä numeroidaan lukukohtaisesti (siis esimerkiksi luvussa 7 on teoreemat 7.1, 7.2 jne.):

\documentclass[a4paper,12pt]{article}
\usepackage[finnish]{babel}
\usepackage[T1]{fontenc}
\usepackage{microtype}
\usepackage{amsthm}
\newtheorem{theorem}{Teoreema}[section]
\newtheorem{corollary}{Korollaari}[section]

\begin{document}

\section{Johdanto}

Seuraava tulos on hyödyllinen:

\begin{theorem}
    Kaikki järjestyy.
\end{theorem}
\begin{proof}
    Jätetään harjoitustehtäväksi.
\end{proof}

\section{Sovellus}

Edellä esitellyllä teoreemalla on muun muassa seuraava sovellus:

\begin{corollary}
    Sä pärjäät kyllä.
\end{corollary}

\end{document}

Käännettynä lopputulos näyttää tältä (huomaa, että proof-ympäristön yhteydessä sana "Todistus" tuli suomeksi automaattisesti, kiitos babel-paketin yhteydessä astetun kielen):

$../_images/latex-13.png$

Ristiviitteet¶

Nyt tekstissä on jo sen verran rakennetta, että haluaisimme pystyä viittaamaan tekstin eri osiin. Haluttu tulos näyttäisi siis tältä:

$../_images/latex-14.png$

Juuri tähän on LaTeXissa valmiit toiminnot. Voit antaa \label-komennolla haluamillesi elementeille (esimerkiksi luvut ja teoreemat) nimiä, ja voit \ref-komennolla viitata niihin, yksinkertaisesti tähän tapaan (~ tässä lähdekoodissa tuottaa sitovan välilyönnin, jotta rivinvaihto ei tule hassuun paikkaan):

\documentclass[a4paper,12pt]{article}
\usepackage[finnish]{babel}
\usepackage[T1]{fontenc}
\usepackage{microtype}
\usepackage{amsthm}
\newtheorem{theorem}{Teoreema}[section]
\newtheorem{corollary}{Korollaari}[section]

\begin{document}

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

Seuraava tulos on hyödyllinen:

\begin{theorem}\label{thm:kaikki-jarjestyy}
    Kaikki järjestyy.
\end{theorem}
\begin{proof}
    Jätetään harjoitustehtäväksi.
\end{proof}

Luvussa~\ref{sec:sovellus} nähdään, miten tätä voi hyödyntää.

\section{Sovellus}\label{sec:sovellus}

Luvussa~\ref{sec:johdanto} esitellyllä teoreemalla~\ref{thm:kaikki-jarjestyy} on muun muassa seuraava sovellus:

\begin{corollary}
    Sä pärjäät kyllä.
\end{corollary}

\end{document}

Kirjoita tämä lähdekoodi tiedostoon lapio.tex ja yritä kääntää se tuttuun tapaan komennolla pdflatex -interaction=nonstopmode lapio.tex. Katso tuloksena syntyvää PDF-tiedostoa! Lue myös huolella, mitä LaTeX tulostaa ruudulle!

Kahdesti käännettävä¶

Jos seurasit ohjeita täsmällisesti, edessäsi pitäisi olla PDF-tiedosto, joka — surullista kyllä — näyttääkin tältä:

$../_images/latex-15.png$

Kaikki ristiviitteet näyttävät olevan rikki ja niiden paikalla näkyy vain ??. LaTeX myös tulosti käännöksen aikana tämän tyylisiä ilmoituksia:

LaTeX Warning: Reference `sec:sovellus' on page 1 undefined on input line 22.

LaTeX Warning: Reference `sec:johdanto' on page 1 undefined on input line 26.

LaTeX Warning: Reference `thm:kaikki-jarjestyy' on page 1 undefined on input li
ne 26.

LaTeX Warning: There were undefined references.

LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.

Mikä siis meni pieleen?

Yritä nyt ajaa komento pdflatex -interaction=nonstopmode lapio.tex uudestaan! Kyllä, aja täsmälleen sama komento uudestaan. Älä tee välissä mitään muuta, älä poista mitään tiedostoja levyltä äläkä muokkaa mitään tiedostoja. Toisella ajokerralla LaTeX onkin tyytyväinen, mitään varoituksia ei tulostu ja lopputuloksena on täysin ehjä PDF-tiedosto, jossa kaikki ristiviitteet ovat kunnossa!

Tämä on, valitettavasti, jälleen yksi LaTeXin omituisuuksista. Huomasimme jo aiemmin, että LaTeX luo levylle tiedoston lapio.aux. Tämä on tiedosto, jota LaTeX käyttää juuri ristiviitteiden hallintaan. Ensimmäisellä ajokerralla tämä tiedosto syntyi, ja LaTeX kirjasi sinne ylös, että esimerkiksi thm:kaikki-jarjestyy on nimenomaan teoreema numero 1.1. Toisella ajokerralla tämä tieto oli LaTeXilla käytettävissä, ja LaTeX sai ristiviitteet luotua oikein.

LaTeXia tulisi siis periaatteessa käyttää niin, että pdflatex-komennon ajamisen jälkeen huolella luetaan logista, sanoiko LaTeX jotain sen kaltaista kuin "Rerun to get cross-references right", ja tässä tapauksessa komento ajettaisiin uudestaan. Tämä on kovin työlästä ja virhealtista. Palaamme pian mahdollisiin ratkaisuihin!

LaTeX-käännös käytännössä¶

Käytännössä LaTeXin ja BibTeXin käyttäjät turvautuvat johonkin näistä ratkaisuista:

Kirjoitetaan oma skripti, joka ajaa oikean pdflatex + bibtex + pdflatex + pdflatex -rimpsun joka kerta, vaikka se ei aina olisi välttämätöntä.
Käytetään latexmk-komentoa (joka sinulla luultavasti on jo tullut TeXliven mukana). Kokeile! Aloita tyhjästä hakemistosta, jossa on pelkästään edellä luodut tiedostot lapio.tex ja kirjallisuus.bib. Aja komento latexmk -pdf lapio.tex. Tämän pitäisi huolehtia siitä, että lopputuloksena on valmis PDF, jossa kaikki on kunnossa. Kun editoid lähdetiedostoja, voit aina ajaa uudestaan latexmk -pdf lapio.tex, ja latexmk yrittää sinun puolestasi päätellä, mikä on oikea sekvenssi pdflatex- ja bibtex-komentoja.
Käytetään sopivaa kehitysympäristöä, esim. VS Code -kehitysympäristö ja LaTeX Workshop -laajennus, jotka huolehtivat LaTeX-käännöksestä taustalla ja tarjoavat myös mahdollisuuden esikatsella valmista PDF-dokumenttia näppärästi Overleafin tapaan.
Käytetään Overleafia, joka huolehtii kaikesta tästä käyttäjän puolesta. Kokeile! Voit lisätä Overleaf-projektiisi myös BibTeX-tiedostoja.

Joka tapauksessa on etenkin ongelmatilanteiden selvittämiseksi erittäin hyödyllistä ymmärtää myös hiukan siitä, mitä pellin alla tapahtuu, vaikka käyttäisikin erilaisia LaTeX-kääntämistä helpottavia aputoimintoja.