Outdated version of the documentation. Find the latest one here.

Directrices de Documentación

Introducción

QGIS Documentation will be built automatically on the server at 0, 8am, 4pm PDT (Pacific Daylight Time). The current status is available at http://docs.qgis.org.

QGIS Documentation is mainly written using the reStructuredText (reST) format syntax, coupled with some scripts from the Sphinx toolset to post-process the HTML output. See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html or http://sphinx.pocoo.org/markup/inline.html.

In general, when creating rst documentation for the QGIS project, please follow the Python documentation style guidelines. Below are exposed some general guidelines to follow when using reST for the QGIS documentation writing.

If you are looking for general rules on contributing to QGIS project or managing repositories, you may find help at Get Involved in the QGIS Community.

Writing Documentation

Headlines

To each webpage of the documentation corresponds a .rst file.

Sections used to structure the text are identified through their title which is underlined (and overlined for the first level). Same level titles must use same character for underline adornment. In QGIS Documentation, you should use following styles for chapter, section, subsection and minisec.

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Subminisec
^^^^^^^^^^

Inline tags

You can use some tags inside the text to emphasize some items.

  • Menu gui: to mark a complete sequence of menu selections, including selecting submenus and choosing a specific operation, or any subsequence of such a sequence.

    :menuselection:`menu --> submenu`
  • Dialog and Tab title: Labels presented as part of an interactive user interface including window title, tab title and option labels.

    :guilabel:`title`
  • Button labels

    **[Apply]**
  • Nombre de archivo o directorio

    :file:`README.rst`
  • Icon with popup text belonging to Icon

    |icon| :sup:`popup_text`

    (ver `image`_debajo).

  • Atajos de teclado

    :kbd:`ctrl B`

    mostrará Ctrl B

  • Texto del usuario

    ``label``
    

Etiqueta/referencia

References are used to place anchors inside the text. It then helps you create and call hyperlinks between sections or page.

The example below creates the anchor of a section (e.g., Label/reference title)

.. _my_anchor:

Label/reference
---------------

To call the reference in the same page, use

see my_anchor_ for more information.

Que devolverá:

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.

Another way to jump to the same place from anywhere in the documentation is to use the :ref: role.

see :ref:`my_anchor` for more information.

which will display the caption instead (in this case the title of this section!):

see Etiqueta/referencia for more information.

So reference 1 (my_anchor) and reference 2 (Etiqueta/referencia). Because the reference often displays a full caption, there is not really the need to use the word section. Note that you can also use a custom caption to describe the reference

see :ref:`Label and reference <my_anchor>` for more information.

devolviendo:

see Label and reference for more information.

Figura e imagen

Imágenes

To insert an image, use

.. image:: /static/common/qgislogo.png
   :width: 10 em

which returns

../../_images/qgislogo.png

Reemplazo

You can put an image inside text or add an alias to use everywhere. To use an image inside a paragraph, just create an alias somewhere.

.. |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 convierte en:

mi parrafo inicia así con un agradable logo nice_logo.

Nota

Currently, to ensure consistency and help in the use of QGIS icons a list of alias is built and available in Sustituciones chapter.

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:

../../_images/qgislogo.png

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.

Referencing to the figure can be done using the reference label like this

(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.

You can not use the :ref: role for reference anymore, because in html the reference to the caption is lost (it now refers to the place before 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

Para crear una tabla simple

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

Use una \ seguida de un espacio para dejar un espacio vacío.

You can also use more complicated tables by drawing them using references and all

.. _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
win osx

y por supuesto no olviden nix

Mi tabla dibujada, que conste esta es, por desgracia, no se considera una leyenda

Puede referirse a ella así my_drawn_table_1.

Í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, ...

Notas al pie

Please note: Footnotes are not recognized by any translation software and it is also not converted to pdf format properly. So, if possible don’t use footnotes within any documentation.

Esto es para crear una nota de pie

blabla [1]_

Que apuntará a:

[1]

Actualizaciones de complementos núcleo

Manejar Capturas de Pantalla

Adicionar nuevas Capturas de Pantalla

Aquí algunos concejos para crear nuevo, agradable captura de pantallas. Para la guía de usuario entre a ./resources/en/user_manual/

  • same environment for all the screen caps (same OS, same decoration, same font size). We have used Ubuntu with Unity and the default “ambience” theme. For screenshots of QGIS main window and composer we have set it to show menus on the window (not the default in unity).
  • reduce the window to the minimal space needed to show the feature (taking the all screen for a small modal window > overkill)
  • cuanto menos desorden, mejor (no necesita activar todas la barras de herramientas)

  • don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
  • cortar el fondo

  • Set print size resolution to 135 dpi, eg in Gimp set the print resolution (image > print size) and save. This way, if no size is set in the rst files, images will be at original size in html and at a good print resolution in the PDF. You can use ImageMagick convert command to do a batch of images:
convert -units PixelsPerInch input.png -density 135 output.png
  • guárdelos en png (sin artefactos jpeg)

  • la captura de pantalla debe mostrar el contenido acorde a lo que se describe en el texto

  • you can find some prepared QGIS-projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS Sample Data (aka Alaska Dataset), which should be placed in the same folder as the QGIS-Documentation Repository.
  • Utilice el comando siguiente para quitar la función del menú global en Ubuntu para crear pantallas de la aplicación más pequeños con el menú.

sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

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)

  • use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample Data (aka Alaska Dataset) should be placed in the same folder as the QGIS-Documentation Repository.
  • 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.

  • reduce the window to the minimal space needed to show the feature (taking all the screen for a small modal window > overkill)
  • cuanto menos desorden, mejor (no necesita activar todas la barras de herramientas)

  • don’t resize them in an image editor, the size will be set into the rst files (downscaling the dimensions without properly upping the resolution > ugly)
  • cortar el fondo

  • guárdelos en png (sin artefactos jpeg)

  • la captura de pantalla debe mostrar el contenido acorde a lo que se describe en el texto

Documentando algoritmos de Procesamiento

Si desea escribir documentación para algoritmos de Procesamiento considere estas directrices:

  • don’t overwrite existing help files by files from other sources (e.g. QGIS source tree or Processing-Help repository), this files have different formats
  • Los archivos de ayuda de algoritmos de procesamiento son parte de la Guía de Usuario de QGIS, a fin de utilizar el mismo formato como la Guía de Usuario y otra documentación

  • Evitar utilizar “Este algoritmo hace esto y eso...” como primer frase en una descripción de algoritmo. Tratar de utilizar palabras más generales como en la ayuda de los algoritmos de TauDEM o GRASS

  • añadir imágenes si son necesarias. Usar formato PNG y seguir las directrices para la documentación.

  • si es necesario añadir enlaces para información adicional (por ejemplo, publicaciones o paginas web) para la sección “Ver también”

  • dar una explicación clara para los parámetros del algoritmo y las salidas (de nuevo GRASS y TauDEM son buenos ejemplos).

  • no editar parámetros o nombres de salida. Si encontró error de tipografía o mala tipografía — informar de ello en bugracker, para que los desarrolladores puedan arreglar esto en el código de procesamiento.

  • don’t list available options in algorithm description, options already listed in parameter description.
  • don’t add information vector geometry type in algorithm or parameter description without compelling reason as this information already available in parameter description