Document Actions
Formateo básico de un documento
- Estructura
- Estilos de texto
- Listas
- Preformateado (ejemplos de código)
- Secciones
- Hipervínculos
- Tablas
Estructura
La estructura más básica reconocida es el párrafo, que no es más que texto separado por líneas en blanco. Los párrafos deben tener la misma indentación o aparecerán sangrados.
Por ejemplo:
Esto es un párrafo. Es un poco corto.
Este párrafo producirá como resultado un bloque indentado de texto,
usado típicamente para citar otro texto
Este es otro párrafo.
El resultado es:
Esto es un párrafo. Es un poco corto.
Este párrafo producirá como resultado un bloque indentado de texto, usado típicamente para citar otro texto
Este es otro párrafo.
Estilos de texto
Dentro de los párrafos y otros cuerpos de texto, puedes querer marcas de texto adicionales para itálica con "*italica*" o negrita con "**negrita**".
Si quieres que algo aparezca literalmente utiliza comillas dobles. Nota que no se interpreta el contenido de las comillas dobles así los asteríscos "*" etc. se quedan sólos
Si necesitas usar un carácter "especial" en el texto, generalmente estará bien, --reStructuredText es muy inteligente. Por ejemplo, este * asterísco está bien puesto. Si quieres que el /texto esté rodeado de asteríscos y que no se "italicen", entonces necesitas indicar que el asterisco no es especial. Esto se indica anteponiendo una barra invertida justo antes de él, del siguiente modo "\*", o rodeándolo dobles comillas, del siguiente modo:
``\*``
Listas
Los elementos de la lista pueden definirse de tres modos: enumerated, viñetas o símbolos y definiciones (nosotros hablaremos de los 2 primeros).
Las listas deben empezar siempre en un párrafo nuevo como éste y después de una línea en blanco.
Lista numerada (números, letras o números romanos)
Comienza un línea con un número o una letra seguida de un punto ".", un paréntesis de cierre ")" o entre paréntesis "( )" lo que resulte más cómodo. Todas las formas siguientes están reconocidas:
1. números A. Letras mayúsculas y que se dividan en varias líneas con dos párrafos y todo a. letras en minúscula 3. Con una sublista que comienza con un número diferente 4. asegurate que los números están en la secuencia correcta I. números romanos en mayúscula i. números romanos en minúscula (1) números otra vez 1) y otra
el resultado es (aviso: los diferentes estilos de enumerado de listas no son soportados siempre por todos los navegadores, así puede que no surta efecto aquí):
- números
Letras mayúsculas y que se dividan en varias líneas
con dos párrafos y todo
- letras en minúscula
- Con una sublista que comienza con un número diferente
- asegurate que los números están en la secuencia correcta
- números romanos en mayúscula
- números romanos en minúscula
- números otra vez
- y otra
Al igual que las listas enumeradas, las listas con viñetas comienzan con un carácter símbolo que puede ser "-", "+" o "*":
* una viñeta usando "*"
- una sub lista usando "-"
+ otra sub lista
- otro elemento
El resultado es:
- una viñeta usando "*"
- una sub lista usando "-"
- otra sub lista
- otro elemento
- una sub lista usando "-"
Preformateado (ejemplos de código)
Para incluir fragmentos de texto preformateado, nunca podrá mezclarse con texto, finaliza el párrafo precedente con "::". El bloque preformateado terminará cuando el texto vuelva al mismo nivel de indentación que el párrafo anterior que no esté preformateado. Por ejemplo:
Un ejemplo::
Espacios en blanco, líneas nuevas, líneas en blanco, y todo tipo de marcas
(como *esta* o \esta) serán mantenidas por los bloques preformateados o literales.
Mira aquí, he incluido un nivel más de indentación (pero no muy lejos)
fin del ejemplo
El resultado es:
Un ejemplo:
Espacios en blanco, líneas nuevas, líneas en blanco, y todo tipo de marcas (como *esta* o \esta) serán mantenidas por los bloques preformateados o literales. Mira aquí, he incluido un nivel más de indentación (pero no muy lejos)
fin del ejemplo
Observa que si un párrafo consiste sólo en "::", entonces es borrado por la salida:
::
Esto es texto preformateado, y el
último párrafo "::" es borrado
El resultado es:
Esto es texto preformateado, y el último párrafo "::" es borrado
Secciones
Para dividir textos largos en secciones, debes usar cabeceras de sección. Estas son líneas individuales (una o más palabras con un adorno): un subrayado sólo, o un subrayado y una línea superpuesta juntos, con guiones "-----", símbolos de igual "=====", tildes "~~~~~" o cualquier caracter no alfanumérico = - ` : ' " ~ ^ _ * + # < > con el que te sientas cómodo. Un subrayado sólo es distinto a un subrayado y superpuesto usando el mismo carácter. El subrayado o el superposicionado debe ser al menos tan largo como el texto. Se consistente, todas las secciones marcadas con el mismo símbolo estarán situadas al mismo nivel:
Capítulo 1 Título ================= Sección 1.1 Título ------------------- Subsección 1.1.1 Título ~~~~~~~~~~~~~~~~~~~~~~~~ Sección 1.2 Título ------------------- Capítulo 2 Título =================
El resultado se muestra en la siguiente estructura, ilustrada para simplificar en un seudo XML:
<section>
<title>
Capítulo 1 Título
<section>
<title>
Sección 1.1 Título
<section>
<title>
Subsección 1.1.1 Título
<section>
<title>
Sección 1.2 Título
<section>
<title>
Capítulo 2 Título
(Seudo XML usa la indentación como muestra y no tiene tags finales. Es imposible mostrar la salida actual procesada, como en otros ejemplos, porque las secciones no pueden existir dentro de bloques. Para un ejemplo concreto, compara la estructura de las secciones de este documento en el texto fuente y procesa la salida)
Nota que las cabeceras de sección están disponibles como destinos de un link, sólo usando su nombre. Para vincular a la cabecera de las 'Listas', escribo "Listas_". Si la cabecera tiene espacios en ella como 'estilos de texto', necesitamos acotar la cabecera "`estilos de texto`_".
Hipervínculos
Hipervínculos con destinos explicitos
- Los hipervínculos explícitos tienen 2 partes; la etiqueta y el nombre del "objetivo" del enlace.
- Delimita la etiqueta del enlace rodeandolo de comillas simples inversas "`" y finalizalo con un subrayado "(`etiqueta`_)".
- Si no hay espacios en blanco ni signos de puntuación puedes finalizarlo con un subrayado y olvidar las comillas.
- (FIXME) Label of link regex representation (approx.): [^s]_|`.+`_
- El objetivo estará cumplido empezando por 2 '.', espacio en blanco, y un '_', la etiqueta del enlace, un ':' y un espacio en blanco (.. _label:).
- Los objetivos son neutrales al espacio en blanco y no distinguen entre mayúsculas y minúsculas.
- (FIXME) Target of link regex representation (approx.): ..w+_.+:w+
- Una vez que el objetivo es definido, lo está para todo el documento y puede ser ubicado en cualquier lugar del documento.
- Los objetivos deben ser separados por líneas en blanco de cualquier cosa que no sea un objetivo. Los objetivos pueden ser listados uno detrás de otro.
- Redefinir el objetivo dará un error
- Si un objetivo no tiene una dirección dada coge la del siguiente objetivo, permitinedo cambios (para abreviados y versiones largas, por ejemplo).
Ejemplos:
This sentence has simple link_ in it. .. _link: http://www.google.com./ This sentence has a `long link`_ in it. This one has a link that has an address that's the `same as the long link`_ . .. _same as the long link: .. _long link: http://makeashorterlink.com./ Remember, `link targets`_ are case-insensitive and whitespace-neutral. .. _LINK TARGETS: http://pythonowns.blogspot.com/
El resultado es:
This sentence has simple link in it.
This sentence has a long link in it. This one has a link that has an address that's the same as the long link .
Remember, link targets are case-insensitive and whitespace-neutral.
Hipervínculos con destinos implicitos
- Los hipervínculos implícitos no necesitan que sus objetivos se nombren como los hipervínculos explícitos.
- Los hipervínculos implícitos pueden definirse de 2 maneras, en línea y no en línea
- La etiqueta de un hipervínculo 'no en línea' está marcada como la etiqueta de un hipervínculo explícito excepto que '__' es usado en vez de '-'.
- Non-inline hyperlink regex representation (approx.): [^s]__|`.+`__
- El objetivo para un hipervínculo implícito no en línea se caracteriza por '..', espacio en blanco, '__:', y un espacio en blanco (.. __: ); el subrayado son 2 guiones bajos y un espacio en blanco (__ ).
- Non-inline target regex representation (approx.): __s+.+|..s+__:s+.+
- No es necesario tener definido el objetivo antes que el siguiente vínculo anónimo, se resuelven en orden
- La etiqueta de un hipervínculo 'en línea' tienen la forma `etiqueta <hipervínculo>`__ .
- Inline hyperlink regex representation (approx.): `.+s+<.+>`__
- Se cuiadadoso con los hipervínculo en línea porque pueden volverse muy largos.
- Cuando tengas errores sobre que tienes más vínculos que objetivos, trata de solucionarlo buscando __ y comprueba que esto significa que debe ser implícito y que si es en línea que el vínculo está escrito.
Por ejemplo
Here is an `implicit link`__ . .. __: http://www.python.org./ Shorthand target is used__ below. __ http://www.kbb.com/ This link has an `inlined <http://www.python.org./>`__ link. You do not need to have the link__ target before__ the next anonymous link. __ http://www.w3.org./ __ http://www.archive.org/
produce como resultado
Here is an implicit link .
Shorthand target is used below.
This link has an inlined link.
You do not need to have the link target before the next anonymous link.
Tablas
Observaciones a tener en cuenta.
- Aunque se centre el texto en la celda de la tabla, éste no se visualizará centrado, a no ser que sea el título, en este caso si surte efecto.
- Para hacer una lista enumerada no utilices sangrías, utiliza números o letras para los apartados y para los subapartados guiones "-"
1. Enumeramos de la siguiente manera - Los subapartados los ponemos con guiones, el método es: (espacio, guión, espacio). - Escriba el texto que desee. 2. La sintaxis para insertar una tabla sería: +-----------------------------------------------------------+ | **Control de versiones del manual de usuario de gvSIG** | +==========================+================================+ | |1. Se ha incluido la documen | | |tación sobre la nueva ventana | | |de salvar proyecto de gvSIG. | |Manual Usuario gvSIG 1.1 | | |Versión 4 |2. Se ha incluido documentación | | |sobre la herramienta de | | |exportar a ráster. | | | | | |3. Se ha dos errores conocidos: | | | | | | - Fallo en los resultados de | | | las funciones de agrupamien | | | to en el geoproceso disolver| | | - Error conocido de la herra | | | mienta "Exportar a raster" | +--------------------------+--------------------------------+
El resultado sería:
| Control de versiones del manual de usuario de gvSIG | |
|---|---|
| Manual Usuario gvSIG 1.1 Versión 4 | 1. Se ha incluido la documen tación sobre la nueva ventana de salvar proyecto de gvSIG. 2. Se ha incluido documentación sobre la herramienta de exportar a ráster. 3. Se han añadido dos errores conocidos:
|
Además de esta forma de crear tablas en ReStructuredText, existen otras basadas en directivas. En muchas ocasiones es mas cómodo trabajar con la forma de creación de tablas basada en la directiva list-table. Consulte esto en la siguiente sección.
