Pautas de Documentación¶

Introducción¶

Estas son as pautas de uso xeral do rst na documentación do QGIS. A documentación xérase automaticamente no servidor ás 0, 8am e 4pm PDT (fuso horario do Pacífico). O estado actual pódese consultar en http://docs.qgis.org.

Ver tamén: http://sphinx.pocoo.org/markup/inline.html ou o arquivo convention.rst.

En xeral, ó xerar a documentación rst para o proxecto QGIS, fai o favor de seguir a guía de estilo da documentación Python.

Emprego de encabezados¶

Engadir un novo encabezado, débense empregar os seguintes estilos para capítulo, sección, subsección e minisección.

Encabezados

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

Section
=======

Subsection
----------

Minisec
.......

Etiquetas acordadas¶

• Atallos de teclado:

  :kbd:`ctrl B`

  amosa Ctrl B

• Menú do GUI

  :menuselection:`menu --> submenu`

• Nome de arquivo

  :file:`README.rst`

• Icona con texto despregable que pertence a Icona

  |icon| :sup:`popup_text`

  (ver image below).

• Diálogo e título de Etiqueta

  :guilabel:`title`

• Texto de usuario

  ``label``
  

Notas ó pé¶

Por favor fíxese: As notas ó pé non son recoñecidas por ningún software de tradución e tampouco son convertidas a formato pdf correctamente. Por eso, non se empregan notas ó pé en ningunha documentación.

Isto é para crear unha nota ó pé.

blabla [1]_

Que sinalará a:

[1]	Actualizacións dos plugins do núcleo

Etiquetal/referencia¶

Isto é empregado para crear unha referencia en algures

.. _my_anchor:

Label/reference
===============

Isto chamará á referencia na mesma páxina

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!)

Polo tanto referencia 1 (my_anchor) e referencia 2 Etiquetal/referencia

Debido a que a referencia soe amosar unha lenda completa, realmente non é preciso empregar a sección palabra

see :ref:`my_anchor`

Figura e imaxe¶

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

O resultado verase así:

Figure Readme 1:

Unha lenda: un logo que guste

Emprega .. only:: html para poñer o número da figura (Figura Léame 1) visible so nos arquivos html. Os scripts insertarán automáticamente o número xerado antes da lenda da figura no pdf.

Para empregar unha lenda (ver My caption) so hai que introducir texto con sangría despois dunha liña baleira no bloque da figura.

As referencias a figuras pódense facer de dúas formas empregando primeiro unha etiqueta de referencia como esta

(see Figure_Readme_1_).

Isto amosará a áncora Figure_Readme_1. Pódense empregar maiúsculas se se quere. Poden empregarse no mesmo documento rst pero non en outros documentos .rst.

Non se pode seguir empregando esta referencia porque no html a referencia á lenda perdeuse (agora refírese ó 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!

Táboas¶

unha táboa simple

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

Emprega unha \ seguida dun espazo baleiro ‘ ‘ para deixar un espazo baleiro.

Tamén se poden empregar táboas máis complicadas dibuxándoas con referencias e moito máis

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

O resultado:

Fiestras	Mac OSX
e por suposto non esquecer

A miña táboa debuxada, lembre que desafortunadamente non é considerada unha lenda

Pódese referenciar así my_drawn_table_1.

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

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

my paragraph begins here with a nice logo |nice_logo|.

Índice¶

Existen varias etiquetas de índice no RST. Para ser capaz de traducir o índice, é necesario integralo no texto normal. Neste caso utilice esta sintaxe:

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

Se o termo non ten traducción, por favor emprega esta sintaxe:

.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...

Engadir nova Captura de pantalla¶

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

• o mesmo ambiente para todas as capturas de pantalla (mesmo OS, mesma decoración, mesmo tamaño de letra)

• reduza a fiestra ó mínimo espazo necesario para amosar o elemento (tomando toda a pantalla nunha pequena fiestra > exceso)

• canto menos confuso, mellor (non hai necesidade de activar todas as barras de ferramentas)

• 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)

• recortar o fondo

• Set print size resolution to 135 dpi (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)

• gardala en png (sen artifactos jpeg)

• a captura de pantalla deberá amosar un contido acorde o descrito no 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 dataset which should be placed in the same folder as the QGIS-Documentation Repository.
• Use the following command to remove the global menu function in Ubuntu to create smaller application screens with menu’s.

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

Traducción das capturas de pantalla¶

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

• o mesmo ambiente para todas as capturas de pantalla (mesmo OS, mesma decoración, mesmo 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 dataset should be placed in the same folder as the QGIS-Documentation Repository.

• mesmo tamaño que as capturas de pantalla ‘orixinais’ en inglés, doutro xeito estiraránse e verase feo. Se fora preciso cambialo tamaño debido a cadeas ui moi longas, non olvides cambiar as dimensións no código rst da túa linguaxe.

• reduza a fiestra ó mínimo espazo necesario para amosar o elemento (tomando toda a pantalla nunha pequena fiestra > exceso)

• canto menos confuso, mellor (non hai necesidade de activar todas as barras de ferramentas)

• non cambialo tamaño cun editor de imaxe, o tamaño será establecido no arquivo rst (a redución do tamaño sen unha resolución apropiada > vese feo)

• recortar o fondo

• gardala en png (sen artifactos jpeg)

• a captura de pantalla deberá amosar un contido acorde o descrito no texto

Documenting Processing algorithms¶

If you want to write documentation for Processing algorithms consider this guidelines:

• 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
• Processing algorithm help files are part of QGIS User Guide, so use same formatting as User Guide and other documentation
• avoid use “This algoritm does this and that...” as first sentence in algorithm description. Try to use more general words like in TauDEM or GRASS algoritms help
• add images if needed. Use PNG format and follow general guidelines for documentation.
• if necessary add links to additional information (e.g. publications or web-pages) to the “See also” section
• give clear explanation for algorithm parameters and outputs (again GRASS and TauDEM are good examples).
• don’t edit parameter or output names. If you found typo or wrong spelling — report this in bugracker, so developers can fix this in Processing code too
• 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