Dette er et eksempeldokument for rST.
Kildefilen ligger på http://folk.uio.no/kjell/rst-mal.rst.
Det er lett å få med både en innholdsfortegnelse og seksjonsnummerering av kapittler og avsnitt, se over. Linjer som starter med to punktum er magiske se også fotnotene.
Dokumentasjonen finner du på http://docutils.sourceforge.net/docs/user/rst/quickstart.html
Den fullstendige referansen er http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
For å generere ei html-fil må du ha noen biter installert på maskinen din:
$ cat /etc/usit/sw-localcopy .. docutils python maskin# /local/etc/config/store/store.nightlyDe to pakkene kan du installere f.eks med
storeapp -a docutils storeapp -a pythonså kan du kjøre /local/bin/rst2html.py på fila og redirigere til fil, f.eks slik:
$ rst2html.py rst-mal.rst > rst-mal.htmlDet er også mulig å få laget ei latex-fil for f.eks å generere .ps-fil eller .pdf-fil senere. med rst2latex.
Du finner et godt dokument i rST på http://intra.usit.uio.no/gt/postmaster/systemdok.rst
Her er et avsnitt. Det er skilt fra det neste med ei blank linje.
NB! Uten blanke linjer får du heller ikke linjeskift jf. http://folk.uio.no/kjell/rst-mal.html#det-som-ikke-er-anbefalt-eller-mulig
Under her lager jeg ei liste i to nivå. Merk den tomme linja etter første punkt og før lista:
Trenger du flere nivåer gjør du det med forskjellige linjer under overskriften.
Skal du ha noe i kursiv eller sterkt uthevet?
Å skrive stjerner (asterisk) kan gjøres med /usit/modell/*
To kolon
Preformatert tekst med magikken med to kolon her
Dette er preformatert tekst. Den er indentert også og fortsetter helt ut avsnittet.Her er det slutt.
Doble quotes-tegn for hver linje:
Trenger du å skrive noe på en spesiell måte kan du det med doble quotes.
Du må gjenta for hver linje da linjeskift ikke vil klare seg.
Ved inntrykk i teksten
Trolig er det mye lettere både å skrive og å lese tekst som er indentert i teksten slik.
Dette brukes mye for sitater ol.
Kommentar: Dersom du bruker emacs er det to kjekke funksjoner for å få til disse innrykkene i teksten. Det er:
- ^ r t <et knippe blanke>
- M-x fill-individual-paragraphs som virker på ei lang linje med et knippe blanke i starten av linja.
Fotnoter[1] kommer med i html-dokumentet om de har de magiske to punktumene nederst, i kallet.
Det er også mulig med autonummererte fotnoter, se http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#auto-numbered-footnotes
Tester auto_fotnote [2] da de kan mikses. Her er nok [3] en fotnote. De automatiske får superscript i teksten, mens de manuelle kommer i firkant-parenteser.
Her er et eksempel på en tabell:
| Header row, column 1 (header rows optional) | Header 2 | Header 3 | Header 4 |
|---|---|---|---|
| body row 1, column 1 | column 2 | column 3 | column 4 |
| body row 2 | Cells may span columns. | ||
| body row 3 | Cells may span rows. |
|
|
| body row 4 | |||
Vil du ha en peker slik at URLen er skjult og kun navnet/referanse kommer i teksten. Kan du gjøre det med sitert tekst avsluttet med en underline.
Her er et forsøk: Kjells hjemmeside
Dersom du kun vil ha en http://folk.uio.no/kjell/ peker som IKKE er klikkbar må det gjøres slik: Med en underline foran pekeren som står i sitat-tegn
Q: Hva er disse referanser for noe?
A: Trolig bare en peker ned i dokumentet.
De virker greit opp i innholdsfortegnelsen også.
Dersom det er et linjeskift og ikke et avsnitt er det ikke lett.
Fra the reStructuredText Markup Specification:
"If the preservation of line breaks and/or other whitespace is important, literal blocks should be used"
| [1] | Merk at det ikke er noe kolon etter klammeparentesen her i fotnoten. |
| [2] | Får se om det virker! |
| [3] | Det er viktig å skrive fotnotene i rett rekkefølge uansett |