Ghidul Documentației¶

Titluri¶

Fiecărei pagini web îi corespunde un fișier .rst.

Secțiunile utilizate pentru structurarea textului sunt identificate printr-un titlu, care este subliniat (și supraliniat pentru primul nivel). Titlurile de același nivel trebuie să folosească caractere identice pentru subliniere. În Documentația QGIS, ar trebui să utilizați următoarele stiluri pentru capitol, secțiune, subsecțiune și minisecțiune.

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

Section
=======

Subsection
----------

Minisec
.......

Subminisec
^^^^^^^^^^

Inline tags¶

Puteți utiliza anumite etichete în interiorul textului, pentru a evidenția unele elemente.

• Menu gui: to mark a complete sequence of menu selections, including selecting submenus and choosing a specific operation, or any subsequence of such a sequence.

  :menuselection:`menu --> submenu`
  

• Dialog and Tab title: Labels presented as part of an interactive user interface including window title, tab title and option labels.

  :guilabel:`title`
  

• Button labels

  **[Apply]**
  

• Numele de fișier sau directorul

  :file:`README.rst`
  

• Pictogramă cu fereastră de tip balon, care aparține pictogramei

  |icon| :sup:`popup_text`
  

  (vedeți imaginea de mai jos).

• Shorcut keyboard

  :kbd:`ctrl B`
  

  will show Ctrl B

• Text specific utilizatorului

  ``label``
  

Etichetă/referință¶

Referințele sunt folosite pentru a plasa ancore în interiorul textului. Vă ajută, de asemenea, să creați și să apelați referințele dintre secțiuni sau pagini.

Exemplul de mai jos creează ancora unei secțiuni (ex.: titlul Etichetei/referinței)

.. _my_anchor:

Label/reference
---------------

Pentru a apela referința din aceeași pagină, folosiți

see my_anchor_ for more information.

ceea ce va returna:

vedeți my_anchor pentru mai multe informații.

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.

O altă modalitate de a sări în același loc de oriunde din documentație este de a utiliza rolul :ref:.

see :ref:`my_anchor` for more information.

care va afișa titlul în loc (în acest caz, titlul acestei secțiuni!):

vedeți Etichetă/referință pentru mai multe informații.

Deci, referința 1 (my_anchor) și referința 2 (Etichetă/referință). Deoarece referința adesea afișează un titlu complet, nu există cu adevărat nevoie să utilizăm cuvântul section. Rețineți că puteți utiliza un titlu personalizat pentru a descrie referința

see :ref:`Label and reference <my_anchor>` for more information.

returnează:

vedeți Eticheta și referința pentru mai multe informații.

Figure and image¶

Imagini¶

Pentru a insera o imagine, utilizați

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

ceea ce returnează

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

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

Figuri¶

.. _figure_logo:

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

   A caption: A logo I like

Rezultatul arată în felul următor:

Un text explicativ: Un logo care-mi place

To avoid possible conflict with another references, always begin figures anchor with _figure_ and prefer using terms that can easily refer to the figure caption. While only the centered alignment is mandatory for the image, feel free to use any other options for figure (such as width, height, scale...) if needed.

The scripts will insert an automatical generated number before the caption of the figure in pdf.

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

Trimiterea către figură se poate face utilizând etichete de referință ca aceasta

(see Figure_logo_).

It will show the anchor Figure_logo. You can use uppercase if you want. It can be used in the same .rst document but not in others. You can still use the :ref: role for reference from other files, but keep in mind that this returns the full caption of the image.

see :ref:`figure_logo`

returnează:

vedeți ref:figure_logo

Tabele¶

Pentru a crea o simplă 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 referințe

.. _my_drawn_table:

+---------------+--------------------+
| Windows       | macOS              |
+---------------+--------------------+
| |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_.

Rezultatul:

Windows	macOS
și, desigur, să nu uităm de

My drawn table, mind you this is unfortunately not regarded a caption

Puteți să-l referențiați la fel ca în my_drawn_table.

Index¶

