ReStructuredText
| reStructuredText | ||
|---|---|---|
|
| ||
| utvikler | ||
| David Goodger | ||
| https://docutils.sourceforge.io/rst.html | ||
| Generell informasjon | ||
| filutvidelse | først | |
| mime-type | tekst/x-rst | |
| Siste versjon |
Revisjon 7629 11. mars 2013 | |
| formattype | Teknisk dokumentasjon | |
| åpent format | ? | |
ReStructured Text-prosjektet er et lett markeringsspråk laget for å skrive formatert tekst enkelt og raskt. Det er en del av Docutils-prosjektet innenfor Python -fellesskapet , og er formalisert av Python Doc-SIG-gruppen (Documentation Special Interest Group). Det har den største fordelen at denne teksten kan brukes til å generere tilsvarende dokumenter i HTML, LaTeX, docbook, etc. Det er en utvikling av strukturert tekst .
Ofte blir begrepet Restructured Text forkortet til ReST eller reST, noe som forårsaker forvirring med begrepet REST (Representational State Transfer), en type grensesnitt gjennom HTTP -protokollen som ikke er relatert til formatet som angår oss i denne artikkelen.
Syntakseksempler
Det følgende er ikke en uttømmende liste over reST-syntaks. Se en mer fullstendig referanse til den første hurtigreferansen for mer informasjon.
Overskrifter:
seksjonsoverskrift ========================== Underseksjonsoverskrift ----------------------------
Lister:
- Et element i en uordnet liste - Et annet element i en liste - Et underelement - Tredje element
1) Et element i en nummerert liste
2) Andre element
a) Underelement
i) Underdelelement
3) Tredje element
# Et annet element i en opplistet liste # Andre element
Navngitte lenker:
En setning som lenker til Wikipedia_ og `Linux-kjernearkivet`_. .. _Wikipedia: http://www.wikipedia.org/ .. _Linux-kjernearkiv: http://www.kernel.org/
anonyme lenker:
En annen setning med en `anonym lenke til Python-nettstedet`__. __ http://www.python.org/
Innebygde lenker:
`Python < http://www.python.org/ >`_.
Merk at lenkene omslutter tekster med en alvorlig aksent (`), og ikke en apostrof ('). Hvis tastaturet ikke har backtick-tasten; i Microsoft Windows kan du skrive inn tallet på det numeriske tastaturet med kombinasjonen Alt+96, i GNU / Linux Ubuntu bruker du MAYÚS+ CTRL+ Uog trykker deretter 6, 0og ESPACIO.
Bilder:
..image::images/ball1.gif