文档指南

QGIS Documentation is available at https://docs.qgis.org. As the writing process is going on, a build is automatically run every day (see bottom of the page for exact time) for all supported versions (testing, Long Term Release (LTR) and next-to-be LTR).

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 https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html or https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

以下章节将指导您学习：

• 如何使用`git <https://git-scm.com/>`_ 系统和储存文档的 GitHub 平台来管理文档源文件

• 如何修改文本，提供屏幕截图…依照规定的方式

• 如何共享并确保将您的修改推送到官方文档中。

如果您正在寻找有关如何为QGIS项目做出贡献的基本信息，您可以在 `参与QGIS社区 <https://qgis.org/en/site/getinvolved/index.html>`_中找到帮助。

• 1. A Step By Step Contribution
  • 1.1. Using the GitHub web interface
  • 1.2. Using Git command line tools
  • 1.3. Further reading
• 2. Writing Guidelines
  • 2.1. Writing Documentation
  • 2.2. Managing Screenshots
  • 2.3. Documenting Processing algorithms
• 3. 在 PyQGIS Cookbook 编写代码
  • 3.1. How to write testable code snippets
  • 3.2. How to test snippets on your local machine
• 4. 文档指南
  • 4.1. Translation process
  • 4.2. Translate a file
• 5. Substitutions
  • 5.1. Usage
  • 5.2. Common Substitutions
  • 5.3. Toolbar Button Icons
  • 5.4. Other basic icons
  • 5.5. 属性工作表
  • 5.6. Projections and Georeferencer
  • 5.7. Print Layout
  • 5.8. Layer Properties
  • 5.9. 插件