Un index reprezintă o metodă utilă care facilitează cititorului găsirea cu ușurință a unei informații într-un document. Documentația QGIS furnizează câțiva indicatori esențiali. Există puține reguli de urmat pentru a păstra un set de indicatori care sunt cu adevărat folositori (coerenți, consecvenți și cu adevărat corelați între ei):

• Index should be human readable, understandable and translatable; an index can be made from many words but you should avoid any unneeded _, -... characters to link them i.e., Loading layers instead of loading_layers or loadingLayers.
• Always capitalize only the first letter of the index unless the word has a particular spelling, in which case keep using its spelling e.g., Loading layers, Atlas generation, WMS, pgsql2shp
• Keep an eye on the existing Index list in order to reuse the most convenient expression with the right spelling and avoid wrong duplicates.

Several index tags exist in RST. You can either use the inline :index: tag within the normal text.

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

Or you can use the .. index:: block-level markup which links to the beginning of the next paragraph. Because of the rules mentioned above, it’s advised to use this latter tag as it’s easier to fulfill them.

.. index:: WMS, WFS, Loading layers

It’s also recommanded to use index parameters such as single, pair, see... in order to build a more structured and interconnected table of index. See http://www.sphinx-doc.org/en/stable/markup/misc.html#index-generating-markup for more information on index creation.

Comentarii Speciale¶

Sometimes, you may want to emphasize some points of the description, either to warn, remind or give some hints to the user. In QGIS Documentation, we use reST special directives such as .. warning::, .. note:: and .. tip:: generating particular frames that highlight your comments. See http://www.sphinx-doc.org/en/stable/markup/para.html#paragraph-level-markup for more information. A clear and appropriate title is required for both warnings and tips.

.. tip:: **Always use a meaningful title for tips**

 Begin tips with a title that summarizes what it is about. This helps
 users to quickly overview the message you want to give them, and
 decide on its relevance.

Code snippets¶

You may also want to give examples and insert a code snippet. In this case, write the comment below a line with the :: directive inserted. However, for a better rendering, especially to apply color highlighting to code according to its language, use the code-block directive, e.g. .. code-block:: xml. By default, Python code snippets do not need this reST directive. More details at http://www.sphinx-doc.org/en/stable/markup/code.html.

Note de subsol¶

Rețineți: Notele de subsol nu sunt recunoscute de către orice software de traducere și, de asemenea, nu sunt convertite în format pdf într-un mod corespunzător. De aceea, puteți renunța la folosirea notelor de subsol în documentație.

This is for creating a footnote

blabla [1]_

Care va indica:

[1]	Actualizări ale plugin-urilor de bază

Adăugarea noilor capturi de ecran¶

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

• same environment for all the screen caps (same OS, same decoration, same font size). We have used Ubuntu with Unity and the default “ambience” theme. For screenshots of QGIS main window and composer we have set it to show menus on the window (not the default in unity).
• reduce the window to the minimal space needed to show the feature (taking the all screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• 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)
• cut the background
• make the top corners transparent if the background is not white
• Set print size resolution to 135 dpi (e.g. in Gimp set the print resolution image ‣ print size and save). This way, images will be at original size in html and at a good print resolution in the PDF. You can also use ImageMagick convert command to do a batch of images

convert -units PixelsPerInch input.png -density 135 output.png

• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the 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 Data (aka Alaska Dataset), which should be placed in the same folder as the QGIS-Documentation Repository.

• 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

Traducerea Capturilor de Ecran¶

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

• same environment for all the screen caps (same OS, same decoration, same font size)
• 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 Data (aka Alaska Dataset) should be placed in the same folder as the QGIS-Documentation Repository.
• same size as the english ‘original’ screenshots, otherwise they will be stretched and look ugly. If you need to have a different size due to longer ui strings, don’t forget to change the dimension in the rst code of your language.
• reduce the window to the minimal space needed to show the feature (taking all the screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• don’t resize them in an image editor, the size will be set into the rst files (downscaling the dimensions without properly upping the resolution > ugly)
• cut the background
• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the text