Omstrukturerad text

Omstrukturerad text
Förlängning	.rst
MIME -typ	text/x-först
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 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 , 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 . ReST är ett av märkningsspråken som används på github , specifikt för README-filer . Formatet är experimentellt i Project Gutenberg .

Historik

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 :

• Läsbarhet
• diskreta
• Entydighet
• Inga överraskningar
• Intuitivitet
• Enkelhet
• Skalbarhet
• Uttryckskraft
• Språkneutralitet
• Expanderbarhet
• Output Format Oberoende

Som ett resultat dök PEP 287 ( Python-förbättringsförslag )  upp 2002  med en beskrivning av ReStructuredText.

Syntaxexempel

===================
 Dokumentets namn
 ===================
 
 rubrik
 ----------
 
 Lite vanlig text, *text i kursiv stil*, **text i fet stil** och en länk_:
 
 * punktlista
 * punktlista
 
 1. Det första elementet i en ordnad lista
 2. Det andra elementet i den numrerade listan

 .. figur:: http://upload.wikimedia.org/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png
 
     Ryska Wikipedia-logotypen
 
 .. _länk: http://ru.wikipedia.org

Docstring-uppmärkning (inom tre citattecken) i Python -kod :

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.""" 
...

Se även

• Prissänkning

Länkar

• Officiell sida  (engelska)
• Konfigurera Vim för enkel reStructuredText-redigering