Diretrizes de 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.

Os arquivos de origem da documetação do QGIS estão disponíveis em https://github.com/qgis/QGIS-Documentation. Eles são escritos principalmente no formato reStructuredText (reST), juntamente com alguns scripts do conjunto de ferramentas Sphinx para pós-processar a saída HTML. Para obter informações gerais sobre essas ferramentas, consulte https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html ou https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

The following chapters will guide you through learning:

• como gerenciar os arquivos de origem da documentação usando o sistema git e a plataforma GitHub em que estão armazenados

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

• como compartilhar e garantir que suas modificações sejam enviadas às documentações oficiais.

Se você estiver procurando informações gerais sobre como contribuir para o projeto QGIS, poderá encontrar ajuda em Participe da comunidade QGIS.

• 1. Uma Contribuição Passo a Passo
  • 1.1. Usando a interface web do GitHub
  • 1.2. Usando as ferramentas de linha de comando Git
  • 1.3. Leituras adicionais
• 2. Orientações para Escrita
  • 2.1. Escrevendo Documentação
  • 2.2. Gerenciando Capturas de Tela
  • 2.3. Documentando os Algoritmos de Processamento
• 3.  Escrevendo código no Livro de Receitas do PyQGIS
  • 3.1. Como escrever trechos de código testáveis
  • 3.2. Como testar trechos em sua máquina local
• 4. Orientações de Tradução
  • 4.1. Processo de tradução
  • 4.2. Traduzir um arquivo
• 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. Projeções e Georreferenciamento
  • 5.7. Layout de impressão
  • 5.8. Propriedades da Camada
  • 5.9. Plugins