Guia da Documentação¶

Introdução¶

Estas são as linhas orientadoras sobre o uso geral do rst na documentação QGIS. A documentação será construída automaticamente no servidor 0, 8am, 4pm PDT (Pacific Daylight Time). O estado atual está disponível em http://docs.qgis.org.

Veja também: http://sphinx.pocoo.org/markup/inline.html ou o arquivo convention.rst .

No geral, quando criar documentação rst para o projeto QGIS, por favor siga a Linhas orientadoras da documentação do guia de estilo Python.

Usando os títulos¶

Ao adicionar novos títulos, deve usar os seguintes estilos para o capítulo, seção, subseção e miniseção.

títulos

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

Section
=======

Subsection
----------

Minisec
.......

Etiquetas embutidas¶

• Atalhos do teclado:

  :kbd:`ctrl B`

  irá mostrar Ctrl B

• Menu do GUI

  :menuselection:`menu --> submenu`

• Nome do arquivo

  :file:`README.rst`

• Ícone com um texto popup pertencente ao Ícone

  |icon| :sup:`popup_text`

  (veja image below).

• Janela e Título de Página

  :guilabel:`title`

• Texto do Utilizador

  ``label``
  

Notas de rodapé¶

Leve em conta: As notas de rodapé não são reconhecidas por nenhum software de tradução e também não é convertida para o formato pdf corretamente, Portanto, não utilize notas de rodapé dentro da documentação.

Isto é para a criação de notas de rodapé

blabla [1]_

Que irá apontar para:

[1]	Atualizações dos complementos do núcleo

Rótulo/referência¶

Isto é usado para criar uma referência em algum lado

.. _my_anchor:

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

Isto irá chamar a referência nesta mesma 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!)

Portanto referência 1 (my_anchor) e referência 2 Rótulo/referência

Como a referência é exibida muitas vezes com uma legenda completa, não há realmente a necessidade de usar uma seção de palavra

see :ref:`my_anchor`

Figura e imagem¶

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 é parecido como isto:

Figure Readme 1:

Uma legenda: Um logótipo que você goste

Use .. only:: html para fazer o número da figura (Figura Leia-me 1) vísivel nos arquivos html. Os scripts irão inserir um número automaticamente gerado antes da legenda da figura em pdf.

Para usar a legenda (veja Minha Legenda) apenas insira texto recuado após uma linha em branco no bloco da figura.

A referência da figura pode ser feita de duas formas primeiro usando o rótulo da etiqueta como aqui está

(see Figure_Readme_1_).

Irá mostrar uma âncora Figure_Readme_1. Pode fazer maiúsculas se quiser. Pode ser usado no mesmo documento .rst mas não em outros documentos .rst.

Nunca mais pode usar esta referência, porque em html a referência da legenda é perdida (refere-se se agora ao sítio antes da Figura Leia-me 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!

Tabelas¶

uma tabela simples

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

Use a \ seguido de espaço vazio ‘ ‘ para deixar espaços vazios.

Pode também usar tabelas mais complicadas desenhando-as usando as referências e muito mais

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

Windows	Mac OSX
e claro não esqueça

A minha tabela desenhada, lembre-se que não é infelizmente considerada uma legenda.

Pode referenciar como este 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¶

Existem muitas etiquetas de índice no RST. Para ser possível traduzir o índice, é necessário integrá-lo em texto normal. Nesse caso use esta síntaxe:

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

Se o termo não necessita de ser traduzido, por favor use esta sintaxe:

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

Adicione novas Capturas de Tela¶

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 tela (o mesmo SO, a mesma decoração, e o mesmo tamanho de letra)

• reduza a janela ao seu mínimo espaço necessário para mostrar o elemento ( levando todo a tela para uma janela pequena restrita > exagero)

• quanto menos confusão, melhor (não há necessidade de ativar todos 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)

• cortar o fundo

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

• salva-los como png (sem artefatos jpeg)

• a captura de tela deve mostrar o conteúdo de acordo com o que está 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

Traduzir Capturas de Tela¶

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 tela (o mesmo SO, a mesma decoração, e o mesmo tamanho 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.

• o mesmo tamanho como as capturas de telas ‘originais’ inglesas, caso contrário, elas serão esticadas e ficaram feias. Se necessitar de um tamanho diferente devido a strings ui longas, não esqueça de mudar a dimensão do código rst do seu idioma.

• reduza a janela ao seu mínimo espaço necessário para mostrar o elemento ( levando todo a tela para uma janela pequena restrita > exagero)

• quanto menos confusão, melhor (não há necessidade de ativar todos as barras de ferramentas)

• não redimensione-os com um editor de imagem, o tamanho será definido dentro dos arquivos rst (a redução de dimensões sem ter uma correta resolução > fica feio)

• cortar o fundo

• salva-los como png (sem artefatos jpeg)

• a captura de tela deve mostrar o conteúdo de acordo com o que está 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