Outdated version of the documentation. Find the latest one here.

Ghidul Documentației

Introducere

Acestea sunt liniile generale cu privire la utilizarea rst în documentația QGIS. Documentația se va construi în mod automat pe server la orele 0, 8am, 4pm PDT (Pacific Daylight Time). Starea curentă se poate observa la http://docs.qgis.org.

Vedeți, de asemenea, fișierul: http://sphinx.pocoo.org/markup/inline.html or convention.rst file.

În general, atunci când se creează documentația rst pentru proiectul QGIS, vă rugăm să urmați Liniile generale ale stilului documentației Python.

Folosirea titlurilor

La adăugarea noilor titluri, ar trebui să folosiți următoarele stiluri pentru capitol, secțiune, subsecțiune și minisecțiune.

titluri

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Etichete interioare

  • Combinații de taste:

    :kbd:`ctrl B`

    va arăta Ctrl B

  • Meniul GUI

    :menuselection:`menu --> submenu`
  • Nume de fișier

    :file:`README.rst`
  • Pictogramă cu text de tip pop-up

    |icon| :sup:`popup_text`

    (vedeți image de mai jos).

  • Titlu pentru Dialog și pentru Tab

    :guilabel:`title`
  • Textul utilizatorului

    ``label``
    

Note de subsol

Vă rugăm să rețineți: Notele de subsol nu sunt recunoscute de către orice software de traducere și, de asemenea, nu este convertit în format pdf într-un mod corespunzător. Deci, puteți să nu folosiți note de subsol în documentație.

Aceasta va crea o notă de subsol

blabla [1]_

Care va indica:

[1]

Actualizări ale plugin-urilor de bază

Etichetă/trimitere

În acest mod se va crea o referință undeva

.. _my_anchor:

Label/reference
===============

Astfel ce va apela referința din aceeași pagină

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!)

Deci, referința 1 (my_anchor) și referința 2 Etichetă/trimitere

Deoarece referința adesea afișează un titlu complet, nu există într-adevăr necesitatea de a utiliza titlul secțiunii

see :ref:`my_anchor`

Figura și imaginea

Figură

.. _figure_readme_1:

.. only:: html

   **Figure Readme 1:**

.. figure:: /static/common/qgislogo.png
   :width: 20 em
   :align: center

   A caption: A logo I like

Rezultatul arată în felul următor:

Figure Readme 1:

../../_images/qgislogo.png

Un text explicativ: Un logo care-mi place

Utilizați .. only:: html pentru a face vizibil numai în fișierele html numărul figurii (Figure Readme 1) . Script-urile vor introduce un număr generat automat înainte de textul explicativ al figurii din pdf.

Pentru a utiliza un text explicativ (vedeți Textul explicativ) doar inserați text indentat după o linie vidă, în blocul figurii.

Trimiterea către figură se poate face în două moduri, primul utilizând etichetei de referință ca aceasta

(see Figure_Readme_1_).

Așa va arăta ancora Figure_Readme_1. Puteți folosi majuscule, dacă doriți. Se poate utiliza în interiorul aceluiași document :filer:`rst`, dar nu și în alte documente .rst.

Nu mai puteți folosi referințe ca aceasta, pentru că în html se pierde trimiterea către textul explicativ (acum se referă la locul dinaintea Figure Readme 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!

Tabele

un simplu tabel

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

Utilizați \ urmat de un spațiu vid ‘ ‘ pentru a lăsa un spațiu gol.

Puteți folosi, de asemenea, tabele mai complicate prin desenarea lor folosind refențe și toate

.. _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_.

Rezultatul:

Windows Mac OSX
win osx

și, desigur, să nu uităm de nix

Tabela mea, tineți minte acest lucru, nu este considerată, din păcate, o legendă

Puteți să o referențiați în acest mod my_drawn_table_1.

Imagini

Imagine

.. image:: /static/common/qgislogo.png
   :width: 10 em

Înlocuire

Puteți include o imagine în text sau să adăugați un alias pentru utilizare generală. Pentru a utiliza o imagine într-un paragraf, doar creați un alias oriunde

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

și apelați-l în punctul dvs.

my paragraph begins here with a nice logo |nice_logo|.

Iată cum va arăta acest exemplu:

punctul meu începe aici cu un logo frumos nice_logo.

Index

Mai multe taguri index există în RST. Pentru a traduce indexul, este necesar să-l integrați în textul normal. În acest caz, utilizați această sintaxă:

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

În cazul în care termenul nu trebuie să fie tradus, vă rugăm să utilizați această sintaxă:

.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...

Adăugați noi capturi de ecran

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

  • același mediu pentru toate capturile de ecran (același sistem de operare, același decor, aceeași mărime de font)

  • reduceți fereastra la spațiul minim necesar pentru a afișa entitatea (folosirea întregului ecran pentru o mică fereastră modală > nejustificată)

  • mai puțină dezordine, cu atât mai bine (nu este nevoie să activați toate barele de instrumente)

  • don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
  • tăiați fundalul

  • Set print size resolution to 135 dpi (this way, if no size is set in the rst files, images will be at original size in html and at a good print resolution in the PDF)
  • salvați-le ca png (artefacte jpeg)

  • captura de ecran ar trebui să arate conținutul, în conformitate cu ceea ce este descris în text

  • you can find some prepared QGIS -projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS sample dataset which should be placed in the same folder as the QGIS-Documentation Repository.
  • Use the following command to remove the global menu function in Ubuntu to create smaller application screens with menu’s.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

Traduceți capturile de ecran

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

  • același mediu pentru toate capturile de ecran (același sistem de operare, același decor, aceeași mărime de font)

  • use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample dataset should be placed in the same folder as the QGIS-Documentation Repository.
  • aceeași dimensiune ca și capturile ‘originale’ în limba engleză, în caz contrar acestea vor fi întinse și vor arăta urât. Dacă trebuie să aveți o dimensiune diferită datorită unor lungi șiruri de caractere ui, nu uitați să schimbați dimensiunea în codul rst al limbii dvs.

  • reduceți fereastra la spațiul minim necesar pentru a afișa entitatea (folosirea întregului ecran pentru o mică fereastră modală > nejustificată)

  • mai puțină dezordine, cu atât mai bine (nu este nevoie să activați toate barele de instrumente)

  • nu le redimensionați într-un editor de imagine, dimensiunea stabilindu-se în fișierele rst (reducerea dimensiunilor fără creșterea, în mod corespunzător, a rezoluției > urât)

  • tăiați fundalul

  • salvați-le ca png (artefacte jpeg)

  • captura de ecran ar trebui să arate conținutul, în conformitate cu ceea ce este descris în text

Documenting Processing algorithms

If you want to write documentation for Processing algorithms consider this guidelines:

  • don’t overwrite existing help files by files from other sources (e.g. QGIS source tree or Processing-Help repository), this files have different formats
  • Processing algorithm help files are part of QGIS User Guide, so use same formatting as User Guide and other documentation
  • avoid use “This algoritm does this and that...” as first sentence in algorithm description. Try to use more general words like in TauDEM or GRASS algoritms help
  • add images if needed. Use PNG format and follow general guidelines for documentation.
  • if necessary add links to additional information (e.g. publications or web-pages) to the “See also” section
  • give clear explanation for algorithm parameters and outputs (again GRASS and TauDEM are good examples).
  • don’t edit parameter or output names. If you found typo or wrong spelling — report this in bugracker, so developers can fix this in Processing code too
  • don’t list available options in algorithm description, options already listed in parameter description.
  • don’t add information vector geometry type in algorithm or parameter description without compelling reason as this information already available in parameter description