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.
Substituição¶
Pode por uma imagem dentro do texto ou adicionar um pseudônimo para usar em todo lado. Para usar uma imagem num parágrafo, apenas crie um pseudônimo em qualquer lado
.. |nice_logo| image:: /static/common/qgislogo.png
:width: 2 em
e chame-o para o seu parágrafo
my paragraph begins here with a nice logo |nice_logo|.
Aqui está um exemplo de como se tornou:
o meu parágrafo começa aqui com um logotipo bonito .
Í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¶
Aqui estão algumas dicas para criar novas, e bonitas capturas de tela. Para o guia de utilizador, elas vão para ./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)
não redimensione-os com um editor de imagem, o tamanho será definido se necessário dentro dos arquivos rst (a redução de dimensões sem ter uma correta resolução > fica feio)
cortar o fundo
Defina o tamanho da resolução para 135 dpi (desta forma, se o tamanho é definido para os arquivos rst, as imagens ficarão com o tamanho original em html e com uma boa resolução para o 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
você pode encontrar alguns preparados -projetos QGIS que foram usados antes para criar captura de telas em: file: ./qgis-projects. Isto torna mais fácil de reproduzir imagens para a próxima versão do QGIS. Estes projetos QGIS usam os dados de amostra que deve ser colocado na mesma pasta que do Repositorio Documentação-QGIS.
Use o seguinte comando para remover a função de menu global no Ubuntu para criar telas de aplicativos menores, pelos Menus.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt
Traduzir Capturas de Tela¶
Aqui estão algumas dicas para criar capturas de tela para o seu manual de utilizador traduzido. Eles irão para ./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)
usando o QGIS -projetos incluídos no repositório QGIS-Documentação (in: file:./qgis_projects ). Estes foram usados para produzir as capturas de telas “originais” do manual. O banco de amostra QGIS deve ser colocado na mesma pasta que o Repositorio Documentação-QGIS.
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
Documentando os Algoritmos de Processamento¶
Se você quer escrever a documentação para algoritmos de processamento considere estas diretrizes:
não sobrescrever arquivos de ajuda existente por arquivos de outras fontes (por exemplo, árvore de origem QGIS ou repositório de Ajuda-Processamento), estes arquivos têm formatos diferentes
Arquivos de ajuda do algoritmo de processamento fazem parte do Guia do Usuário QGIS, portanto, use mesma formatação do Guia do Usuário e outros documentos
evite usar “Este algoritmo faz isso e aquilo...” como primeira frase na descrição do algoritmo. Experimente usar palavras mais gerais como nos ajuda dos algoritmos TauDEM ou GRASS
se necessário, adicione imagens. Use o formato PNG e siga as linhas de orientações gerais para a documentação.
se necessário adicionar links para informações adicionais (por exemplo, publicações ou páginas web) para a seção “Veja também”
dar explicação clara para os parâmetros e saídas dos algoritmos (novamente GRASS e TauDEM são bons exemplos).
não editar nomes de parâmetro ou de saída. Se você encontrou erro de digitação ou ortografia errada — informar por erros e bugs, para que desenvolvedores possam corrigir isso também no código de processamento
não liste as opções disponíveis na descrição do algoritmo, opções já listadas no parâmetro de descrição.
não adicionar informações sobre o tipo de geometria vetor no algoritmo ou descrição do parâmetro sem razão convincente que essa informação está disponível na descrição do parâmetro