| Text restructurat | |
|---|---|
| Extensie | .rst |
| tip MIME | text/x-prima [1] |
| Tip de format | formate de text |
| Site-ul web | docutils.sourceforge.io/… ( engleză) |
reStructuredText (abreviere: ReST , extensia de fișier: .rst ) este un limbaj de marcare ușor . Funcționează bine pentru a crea pagini web simple și alte documente și, de asemenea, ca un limbaj auxiliar atunci când scrieți comentarii în codul programului. Folosit de sistemul de documentație tehnică Docutils [2] , scris în primul rând de David Goodger. reStructuredText poate fi considerat ca un descendent al sistemelor de marcare StructuredText și Setext. Analizorul reStructuredText acceptă un număr destul de mare de formate de ieșire, inclusiv PDF , HTML , ODT , LaTeX și formatul de prezentare S5 .
Sistemul de documentare Sphinx [3] , scris pentru nevoile de documentare a limbajului de programare Python pe site-ul docs.python.org și construit pe baza Docutils, este deja folosit în câteva zeci de proiecte [4] . ReST este unul dintre limbajele de marcare utilizate pe github [5] , în special pentru fișierele README . Formatul este experimental în Proiectul Gutenberg [6] [7] .
Jim Fulton, creatorul Zope , a venit cu un limbaj de marcare StructuredText care seamănă cu un marcaj simplificat WikiWikiWeb . Problemele StructuredText au dus la crearea de către David Goodger a unui limbaj de marcare numit ReStructuredText. La creare, au fost urmărite următoarele obiective [8] :
Ca rezultat, PEP 287 ( propunere de îmbunătățire Python ) a apărut în 2002 cu o descriere a ReStructuredText.
Markup Docstring (între ghilimele triple) în codul Python [1] :
Păstrator de clasă ( Depozitar ): """ Păstrați datele mai proaspete mai mult timp. Extindeți „Storer”. Atributul de clasă `instanțe` ține evidența numărului de obiecte `Keeper` instanțiate. """ instances = 0 """Câte obiecte `Keeper` există?""" def __init__ ( self ): """ Extindeți `Storer.__init__()` pentru a ține evidența instanțelor. Țineți numărătoarea în `self.instances` și datele în `self.data`. """ Storer . __init__ ( self ) self . cazuri += 1 sine . data = [] """Stochează datele într-o listă, cea mai recentă ultima.""" ...