summaryrefslogtreecommitdiff
path: root/info/kaytannollista-latexia/README.md
blob: 37a7b600353d42a539ea34fdf3b5cc78dd8074b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
Käytännöllistä Latexia
======================

**Latex-ladontajärjestelmän opas**

English summary: *Käytännöllistä Latexia* is a Finnish practical manual
for [Latex](https://en.wikipedia.org/wiki/LaTeX) typesetting system. The
manual covers most of the topics that a typical document author needs.
So it can be useful guide for beginners as well as reference manual for
advanced users.


Esittely
--------

*Käytännöllistä Latexia* on nykyaikainen suomenkielinen opas
[Latex](https://fi.wikipedia.org/wiki/LaTeX)-ladontajärjestelmän
käyttäjälle. Se auttaa alkuun pääsyssä ja esittelee merkintäkielen
perusasiat. Opas sisältää käytännönläheiset ohjeet esimerkiksi
dokumentin sivu-, fontti- ja kieliasetusten tekemiseen. Se sisältää
teknisiä ohjeita ja typografisia vinkkejä tavallisimpiin
tekstidokumentin kirjoittamisen tarpeisiin. Oppaan avulla pitäisi
pärjätä niin hyvin, että makropakettien ohjeita tarvitsee lukea vain
harvoin.

Edellisessä kappaleessa mainostettu nykyaikaisuus tarkoittaa esimerkiksi
sitä, että tässä oppaassa keskitytään Open Type -fontteihin,
Unicode-merkistöön ja PDF-tiedostoihin. Latexin vanha fonttitekniikka
sivuutetaan, eikä merkistörajoitusten kanssa enää kamppailla. Oppaan
ohjeet siis sopivat nykyaikaiselle tietokoneen käyttäjälle.


Saatavuus
---------

Oppaasta on saatavilla valmiiksi ladottu PDF-tiedosto Githubissa
[julkaisusivulla](https://github.com/tlikonen/latex-opas/releases). Myös
Latex-lähdetiedostot ovat saatavilla Githubissa osoitteessa
<<https://github.com/tlikonen/latex-opas>>.


Versionumerointi
----------------

Oppaan versionumerot tulevat julkaisuajan vuosiluvusta sekä
mahdollisesti kuukaudesta ja päivästä. Vuoden ensimmäinen tai ainoa
julkaisu saa versionumeronsa pelkästä vuosiluvusta, esimerkiksi versio
”2022”. Jos samana vuonna julkaistaan oppaasta uusi versio, lisätään
versionumeroon kyseisen kuukauden numero, esimerkiksi versio ”2022.4”
(huhtikuu 2022). Saman kuun aikana toinen julkaisu saa versionumeroonsa
vielä päivänkin numeron, esimerkiksi ”2022.4.15” (15. huhtikuuta 2022).


Tekijänoikeus ja lisenssi
-------------------------

Tekijä: Teemu Likonen <<tlikonen@iki.fi>>

OpenPGP-avain: [6965F03973F0D4CA22B9410F0F2CAE0E07608462][PGP]

[PGP]: http://www.iki.fi/tlikonen/pgp-key.asc

Lisenssi: *Creative Commons Nimeä-JaaSamoin 4.0 Kansainvälinen* (CC
BY-SA 4.0). Lisenssi antaa sinulle luvan kopioida ja levittää tätä
teosta tai sen osia missä tahansa välineessä ja muodossa. Sisältöä saa
muokata, ja sen pohjalta saa luoda uusia teoksia mihin tahansa
tarkoitukseen, myös kaupallisesti. Ehdot ovat seuraavat:

  - Sinun on mainittava tekijä(t) asianmukaisesti, tarjottava linkki
    [lisenssin koko tekstiin][CC] sekä mainittava, mikäli olet tehnyt
    muutoksia.
  - Jos muokkaat teosta tai luot sen pohjalta uuden teoksen, sinun on
    jaettava muutoksiasi samalla lisenssillä kuin alkuperäistä teosta.
  - Et saa asettaa sellaisia oikeudellisia ehtoja tai teknisiä estoja,
    jotka estävät muita tekemästä asioita, jotka tämä lisenssi sallii.

[CC]: https://creativecommons.org/licenses/by-sa/4.0/legalcode.fi


Kääntäminen ja asentaminen
--------------------------

Oppaan Latex-lähdetiedostojen kääntäminen eli latominen PDF-dokumentiksi
vaatii useita Latexin makropaketteja ja pari fonttia. Latexin
jakelukokonaisuus [Texlive](https://tug.org/texlive/) sisältää kaiken
tarvittavan. Esimerkiksi [Debian](https://www.debian.org) Linux
-käyttöjärjestelmässä asennuspaketti `texlive-full` asentaa koko
Texliven.

Oppaan voi latoa julkaisupaketin ja asennettujen tiedostojen avulla tai
versionhallinnan tiedostojen pohjalta.


### Julkaisupaketti

Oppaan julkaisupaketin lähdetiedostot voi latoa PDF-tiedostoksi
komennoilla `lualatex` ja `biber`. Komennot täytyy suorittaa seuraavassa
järjestyksessä:

    lualatex -shell-escape kaytannollista-latexia
    biber kaytannollista-latexia
    lualatex -shell-escape kaytannollista-latexia
    lualatex -shell-escape kaytannollista-latexia


### Versionhallinta (Git)

Git-versionhallintajärjestelmässä säilytettävä opas sisältää tiedoston
`Makefile`, joka puolestaan sisältää kääntämisohjeet `make`-komennolle.
PDF-tiedoston saa ladottua yhdellä komennolla:

    make

Kääntämisessä syntyneen PDF-tiedoston voi siirtää haluamaansa paikkaan
käyttöä varten. Oppaan voi myös asentaa Texin standardiin
hakemistorakenteeseen, josta muut ohjelmat voivat sen löytää. Se tehdään
seuraavalla komennolla:

    make install

Edellisen asennuskomennon voi suorittaa ilman erillistä
kääntämisvaihettakin, koska ennen asentamista se varmistaa, että
tarvittavat tiedostot on käännetty. Asennuskohde on käyttäjän
kotihakemistossa eli polussa `$HOME/texmf`. Kohteeseen asentuu paitsi
oppaan PDF-tiedosto myös Latexin lähdetiedostot ja tämä käsillä oleva
`README.md`. Asentamisen jälkeen esimerkiksi Texliveen sisältyvä komento
`texdoc` osaa löytää ja avata oppaan, kun komennolle antaa argumentiksi
joitakin oppaan nimen kirjaimia, esimerkiksi `texdoc kaytannoll`.

Asennus poistetaan komennolla `make uninstall`. Komento tosin säilyttää
polun `$HOME/texmf`, koska siellä voi edelleen sijaita muita Texiin ja
Latexiin liittyviä tiedostoja.

Kääntämishakemiston voi siivota alla olevilla komennoilla. Ensin
mainittu komento poistaa useimmat väliaikaistiedostot mutta säilyttää
oppaan PDF:n ja muut julkaisuun vaadittavat tiedostot. Jälkimmäinen
poistaa kaikki syntyneet tiedostot.

    make clean
    make distclean


Puutteita ja suunnitelmia
-------------------------

  - Lisätään Muuta tekniikkaa -luku, jonka sisällöksi esimerkiksi:
    päiväykset ja kellonajat (datetime2), textpos-paketti, omien
    makropakettien ja dokumenttiluokkien tekeminen.
  - Marginaalihuomautusluvussa voisi mainita `\marginpar`-komennon
    puutteet ja vaihtoehdon `marginnote`.
  - Mahdollisesti käsitellään wrapfig-paketti.
  - Uusi `fi-x-school`-tavutuskaava.
  - Mittojen käsittelyn yhteydessä voisi käsitellä calc-paketin.