Pautas de la documentación¶
Introducción¶
Hay pautas acerca del uso general de rst en la documentación de QGIS . La documentación se elaborará automáticamente en el servidor a las 0, 8 am, 4 am PDT (Pacific Daylight Time). El estado actual de la documentación está disponible en htt://docs.qgis.org.
Vea también: http://sphinx.pocoo.org/markup/inline.html o el archivo convertion.rst
En general, cuando cree la documentación en rst para el proyecto QGIS, por favor siga las Guías de estilo para la documentación en Python.
Uso de encabezados¶
Al añadir nuevos encabezados debe usar los siguiente estilos para el capítulo, sección, subsección y minisección.
encabezados
********
Chapter
********
Section
=======
Subsection
----------
Minisec
.......
Etiquetas en línea¶
Atajos de teclado:
:kbd:`ctrl B`
mostrará Ctrl B
Interfaz de usuario del menú
:menuselection:`menu --> submenu`
Nombre de archivo
:file:`README.rst`
Icono con texto emergente que pertenece a icono
|icon| :sup:`popup_text`
(ver `image`_siguiente).
Título del diálogo y la pestaña
:guilabel:`title`
Texto del usuario
``label``
Notas al pie¶
Por favor, tenga en cuenta: las notas al pie no son reconocidas por cualquier software de traducción y además no son convertidas a formato pdf de forma adecuada. De tal forma que no use notas al pie en ninguna documentación.
Esto es para crear una nota
blabla [1]_
Que apuntará a:
[1] Actualizaciones de los complementos del núcleo
Etiqueta/referencia¶
Esto se utiliza para crear una referencia en algún lugar
.. _my_anchor:
Label/reference
===============
Esto llamará a la referencia en la misma página
see my_anchor_ for more information. Notice how it will jump to
the following line/thing following the 'anchor'.
Normally to declare this label you do not need to use apastroph's but
you do need to use empty lines before and after the anchor. If you use
:ref:`my_anchor` it will display the caption instead
(In this case the title of this section!)
Por lo tanto, la referencia 1 (my_anchor) y referencia 2 Etiqueta/referencia
Dado que la referencia a menudo muestra una leyenda completa, en realidad no hay necesidad de usar la sección palabra
see :ref:`my_anchor`
Figura e imagen¶
Figura
.. _figure_readme_1:
.. only:: html
**Figure Readme 1:**
.. figure:: /static/common/qgislogo.png
:width: 20 em
:align: center
A caption: A logo I like
El resultado se ve así:
Figure Readme 1:
Un título: un logo que me gusta
Usar .. only:: html para hacer el numero de la figura (Figura renombrada 1) visible, solo en archivos html. Los scripts insertarán un numero generado automaticamente antes del subtítulo de la figura en pdf.
Para utilizar un subtitulo (ver mi leyenda) basta con insertar un texto después de un renglón en blanco en el bloque de la figura.
Hacer referencia a las figuras puede realizarse de dos maneras, primero usando la etiqueta de referencia de esta forma
(see Figure_Readme_1_).
Mostrará el ancla Figure_Readme_1. Puede usar mayúsculas si quiere. Se puede utilizar en el mismo documento .rst pero no en otros documentos .rst.
Ya no se puede usar la referencia de esta forma, porque en html la referencia al subtitulo se pierde (ahora se refiere al lugar antes de Figure Readme 1:
see :ref:`figure_readme_1`, does not work due to the lost reference to
the caption of the figure, this is not a 'bug' but a choice we made!
Tablas¶
una tabla simple
======= ======= =======
x y z
======= ======= =======
1 2 3
2 4
======= ======= =======
Use una \ seguida de un espacio ‘ ‘ para dejar un espacio vacío.
También puede usar tablas más dibujándolas usando referencias y todo
.. _my_drawn_table_1:
+---------------+--------------------+
| Windows | Mac OSX |
+---------------+--------------------+
| |win| | |osx| |
+---------------+--------------------+
| and of course not to forget |nix| |
+------------------------------------+
My drawn table, mind you this is unfortunately not regarded a caption
You can reference to it like this my_drawn_table_1_.
El resultado:
| Windows | Mac OSX |
 |
 |
y por supuesto no olviden |
|
Mi tabla dibujada, que conste esta es, por desgracia, no se considera una leyenda
Puede referirse a ella así my_drawn_table_1.
Reemplazo¶
Puede poner una imagen dentro del texto o agregar un alias para usar en todas partes. Para usar una imagen dentro de un párrafo, simplemente cree un alias en alguna parte
.. |nice_logo| image:: /static/common/qgislogo.png
:width: 2 em
y llámelo en su párrafo
my paragraph begins here with a nice logo |nice_logo|.
Así es como este ejemplo se conviene en:
mi parrafo inicia así con un agradable logo .
Índice¶
Existen varias etiquetas de índices en RST. Para poder traducir el índice, es necesario integrarlo dentro del texto normal. En este caso use esta sintaxis:
QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...
Si el término no tiene que ser traducido, por favor use esta sintaxis:
.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...
Agregar nuevas capturas de pantalla¶
Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/
mismo entorno para todas las capturas de pantalla (mismo SO, misma decoración, mismo tamaño de letra)
reduzca la ventana al tamaño mínimo necesario para mostrar la característica (usar toda la pantalla para una pequeña ventana modal > exageración)
cuanto menos saturado mejor (no necesita activar todas las barras de herramientas)
no cambiarles el tamaño en un editor de imágenes, el tamaño será ajustado en los archivos rst, si es necesario (reducir las dimensiones sin subir correctamente la resolución > feo)
cortar el fondo
Establezca la resolución del tamaño de impresión a 135 dpi (de esta manera, si no se establece un tamaño en los archivos de RST, las imágenes estarán en tamaño original en html y con una buena resolución de impresión en el PDF)
guárdelas en png (sin artefactos jpeg)
la captura de pantalla debe mostrar el contenido acorde a lo que se describe en el texto
Traducir capturas de pantalla¶
Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/
mismo entorno para todas las capturas de pantalla (mismo SO, misma decoración, mismo tamaño de letra)
mismo tamaño que la captura ‘original’ en inglés, de lo contrario serán estiradas y se verán mal. Si necesita tener un tamaño diferente debido a cadenas de la IU más largas, no olvide cambiar las dimensiones en el código rst de su idioma.
reduzca la ventana al tamaño mínimo necesario para mostrar la característica (usar toda la pantalla para una pequeña ventana modal > exageración)
cuanto menos saturado mejor (no necesita activar todas las barras de herramientas)
no cambiarles el tamaño en un editor de imágenes, el tamaño se ajustará en los archivos RST (reducir las dimensiones sin subir correctamente la resolución > feo)
cortar el fondo
guárdelas en png (sin artefactos jpeg)
la captura de pantalla debe mostrar el contenido acorde a lo que se describe en el texto