Diferencia entre revisiones de «Usuario:Lmorillas/modulo lenguajes de marcas/ligeros/rst»
De WikiEducator
(Página creada con '{{MiTitulo | Restructured Text}} == ¿Qué es? == reStructured Text es un sistema de marcado para escribir documentos. ==¿Qué puedo hacer?== * Escribo la documentación en …') |
|||
| Línea 18: | Línea 18: | ||
siguiente forma: | siguiente forma: | ||
Título | Título | ||
| − | ==== | + | ====== |
: Los símbolos = puestos debajo del texto deben tener el mismo tamaño que el título. | : Los símbolos = puestos debajo del texto deben tener el mismo tamaño que el título. | ||
| Línea 34: | Línea 34: | ||
: Cuando se necesita hacer un salto de página, se debe utilizar el siguiente código: | : Cuando se necesita hacer un salto de página, se debe utilizar el siguiente código: | ||
.. raw:: pdf | .. raw:: pdf | ||
| − | |||
PageBreak | PageBreak | ||
Revisión de 23:49 3 oct 2011
¿Qué es?
reStructured Text es un sistema de marcado para escribir documentos.
¿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
- http://sphinx.pocoo.org/rest.html
- http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
¿Cómo escribo rst?
- 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 +++++++++++++++++++++++++
- 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%
- 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.
