Texto reestructurado

Texto reestructurado
Extensión	.rst
tipo MIME	texto/x-primero
Tipo de formato	formatos de texto
Sitio web	docutils.sourceforge.io/… (  inglés)

reStructuredText (abreviatura: ReST , extensión de archivo: .rst ) es un lenguaje de marcado ligero . Funciona bien para crear páginas web simples y otros documentos, y también como lenguaje auxiliar al escribir comentarios en el código del programa. Utilizado por el sistema de documentación técnica Docutils , escrito principalmente por David Goodger. Se puede pensar en reStructuredText como un descendiente de los sistemas de marcado ligeros StructuredText y Setext. El analizador reStructuredText admite una buena cantidad de formatos de salida, incluidos PDF , HTML , ODT , LaTeX y el formato de presentación S5 .

El sistema de documentación Sphinx , escrito para las necesidades de documentación del lenguaje de programación Python en el sitio docs.python.org y construido sobre la base de Docutils, ya se utiliza en varias docenas de proyectos . ReST es uno de los lenguajes de marcado utilizados en github , específicamente para archivos README . El formato es experimental en Project Gutenberg .

Historia

Jim Fulton, el creador de Zope , ideó un lenguaje de marcado de texto estructurado que se asemeja a un marcado WikiWikiWeb simplificado . Los problemas de StructuredText llevaron a David Goodger a crear un lenguaje de marcado llamado ReStructuredText. Al crear, se persiguieron los siguientes objetivos :

• Legibilidad
• discreción
• inequívoca
• No hay sorpresas
• Intuición
• Sencillez
• Escalabilidad
• Poder expresivo
• Neutralidad lingüística
• Expansibilidad
• Independencia del formato de salida

Como resultado, PEP 287 ( propuesta de mejora de Python )  apareció en 2002  con una descripción de ReStructuredText.

Ejemplo de sintaxis

==================
 nombre del documento
 ==================
 
 encabezamiento
 ---------
 
 Texto sin formato, *texto en cursiva*, **texto en negrita** y un enlace_:
 
 * elemento de lista con viñetas
 * elemento de lista con viñetas
 
 1. El primer elemento de una lista ordenada
 2. El segundo elemento de la lista numerada

 .. figura:: http://upload.wikimedia.org/wikipedia/commons/f/f6/Wikipedia-logo-v2-ru.png
 
     Logotipo de Wikipedia en ruso
 
 .. _enlace: http://ru.wikipedia.org

Marcado docstring (entre comillas triples) en código Python :

 guardián de la clase ( almacenador ):

    """ 
    Mantenga los datos actualizados durante más tiempo.

    Extiende `Storer`. El atributo de clase `instances` realiza un seguimiento 
    del número de objetos `Keeper` instanciados. 
    """

    instancias  =  0 
    """¿Cuántos objetos `Guardián` hay?"""

    def  __init__ ( self ): 
        """ 
        Extienda `Storer.__init__()` para realizar un seguimiento de las 
        instancias. Mantenga la cuenta en `self.instances` y los datos 
        en `self.data`. 
        """ 
        Storer . __init__ ( auto ) 
        auto . instancias  +=  1

        uno mismo data  =  [] 
        """Almacenar datos en una lista, los más recientes al final.""" 
...

Véase también

• Reducción

Enlaces

• Página oficial  (inglés)
• Configuración de Vim para una fácil edición de texto reestructurado