summaryrefslogtreecommitdiff
path: root/info/kaytannollista-latexia/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-12-28 03:01:00 +0000
committerNorbert Preining <norbert@preining.info>2021-12-28 03:01:00 +0000
commitecdf859b6ce481abfd530425dcf6f0f764bd0001 (patch)
tree13bc161dc046876ac6c92fce5f9f5034ba9aa573 /info/kaytannollista-latexia/README.md
parent790995b7e79697514364450bf9c04f1b8d500838 (diff)
CTAN sync 202112280300
Diffstat (limited to 'info/kaytannollista-latexia/README.md')
-rw-r--r--info/kaytannollista-latexia/README.md153
1 files changed, 153 insertions, 0 deletions
diff --git a/info/kaytannollista-latexia/README.md b/info/kaytannollista-latexia/README.md
new file mode 100644
index 0000000000..37a7b60035
--- /dev/null
+++ b/info/kaytannollista-latexia/README.md
@@ -0,0 +1,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.