Guia de Orientação da Documentação

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

QGIS Documentation source files are available at https://github.com/qgis/QGIS-Documentation. They are mainly written using the reStructuredText (reST) format syntax, coupled with some scripts from the Sphinx toolset to post-process the HTML output. For general information on these tools, see http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html or https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

The following chapters will guide you through learning:

• how to manage the documentation source files using git system and the GitHub platform on which they are stored

• how to modify the texts, provide screenshots… in a compliant way

• how to share and ensure your modifications are pushed to the official docs.

If you are looking for general information about how to contribute to the QGIS project, you may find help at Get Involved in the QGIS Community.

• 1. Uma contribuição passo a passo
  • 1.1. Using the GitHub web interface
  • 1.2. Using Git command line tools
  • 1.3. Outras leituras
• 2. Writing Guidelines
  • 2.1. Escrevendo documentação
  • 2.2. Managing Screenshots
  • 2.3. Documentando os algoritmos do Processamento
• 3. Escrita de código em PyQGIS Cookbook
  • 3.1. Como escrever <i>snippets</i> de código de teste
  • 3.2. Como testar <i>snippets</i> na sua máquina local
• 4. Orientações para a Tradução
  • 4.1. Processo de tradução
  • 4.2. Traduzir um ficheiro
• 5. Substituições
  • 5.1. Utilização
  • 5.2. Substituições comuns
  • 5.3. Ícones de botões da barra de ferramentas
  • 5.4. Outros ícones básicos
  • 5.5. Tabela de Atributos
  • 5.6. Projecções e Georeferenciação
  • 5.7. Print Layout
  • 5.8. Layer Properties
  • 5.9. Módulos