Diferencia entre revisiones de «Usuario:Lmorillas/modulo lenguajes de marcas/ligeros/rst»

De WikiEducator
Saltar a: navegación, buscar
(→‎¿Cómo escribo rst?)
Línea 1: Línea 1:
−
{{MiTitulo | Restructured Text}}
+
{{MiTitulo | Restructured Text}}  
  
−
== ¿Qué es? ==
+
== ¿Qué es? ==
−
reStructuredText es un lenguaje de marcas ligero, de fácil lectura en su formato de fuente pero muy versátil para producir documentos complejos.
+
  
−
==¿Qué puedo hacer?==
+
reStructuredText es un lenguaje de marcas ligero, de fácil lectura en su formato de fuente pero muy versátil para producir documentos complejos.  
−
* Escribo la documentación en texto plano y después la convierto a distintos formatos.
+
−
* Soporta versionado porque es texto
+
−
* Se puede leer con cualquier editor
+
  
−
== Documentación de referencia ==  
+
== ¿Qué puedo hacer? ==
−
* http://sphinx.pocoo.org/rest.html
+
−
* http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
+
−
* http://people.ee.ethz.ch/~creller/web/tricks/reST.html
+
−
* Manual de rst2pdf (y rst en general): http://lateral.netmanagers.com.ar/static/manual.pdf
+
  
−
== ¿Cómo escribo rst? ==
+
*Escribo la documentación en texto plano y después la convierto a distintos formatos.
−
; Documento de texto
+
*Soporta versionado porque es texto
−
: Escribe un documento de texto plano. Suelen tener extensión .rst o .txt
+
*Se puede leer con cualquier editor
 +
 
 +
== Documentación de referencia  ==
 +
 
 +
*http://sphinx.pocoo.org/rest.html
 +
*http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
 +
*http://people.ee.ethz.ch/~creller/web/tricks/reST.html
 +
*Manual de rst2pdf (y rst en general): http://lateral.netmanagers.com.ar/static/manual.pdf
 +
* Presentación rst http://catherinedevlin.pythoneers.com/presentations/rst/olf.html
 +
 
 +
 
 +
== ¿Cómo escribo rst? ==
 +
 
 +
;Documento de texto  
 +
:Escribe un documento de texto plano. Suelen tener extensión .rst o .txt
 +
 
 +
;Títulos y subtítulos
 +
:Para escribir un título basta con poner símbolos '=' debajo del texto del título, de la siguiente forma:
  
−
; Títulos y subtítulos
 
−
: Para escribir un título basta con poner símbolos '=' debajo del texto del título, de la siguiente forma:
 
 
  Título
 
  Título
 
  ======
 
  ======
−
: Los símbolos = puestos debajo del texto deben tener el mismo tamaño que el título.
 
  
−
: Para la escritura de subtítulos y subtítulos de segundo nivel, se utiliza los símbolos '-' y '*', respectivamente. Su utilización es igual que el de los títulos, ejemplo:
+
:Los símbolos = puestos debajo del texto deben tener el mismo tamaño que el título.
 +
 
 +
:Para la escritura de subtítulos y subtítulos de segundo nivel, se utiliza los símbolos '-' y '*', respectivamente. Su utilización es igual que el de los títulos, ejemplo:
 +
 
 
  Subtítulo
 
  Subtítulo
 
  ---------
 
  ---------
Línea 35: Línea 44:
 
  +++++++++++++++++++++++++
 
  +++++++++++++++++++++++++
  
−
; Estilo de texto
+
;Estilo de texto  
−
: <nowiki>*cursiva* o  **negrita**. ``texto en espacio fijo.`` </nowiki>
+
:<nowiki>*cursiva* o  **negrita**. ``texto en espacio fijo.`` </nowiki>
 +
 
 +
;Saltos de página en pdf
 +
:Cuando se necesita hacer un salto de página, se debe utilizar el siguiente código:
  
−
; Saltos de página en pdf
 
−
: Cuando se necesita hacer un salto de página, se debe utilizar el siguiente código:
 
 
  .. raw:: pdf
 
  .. raw:: pdf
 
   
 
   
−
    PageBreak
+
  PageBreak
 +
 
 +
;Listas
 +
:listas con viñetas y numeradas:
  
−
; Listas
 
−
: listas con viñetas y numeradas:
 
 
  * Lista con viñetas
 
  * Lista con viñetas
 
  * Lista con viñetas
 
  * Lista con viñetas
Línea 52: Línea 63:
 
  #. Lista numeradas
 
  #. Lista numeradas
  
−
; Imágenes
+
;Imágenes
 +
 
 
  .. figure:: img/nombre_archivo.png
 
  .. figure:: img/nombre_archivo.png
−
    :width: 100%
+
  &nbsp;:width: 100%
−
    :height: 100
+
  &nbsp;:height: 100
−
    :scale: 50
+
  &nbsp;:scale: 50
−
    :alt: texto alternativo
+
  &nbsp;:alt: texto alternativo
  
−
: El campo width indica el tamaño de la imagen en el documento, un 100% indica que utiliza el máximo posible ya sea el tamaño de la imagen o el tamaño de la hoja.
+
:El campo width indica el tamaño de la imagen en el documento, un 100% indica que utiliza el máximo posible ya sea el tamaño de la imagen o el tamaño de la hoja.  
−
; Más ejemplos con rst
+
;Más ejemplos con rst  
−
: Ejemplo: http://catherinedevlin.pythoneers.com/presentations/rst/show.rst
+
:Ejemplo: http://catherinedevlin.pythoneers.com/presentations/rst/show.rst  
−
: Resultado: http://catherinedevlin.pythoneers.com/presentations/rst/show.html
+
:Resultado: http://catherinedevlin.pythoneers.com/presentations/rst/show.html
  
