Artikkelin kirjoittaminen

Artikkelidokumentissa tarvitaan usein dokumentin sisäisiä viittauksia: tekstissä käsitellään taulukkoa, kuvaa tai matemaattista kaavaa, joka ei välttämättä sijaitse aivan välittömässä läheisyydessä ja joka tällöin identifioidaan taulukon, kuvan tai kaavan numerolla; esitettyä asiaa tulisi verrata jossakin toisessa yhteydessä esitettyyn asiaan; artikkelin lopussa saattaa olla kirjallisuusluettelo, jossa esitettyihin lähteisiin viitataan tekstissä useissa kohdissa; jne.

Kun tekstiä kehitellään, väliin lisätään tekstiä, uusia taulukoita, kuvia tai kaavoja, jolloin numeroinnit muuttuvat ja asian jakautuminen sivuille muuttuu. Kirjallisuusluetteloon lisätään viitteitä. Muutoksissa viittausten johdonmukaisuuden säilyttäminen käy vaikeaksi. LaTeX tarjoaa keinot viittausten hallitsemiseen. Seuraavat esimerkit osoittavat tärkeimmät periaateet, mutta asiaan on syytä perehtyä myös oppaita lukemalla. Tärkeimmät ovat Lamportin LaTeX: A Document Preparation System ja The LaTeX Companion.

Jos mukaan ladataan hyperref-paketti, ristiviittaukset ovat myös verkkodokumentissa aktiivisia linkkejä.

Tiedoston preamblessa määritellään otsikkotiedot ja nämä tulostetaan komennolla \maketitle itse dokumentin alussa. Tiedot tulevat joko tekstin alkuun tai erilliselle otsikkosivulle riippuen dokumenttityypistä (article, report, book):

\documentclass[12pt]{article}
\usepackage[finnish]{babel}
\usepackage[T1]{fontenc}
\usepackage[latin1]{inputenc}
\usepackage[a4paper,text={150mm,230mm}]{geometry}
\usepackage{amsmath}
\usepackage[pdftex]{graphicx}
\usepackage[pdftex]{hyperref}    %%%%% Ladattava viimeisenä pakettina!

\setlength{\parskip}{\medskipamount}
\setlength{\parindent}{0pt}
\setlength{\emergencystretch}{5mm}

%%%%% Pdf-dokumentin määrittelyjä, jotka edellyttävät hyperref-pakettia; mm. aktiivisten
%%%%% linkkien esitystapa:

\hypersetup{%
pdftitle={Matemaattisten animaatioiden laatimisen tekniset ratkaisut},
pdfsubject={},
pdfauthor={SKK},
pdfpagemode=None,
colorlinks=false,
pdfstartview={FitH 800}
}

%%%%% Määritellään otsikkotiedot:

\author{Simo K. Kivelä, Henna Komi, Ossi Mauno}
\title{Matemaattisten animaatioiden laatimisen tekniset ratkaisut}
\date{2.6.2005}

\begin{document}

%%%%% Tulostetaan otsikko:

\maketitle

%%%%% Varsinaisen tekstin alku:

Matemaattisia käsitteitä voidaan usein havainnollistaa graafisilla
esityksillä. Monissa tapauksissa syntyy lisäarvoa, jos esitys on

Tuloksena syntyvä artikkelidokumentin alku on erillisessä kuvassa.

Tietyille dokumentin kohdille kuten esimerkiksi väliotsikoille, kuville, taulukoille ja yhtälöille voidaan antaa vapaasti valittava nimi \label-komennolla. Nimen perusteella näihin voidaan viitata \ref-komennolla. Edellytyksenä on, että väliotsikko, kuva jne. on luotu siten, että LaTeX varustaa sen numerolla. Esimerkiksi \section, \figure ja \equation tuottavat juoksevan numeron, \section*, \[ ... \] ja pelkkä \includegraphics eivät.

\label voi esiintyä tekstissä myös missä tahansa kohdassa, ja kyseiseen sivuun voidaan viitata \pageref-komennoilla. Kirjallisuusluettelon elementteihin voidaan viitata \cite-komennolla. Esimerkkikatkelma:

\section{Laskentaohjelmat}\label{LaskOhj}

{\em Laskentaohjelmat} (Mathematica~\cite{mma}, Maple~\cite{mpl},
Matlab~\cite{mlb}, Mathcad~\cite{mcd} etc.) tarjoavat yleensä työkalut
animaatioiden muodostamiseen. Periaatteena on tällöin tuottaa ensin
laskemalla sarja vähitellen muuntuvia kuvia ja tämän jälkeen esittää
se katsojalle suhteellisen nopeasti. Kuvien vaihtumisnopeutta voidaan
yleensä säätää.

Mathematica ja Maple tarjoavat tässä esitettävien mahdollisuuksien
lisäksi muitakin tapoja verkossa toimivien animaatioiden
muodostamiseen. Ks. kohtia \ref{WebMma} (sivu \pageref{WebMma}) ja
\ref{Maple} (sivu \pageref{Maple}).

Esimerkkinä olkoon Mathematican käsky, jolla tehdään sarja kuvia
funktion $f(x) = x^2 + bx$ kuvaajista, missä kerroin $b$ vaihtelee
välillä $[-3,3]$ askelena $0.1$.

