Dokumentációs irányelvek

A QGIS dokumentációja automatikusan frissül a szerveren minden 0, 8 és 16 órakor (USA/Csendes-óceáni idő, UTC -08:00). Az aktuális állapot elérhető a https://docs.qgis.org címen.

A QGIS dokumentáció forrása GitHubon található: https://github.com/qgis/QGIS-Documentation. Nagyrészt reStructuredText (reST) szintaxissal íródott, kiegészítve néhány szkripttel a Sphinx eszközkészletből a HTML kimenet utófeldolgozása érdekében. Ezekkel az eszközökkel kapcsolatos általános információkért lásd http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html és https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

A következő fejezetek elmagyarázzák:

• hogyan kell kezelni a dokumentáció forrásfájljait a git rendszerrel a GitHub platformon, ahol tárolva vannak.

• hogyan kell szövegeket módosítani, képernyőmentéseket készíteni… a megfelelő módon

• hogyan lehet a módosításokat megosztani, hogy bekerüljenek a hivatalos dokumentációba.

Ha arról keres általános információt, hogy hogyan közreműködhet a QGIS projektben, ahhoz a Legyen tagja a QGIS közösségnek oldalon talál segítséget.

• 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. Writing code in the PyQGIS Cookbook
  • 3.1. How to write testable code snippets
  • 3.2. How to test snippets on your local machine
• 4. Fordítási irányelvek
  • 4.1. A fordítás folyamata
  • 4.2. Egy fájl fordítása
• 5. Helyettesítések
  • 5.1. Usage
  • 5.2. Common Substitutions
  • 5.3. Toolbar Button Icons
  • 5.4. Other basic icons
  • 5.5. Attribute Table
  • 5.6. Projections and Georeferencer
  • 5.7. Print Layout
  • 5.8. Layer Properties
  • 5.9. Modulok