−
== Herramientas de conversión ==
+
== Herramientas de conversión  ==
−
* Online: http://www.tele3.cz/jbar/rest/rest.html
+
−
* Instalo [[http://docutils.sourceforge.net '''doctuils''']] y [[http://code.google.com/p/rst2pdf/ '''rst2pdf''']]
+
−
=== Ejemplos de uso ===
+
−
Abro un terminal. '''Ejemplo en linux''':
+
−
  $ rst2html <origen.rst> <destino.html>  --> crea destino.html
+
−
  $ rst2pdf <origen.rst> --> crea origen.pdf
+
  
−
Ejemplos:
+
*Online: http://www.tele3.cz/jbar/rest/rest.html
−
<source lang="bash">
+
*Instalo [[http://docutils.sourceforge.net '''doctuils''']] y [[http://code.google.com/p/rst2pdf/ '''rst2pdf''']]
 +
 
 +
=== Ejemplos de uso  ===
 +
 
 +
Abro un terminal. '''Ejemplo en linux''':  
 +
 
 +
  $ rst2html &lt;origen.rst&gt; &lt;destino.html&gt;  --&gt; crea destino.html
 +
$ rst2pdf &lt;origen.rst&gt; --&gt; crea origen.pdf
 +
 
 +
Ejemplos: <source lang="bash">
 
user@home $ rst2html intro.rst intro.html
 
user@home $ rst2html intro.rst intro.html
  
 
user@home $ rst2pdf intro.rst
 
user@home $ rst2pdf intro.rst
−
</source>
+
</source>  
 +
 
 +
=== Mejorando la presentación ===
 +
* Hojas de estilo para docutils: http://docutils.sourceforge.net/docs/howto/html-stylesheets.html
 +
* Hojas de ejemplo: http://docutils.sourceforge.net/sandbox/stylesheets/
 +
* Crear estilos personalizados: http://docutils.sourceforge.net/docs/user/slide-shows.html
 +
* Temas para S5: http://meyerweb.com/eric/tools/s5/themes/
 +
 
 +
=== Creación de presentaciones con rst2pdf  ===
 +
 
 +
*Presentaciones: http://lateral.netmanagers.com.ar/tr/es/stories/BBS52.html
 +
*Modificación de estilos: http://python.org.ar/pyar/Recetario/EstilosRst2Pdf
 +
*Unos ejemplos para practicar: https://subversion.american.edu/aisaac/misc/
 +
 
 +
:Comandos de creación
  
−
=== Creación de presentaciones con rst2pdf ===
 
−
* Presentaciones: http://lateral.netmanagers.com.ar/tr/es/stories/BBS52.html
 
−
* Modificación de estilos: http://python.org.ar/pyar/Recetario/EstilosRst2Pdf
 
−
* Unos ejemplos para practicar: https://subversion.american.edu/aisaac/misc/
 
−
: Comandos de creación
 
 
  rst2pdf -s estilo.txt  slides.rst  -b1 -o slides.pdf
 
  rst2pdf -s estilo.txt  slides.rst  -b1 -o slides.pdf

Revisión de 11:35 13 oct 2011


¿Qué es?

reStructuredText es un lenguaje de marcas ligero, de fácil lectura en su formato de fuente pero muy versátil para producir documentos complejos.

¿Qué puedo hacer?

  • Escribo la documentación en texto plano y después la convierto a distintos formatos.
  • Soporta versionado porque es texto
  • Se puede leer con cualquier editor

Documentación de referencia


¿Cómo escribo rst?

Documento de texto
Escribe un documento de texto plano. Suelen tener extensión .rst o .txt
Títulos y subtítulos
Para escribir un título basta con poner símbolos '=' debajo del texto del título, de la siguiente forma: 
Título
======
Los símbolos = puestos debajo del texto deben tener el mismo tamaño que el título.
Para la escritura de subtítulos y subtítulos de segundo nivel, se utiliza los símbolos '-' y '*', respectivamente. Su utilización es igual que el de los títulos, ejemplo: 
Subtítulo
---------

Subtítulo de Segundo Nivel
**************************

Subtítulo de Tercer Nivel
+++++++++++++++++++++++++
Estilo de texto
*cursiva* o **negrita**. ``texto en espacio fijo.``
Saltos de página en pdf
Cuando se necesita hacer un salto de página, se debe utilizar el siguiente código: 
.. raw:: pdf

  PageBreak
Listas
listas con viñetas y numeradas: 
* Lista con viñetas
* Lista con viñetas

#. Lista numerada
#. Lista numeradas
Imágenes 
.. figure:: img/nombre_archivo.png
   :width: 100%
   :height: 100
   :scale: 50
   :alt: texto alternativo
El campo width indica el tamaño de la imagen en el documento, un 100% indica que utiliza el máximo posible ya sea el tamaño de la imagen o el tamaño de la hoja.
Más ejemplos con rst
Ejemplo: http://catherinedevlin.pythoneers.com/presentations/rst/show.rst
Resultado: http://catherinedevlin.pythoneers.com/presentations/rst/show.html

Herramientas de conversión

Ejemplos de uso

Abro un terminal. Ejemplo en linux: 

 $ rst2html <origen.rst> <destino.html>  --> crea destino.html
$ rst2pdf <origen.rst> --> crea origen.pdf
Ejemplos: 
user@home $ rst2html intro.rst intro.html
 
user@home $ rst2pdf intro.rst

Mejorando la presentación

Creación de presentaciones con rst2pdf

Comandos de creación 
rst2pdf -s estilo.txt  slides.rst  -b1 -o slides.pdf
Obtenido de «https://es.wikieducator.org/index.php?title=Usuario:Lmorillas/modulo_lenguajes_de_marcas/ligeros/rst&oldid=6041»