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:
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 |
 |
 |
și, desigur, să nu uităm de |
|
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.
Î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 .
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¶
Iată câteva sfaturi pentru a crea noi capturi de ecran, aspectuoase. Pentru a ghida utilizatorii, ele vor intra în ./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)
nu le redimensionați într-un editor de imagine, dimensiunea stabilindu-se în fișierele rst, dacă este necesar (reducerea dimensiunilor fără creșterea, în mod corespunzător, a rezoluției > urât)
tăiați fundalul
Setați rezoluția dimensiunii de imprimare la 135 dpi (în acest fel, în cazul în care nici o dimensiune nu este stabilită în fișierele rst, imaginile vor fi la dimensiunea originală în html, și la o rezoluție bună de imprimare în format 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
puteți găsi unele proiecte QGIS care au fost utilizate pentru crearea capturilor de ecran în ./qgis-projects. Acest lucru face mai ușoară reproducerea capturilor de ecran pentru următoarea versiune de QGIS. Aceste proiecte folosesc setul de date eșantion QGIS, care ar trebui să fie plasat în același folder cu Depozitul Documentației QGIS.
Utilizați următoarea comandă pentru a elimina funcția de meniu global în Ubuntu, pentru a crea ecrane mai mici, cu meniuri, ale aplicației.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt
Traduceți capturile de ecran¶
Iată câteva sfaturi pentru a crea capturi de ecran pentru ghidul de utilizare tradus. Ele vor intra în ./resources/<limba dumneavoastră>/user_manual/
același mediu pentru toate capturile de ecran (același sistem de operare, același decor, aceeași mărime de font)
utilizați proiectele QGIS incluse în Depozitul Documentației QGIS (din ./qgis_projects). Acestea au fost utilizate pentru a produce capturile de ecran ‘originale’ din manual. Setul de date eșantion al QGIS ar trebui să fie plasat în același folder cu Depozitul Documentației QGIS.
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
Documentarea Algoritmilor de Procesare¶
Dacă doriți să scrieți documentație pentru Algoritmii de procesare țineți cont de aceste indicații:
nu suprascrieți fișierele de asistență existente cu fișiere din alte surse (de exemplu din arborele sursă al QGIS sau din depozitul Processing), aceste fișiere având formate diferite
Fișierele de asistență ale algoritmului Processing sunt parte a Ghidului Utilizatorului QGIS, așa că folosesc aceeași formatare ca Ghidul de Utilizare și ca alte documentații
evitați utilizarea expresiilor de genul “Acest algoritm face cutare și cutare...” ca primă frază din descrierea algoritmului. Încercați să utilizați cuvinte mai generale, ca acelea din fișierele de asistență ale algoritmilor TauDEM sau GRASS
adăugați imagini dacă este necesar. Folosiți formatul PNG și urmați liniile directoare generale ale documentației.
dacă este necesar adăugați trimiteri către informații suplimentare (cum ar fi publicații sau pagini web), în secțiunea “Vedeți, de asemenea”
dați explicații clare pentru parametrii și rezultatele algoritmilor (din nou GRASS și TauDEM sunt bune exemple)
nu modificați numele parametrilor sau al ieșirilor. Dacă ați găsit greșeli de ortografie — raportați-le în bugracker, astfel încât dezvoltatorii să poată depana și codul Processing
nu listați opțiunile disponibile în descrierea algoritmului, opțiunile fiind deja menționate în descrierea parametrului.
nu adăugați, fără un motiv întemeiat, informații despre tipul geometriilor vectoriale în descrierea algoritmului, deoarece aceste informații sunt deja disponibile în descrierea parametrului