| Uudelleenjärjestetty teksti | |
|---|---|
| Laajennus | .rst |
| MIME -tyyppinen | text/x-rst [1] |
| Muototyyppi | tekstimuodot |
| Verkkosivusto | docutils.sourceforge.io/… ( englanti) |
reStructuredText (lyhenne: ReST , tiedostopääte: .rst ) on kevyt sivunkuvauskieli . Se toimii hyvin yksinkertaisten web-sivujen ja muiden asiakirjojen luomiseen sekä apukielinä kirjoitettaessa kommentteja ohjelmakoodiin. Käytetään Docutils [2] teknisessä dokumentaatiojärjestelmässä , jonka on kirjoittanut pääasiassa David Goodger. reStructuredText voidaan ajatella kevyen StructuredText- ja Setext-merkintäjärjestelmien jälkeläisenä. ReStructuredText-jäsennin tukee lukuisia tulostusmuotoja, mukaan lukien PDF , HTML , ODT , LaTeX ja S5 - esitysmuoto .
Python - ohjelmointikielen dokumentoinnin tarpeisiin docs.python.org-sivustolle kirjoitettu ja Docutilsin pohjalta rakennettu Sphinx-dokumentaatiojärjestelmä [3] on käytössä jo useissa kymmenissä projekteissa [ 4 ] . ReST on yksi githubissa [5] käytetyistä merkintäkielistä , erityisesti README-tiedostoille . Muoto on kokeellinen Gutenberg-projektissa [6] [7] .
Jim Fulton, Zopen luoja , keksi StructuredText- kuvauskielen , joka muistuttaa yksinkertaistettua WikiWikiWeb -merkintää . StructuredTextin ongelmat johtivat siihen, että David Goodger loi merkintäkielen nimeltä ReStructuredText. Luodessasi pyrittiin seuraaviin tavoitteisiin [8] :
Tämän seurauksena PEP 287 ( Python-parannusehdotus ) ilmestyi vuonna 2002 kuvauksen kanssa ReStructuredTextistä.
Python -koodin [1] dokumenttimerkkijono (kolmoislainausmerkeissä) :
luokan pitäjä ( varastointi ): """ Pidä tiedot tuoreena pidempään. Laajenna "Säilyttäjä". Luokka-attribuutti "instances " seuraa instantoitujen "Keeper"-objektien määrää. """ instances = 0 """Kuinka monta `Keeper`-objektia on?""" def __init__ ( self ): """ Laajenna `Storer.__init__()` seurataksesi ilmentymiä. Säilytä lukumäärä `self.instances` -kohdassa ja tiedot `self.data-kohdassa. """ Storer . __init__ ( itse ) itse . tapaukset += 1 itse . data = [] """Tallenna tiedot luetteloon, viimeisin viimeisin.""" ...