\begin{verbatim}
Table[Plot[x^2 + b*x, {x, -3, 3},
  PlotRange -> {{-3, 3}, {-3, 3}}, AspectRatio -> Automatic],
  {b, -3, 3, 0.1}]
\end{verbatim}

Mathematican funktio \verb+Table+ tekee tarvittavan kuvasarjan
(Mathematican terminologialla listan) ja funktio \verb+Plot+ piirtää
kuvaajan. Määreet \verb+PlotRange+ ja \verb+AspectRatio+ ovat tarpeen
asemoimaan ja skaalaamaan kaikki kuvat samalla tavoin. Kun sarja
kuvia on muodostettu, varsinainen animointi käynnistetään valikosta
(tai painamalla ctrl-y). Animointi tapahtuu Mathematica"-ikkunassa.
Kuvassa \ref{kuva:mmaanim} on tarvittava syöte ja tuloksena syntyvä
grafiikka.

\begin{figure}
\begin{center}
\includegraphics[width=120mm]{mmaanim.pdf}
\caption{Mathematica-animaatio}\label{kuva:mmaanim}
\end{center}
\end{figure}

Erilliset kuvat näyttävät tuloksen: teksti, kuva. Koska kyseessä ei ole pdf-dokumentti itse vaan sen kuva, linkit eivät ole aktiivisia hyperref-paketista huolimatta.

Kirjallisuus- tai viiteluettelo kirjoitetaan thebibliography-ympäristöön. Komennon \bibitem argumenttina on nimi, joka viitteelle annetaan ja jota käytetään \cite-komennossa. Oletuksena on, että viitteet numeroidaan automaattisesti ja viite identifioidaan numerolla tekstissä. (Muunkinlainen identifiointi on mahdollista. Tällöin on erikseen määriteltävä tyyli, jota kirjallisuusluettelossa käytetään.)

\begin{thebibliography}{\hspace{7mm}}
\bibitem{mcd} Mathcad, Mathsoft Engineering \& Education, Inc.,\newline
  \url{http://www.mathcad.com/}
\bibitem{mma} Mathematica, Wolfram Research, Inc.,
  \url{http://www.wolfram.com/}
\bibitem{mathgl3d}MathGL3d,\newline
  \url{http://phong.informatik.uni-leipzig.de/~kuska/mathgl3dv3/}
\bibitem{mlb} Matlab, The MathWorks, Inc., \url{http://www.mathworks.com/}
\bibitem{mpl} Maple, Waterloo Maple, Inc., \url{http://www.maplesoft.com/}
\bibitem{mnet} MapleNet, \url{http://www.maplesoft.com/products/maplenet}
\end{thebibliography}

Kuva edellä määritellystä viiteluettelosta.

Mikäli dokumentti sisältää viitteitä, se on ajettava LaTeXilla vähintään kahteen kertaan, jotta viiteet tulevat oikein. Jos riittävän monta kertaa ei ole ajettu, LaTeX antaa ajon päätteeksi varoituksen: LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right. Varoitus LaTeX Warning: There were undefined references. merkitsee, että on viitattu kohteeseen, jota ei ole, tai että dokumenttia ei ole ajettu riittävän monta kertaa.

Kirjallisuusviitteitä ei välttämättä tarvitse kirjoittaa dokumentin loppuun, vaan ne voidaan hakea myös erillisestä viitetietokannasta. Tämä on käyttökelpoinen ratkaisu erityisesti slloin, kun tekijä julkaisee useita artikkeleita samalta alalta, jolloin hänen kannattaa vähitellen koostaa itselleen alan viitetietokanta.

Tietokantaa käytettäessä dokumentin loppu näyttää esimerkiksi seuraavalta:

\bibliographystyle{viitetyyli}
\bibliography{omatviitteet}

Viitteet ovat tiedostossa omatviitteet.bib muodossa, joka periaatteessa näyttää seuraavalta:

@book{geddes,
author= {K. O. Geddes and S. R. Czapor and G. Labahn},
title= {Algorithms of Computer Algebra},
publisher= {Kluwer Academic Publishers},
address= {Boston},
year= 1992,
pages= 585
}

@misc{calcmath,
author= {Jerry Uhl and Bill Davis and Horacio Porta},
title= {{Calculus \& Mathematica}},
url= {http://www-cm.math.uiuc.edu/},
year= 1991
}

Viitetietokantaa käytettäessä dokumentti foo on ajettava useaan kertaan: Ensimmäinen LaTeX-ajo latex foo luo muun ohella luettelon foo.bbl niistä viitteistä, joihin dokumentissa viitataan. Tämän jälkeen ajetaan bibtex foo, joka poimii tietokannasta nämä viitteet. Lopuksi tarvitaan kaksi LaTeX-ajoa, jotta viiteluettelo ja siihen kohdistuvat viittaukset saadaan paikoilleen.

Viiteluettelo voidaan esittää useassa eri muodossa esimerkiksi sen mukaan, mitä artikkelin julkaiseva lehti haluaa. Muoto on määritelty tyylitiedostossa (edellä viitetyyli.bst). Yleisesti käytettyjä tyylejä vastaavia tiedostoja on saatavissa valmiina, mutta omansakin voi tehdä.


SKK    24.08.2011