| Omstrukturerad text | |
|---|---|
| Förlängning | .rst |
| MIME -typ | text/x-först [1] |
| Formattyp | textformat |
| Hemsida | docutils.sourceforge.io/… ( engelska) |
reStructuredText (förkortning: ReST , filtillägg: .rst ) är ett lättviktigt märkningsspråk . Det fungerar bra för att skapa enkla webbsidor och andra dokument, och även som ett hjälpspråk när du skriver kommentarer i programkod. Används av Docutils [2] tekniska dokumentationssystem , skrivet i första hand av David Goodger. reStructuredText kan ses som en ättling till de lätta uppmärkningssystemen StructuredText och Setext. ReStructuredText-parsern stöder en hel del utdataformat, inklusive PDF , HTML , ODT , LaTeX och presentationsformatS5 .
Dokumentationssystemet Sphinx [3] , skrivet för behoven av att dokumentera Python - programmeringsspråket på sajten docs.python.org och byggt på basis av Docutils, används redan i flera dussin projekt [4] . ReST är ett av märkningsspråken som används på github [5] , specifikt för README-filer . Formatet är experimentellt i Project Gutenberg [6] [7] .
Jim Fulton, skaparen av Zope , kom med ett StructuredText märkningsspråk som liknar en förenklad WikiWikiWeb märkning . StructuredTexts problem ledde till att David Goodgers skapade ett uppmärkningsspråk som heter ReStructuredText. När du skapade eftersträvades följande mål [8] :
Som ett resultat dök PEP 287 ( Python-förbättringsförslag ) upp 2002 med en beskrivning av ReStructuredText.
Docstring-uppmärkning (inom tre citattecken) i Python -kod [1] :
klass Keeper ( lager ): """ Håll data uppdaterad längre. Förläng `Störer`. Klassattributet "instanser" håller reda på antalet "Keeper"-objekt som instansierats. """ instanser = 0 """Hur många `Keeper`-objekt finns det?""" def __init__ ( self ): """ Utöka `Storer.__init__()` för att hålla reda på instanser. Håll räkningen i `self.instances` och data i `self.data`. """ Lagring . __init__ ( själv ) själv . instanser += 1 själv . data = [] """Lagra data i en lista, senaste senast.""" ...