RST (reStructuredText)

RST (reStructuredText) on tapa tuottaa erilaisia rakenteisia dokumentteja ilman tarkempaa tietoa niiden kuvaukseen käytettävistä kielistä.

Tässä ohjeessa esitetyt käskyt toimivat Yleisen kielitieteen laitoksen palvelimilla, joille on asennettu RST. Mikäli olet kirjoittanut rst-dokumentin koneella, jolle ei ole asennettu RST:tä, on sinut siirrettävä se ensin Yleisen kielitieteen laitoksen palvelimelle.

RST-dokumentin tuotto

RST-tiedosto on aivan tavallinen tekstitiedosto, joka on muotoiltu tietyllä tavalla. Ohjeet muotoiluun ja merkintätapoihin löytyvät esimerkiksi osoitteesta http://docutils.sourceforge.net/docs/user/rst/quickref.html. Merkinnöissä kannattaa olla tarkkana; esimerkiksi välilyönneillä ja rivinvaihdoilla on monissa kohdissa merkitystä.

RST:llä voi kirjoittaa suoraan tekstinä esimerkiksi...

...tämän taulukon...
...jossa on...
Linkki ja tekstiä

RST-dokumentin kääntö

RST:stä verkkomateriaaliksi

RST-dokumentista voidaan tuottaa suoraan html-dokumentteja. Kääntäminen voidaan suorittaa yhdellä komennolla. Ohjeet koko prosessille löytyvät alta.

  1. Kirjoita rst-dokumenttisi ja talleta se nimella .rst-päätteellä. Tiedoston nimeen viitataan tästä lähtien nimellä oma_tiedosto.
  2. Kirjoita komentoriville käsky rst2html oma_tiedosto.rst > oma_tiedosto.html [1].
  3. Anna tiedostolle tarvittavat oikeudet. Tarvittaessa voit katsoa apua ATK-kurssin materiaaleista.

RST:stä tekstidokumentiksi

RST-dokumentista on mahdollista tuottaa myös tekstidokumentteja. RST-tiedostosta tuotetaan pdf-tiedosto kolmen yksinkertaisen käskyn avulla. Apuna prosessissa käytetään latex-julkaisujärjestelmää. Sen toimintaan ei tarvitse perehtyä millään lailla, koska tarvittava latex-dokumentti tuotetaan suoraan rst-dokumentista. Kääntämiseen tarvittavat käskyt löytyvät alta.

  1. Kirjoita rst-dokumenttisi ja talleta se nimella .rst-päätteellä.
  2. Kirjoita komentoriville käsky rst2latex oma_tiedostonimi.rst > oma_tiedostonimi.tex ja paina rivinvaihtonäppäintä.
  3. Kirjoita latex oma_tiedostonimi.tex ja paina rivinvaihtonäppäintä.
  4. Kirjoita dvipdf oma_tiedostonimi.dvi ja paina rivinvaihtonäppäintä.
[1]Kauniimman lopputuloksen voi saada komennolla rst2html --initial-header-level=2 sivun_nimi.rst > sivun_nimi.html