Important

Translation is a community effort you can join. This page is currently translated at 61.11%.

19. Anexă: Contribuții La Acest Manual

To add materials to this course, you must follow the guidelines in this Appendix. You are not allowed to alter the conditions in this Appendix except for clarification. This is to ensure that the quality and consistency of this manual can be maintained.

19.1. Descărcare resurse.

Sursa acestui document se poate găsi la GitHub. Consultați GitHub.com pentru instrucțiunile de folosire a sistemului de versionare git.

19.2. Formatul Manualului

Acest manual este scris folosind Sphinx, un generator de documente Python, care folosește limbajul de marcare `reStructuredText <https://docutils.sourceforge.io/rst.html >`_ . Instrucțiuni despre cum să utilizați aceste instrumente sunt disponibile pe respectivele site-uri.

19.3. Adăugarea unui Modul

To add a new module:

  1. First create a new directory (directly under the top-level of the qgis-training-manual directory) with the name of the new module.

  2. Under this new directory, create a file called index.rst. Leave this file blank for now.

  3. Open the index.rst file under the top-level directory. Its first lines are:

    .. toctree::
   :maxdepth: 2

   foreword/index
   introduction/index

You will note that this is a list of directory names, followed by the name index. This directs the top-level index file to the index files in each directory. The order in which they are listed determines the order they will have in the document.

  1. Add the name of your new module (i.e., the name you gave the new directory), followed by /index, to this list, wherever you want your module to appear.

  2. Amintiți-vă să mențineți ordinea modulelor logice, astfel încât modulele ulterioare se construiesc pe cunoștințele prezentate în modulele anterioare.

  3. Open your new module’s own index file (module_name/index.rst).

  4. Along the top of the page, create the module heading:

    1. write a first line of asterisks (*).

    2. Follow this with a line containing the markup phrase Module:, followed by the name of your module.

    3. End this off with another line of same number of asterisks.

    Notă

    The underline and the overline should not be shorter than the line containing the module title.

  5. Lăsați o linie deschisă după aceasta.

  6. Scrieți un scurt paragraf, explicând scopul și conținutul modulului.

  7. Lăsați o linie deschisă, apoi adăugați următorul text:

    .. toctree::
   :maxdepth: 2

   lesson1
   lesson2

    … where lesson1, lesson2, etc., are the names of your planned lessons.

Fișierul index la nivel de modul va arăta astfel:

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. Adăugarea unei Lecții

Pentru a adăuga o lecție pentru un modul nou sau existent:

  1. Deschideți directorul modulului

  2. Open the index.rst file (created above in the case of new modules).

  3. Ensure that the name of the planned lesson is listed underneath the toctree directive, as shown above.

  4. Creați un nou fișier în directorul modulul.

  5. Name this file exactly the same as the name you provided in the module’s index.rst file, and add the extension .rst.

Notă

For editing purposes, a .rst file works exactly like a normal text file (.txt).

  1. To begin writing the lesson, write the markup phrase Lesson, followed by the lesson name.

  2. In the next line, write a line of equal signs (=), not shorter than the lesson title.

  3. Lăsați o linie deschisă după aceasta.

  4. Scrieți o scurtă descriere asupra scopului lecției.

  5. Includeți o introducere generală în subiect. Parcurgeți lecțiile existente în acest manual, pentru exemple.

  6. Sub aceasta, începeți un nou alineat, începând cu această frază:

    **The goal for this lesson:**

  7. Explicați pe scurt rezultatul intenționat al completării acestei lecții.

  8. În cazul în care obiectivul lecției nu se poate descrie într-una sau două propoziții, luați în considerare împărțirea subiectului în mai multe lecții.

Fiecare lecție va fi împărțită în mai multe secțiuni, care vor fi abordate în continuare.

19.5. Adăugarea unei Secțiuni

Există două tipuri de secțiuni: „procedați în mod similar” și „încercați singuri”.

  • O secțiune de „urmărire” reprezintă un set detaliat de instrucțiuni, menite să învețe cititorul cum să folosească un anumit aspect din QGIS. Acest lucru se face, de obicei, oferind instrucțiuni clic cu clic, cât mai clar posibil, intercalate cu capturi de ecran.

  • A „try yourself” section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer box beneath, which will show or explain how to complete the assignment, and will show the expected outcome if possible.

Every section comes with a difficulty level. An easy section is denoted by ★☆☆, moderate by ★★☆, and advanced by ★★★.

19.5.1. Adăugați o secțiune „procedați în mod similar”

  1. Pentru a începe această secțiune, scrieți fraza de marcare a nivelului de dificultate intenționat (după cum se arată mai sus).

  2. Leave a space and then write Follow Along:.

  3. Lăsați un alt spațiu și scrieți numele secțiunii (folosiți doar o literă mare, precum și majuscule pentru substantive proprii).

  4. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  5. Scrieți o scurtă introducere a secțiunii, explicându-i scopul. Apoi oferiți instrucțiuni detaliate (clic-după-clic) privind procedura care trebuie demonstrată.

  6. În fiecare secțiune, includeți link-uri interne, link-uri externe și capturi de ecran după cum este necesar.

  7. Încercați să terminați fiecare secțiune cu un scurt paragraf, care să se încheie și să conducă în mod natural la secțiunea următoare, dacă este posibil.

19.5.2. Adăugați o secțiune „încercați singuri”

  1. Pentru a începe această secțiune, scrieți fraza de marcare a nivelului de dificultate intenționat (după cum se arată mai sus).

  2. Leave a space and then write Try Yourself:.

  3. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  4. Explicați exercițiul pe care doriți ca cititorul să-l finalizeze. Consultați secțiunile anterioare, lecțiile sau modulele, dacă este necesar.

  5. Includeți capturi de ecran pentru a clarifica cerințele, în cazul în care o descriere textuală simplă nu este de ajuns.

In most cases, you will want to provide an answer regarding how to complete the assignment given in this section. To do so, you will need to create and feed an answer block beneath the instructions.

  1. First, create the custom collapsible widget that contains the answer:

    .. admonition:: Answer
   :class: dropdown

  2. Keeping an indentation with regard to the above block, write the instructions on how to complete the assignment, using links and images where needed.

19.6. Adăugarea unei Concluzii

To end a lesson:

  1. Write the phrase In Conclusion, followed by a new line of minuses/dashes (-).

  2. Write a conclusion for the lesson, explaining which concepts have been covered in the lesson.

19.7. Adăugarea unei Secțiuni de Lecturi suplimentare

Această secțiune este opțională.

  • Write the phrase Further Reading, followed by a new line of minuses/dashes (-).

  • Includeți trimiteri către site-urile externe corespunzătoare.

19.8. Adăugarea Secțiunii „Ce Urmează”

  1. Write the phrase What's Next?, followed by a new line of minuses/dashes (-).

  2. Explicați modul în care a pregătit această lecție studenții pentru lecția sau modulul următor.

  3. Nu uitați să schimbați secțiunea „ce urmează” din lecția anterioară, dacă este necesar, astfel încât să se refere la noua dvs. lecție. Acest lucru va fi necesar dacă ați introdus o nouă lecție printre lecțiile existente sau după o lecție existentă.

19.9. Utilizarea Marcajelor

Pentru a adera la standardele acestui document, va trebui să adăugați marcajul standard textului dvs.

19.9.1. Noi concepte

If you are explaining a new concept, you will need to write the new concept’s name in italics by enclosing it in asterisks (*).

This sample text shows how to introduce a *new concept*.

19.9.2. Atenție specială

  • To emphasize a crucial term which is not a new concept, write the term in bold by enclosing it in double asterisks (**).

  • Folosiți-le cu moderație! Dacă utilizați prea multe, cititorul ar putea avea impresia că strigați sau ca aveți un aer de superioritate.

This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**

19.9.3. Imagini

  • When adding an image, save it to an img folder next to the lesson file.

  • Includeți-l în document, în felul următor:

    .. figure:: img/image_file.extension
   :align: center

  • Nu uitați să lăsați o linie, deasupra și dedesubtul marcajului imaginii.

19.9.6. Utilizați text monospațiat

  • When you are writing text that the user needs to enter, a path name, or the name of a database element such as a table or column name, you must write it in monospaced text. For example:

    Enter the following path in the text box: ``path/to/file``.

19.9.7. Etichetarea elementelor GUI

  • Dacă vă referiți la un element GUI, cum ar fi un buton, trebuie să scrieți numele acestuia în formatul etichetei GUI. De exemplu:

    To access this tool, click on the :guilabel:`Tool Name` button.

  • Acest lucru se aplică, de asemenea, dacă menționați numele unui instrument fără a cere utilizatorului să efectueze clic pe un buton.

19.9.9. Adăugarea notelor

  • You might need to add a note in the text, which explains extra details that can’t easily be made part of the flow of the lesson. This is the markup:

    [Normal paragraph.]

.. note:: Note text.
  New line within note.

  New paragraph within note.

[Unindented text resumes normal paragraph.]

19.9.10. Adăugarea o notă de sponsorizare/drepturi de autor

Dacă scrieți un nou modul, o lecție sau o secțiune în numele unui sponsor, trebuie să includă un scurt mesaj, la alegerea sponsorului. Acesta trebuie să informeze cititorul despre numele sponsorului și trebuie să apară sub titlul modulului, lecției sau secțiunii sponsorizate. Totuși, mesajul nu poate consta într-o reclamă pentru compania sponsorului.

If you have volunteered to write a module, lesson or section in your own capacity, and not on behalf of a sponsor, you may include an authorship note below the heading of the module, lesson or section that you authored. This must take the form This [module/lesson/section] contributed by [author name]. Do not add further text, contact details, etc. Such details are to be added in the „Contributors” section of the Foreword, along with the name(s) of the part(s) you added. If you only made enhancements, corrections and/or additions, list yourself as an editor.

19.10. Mulțumiri!

Vă mulțumim pentru contribuția la acest proiect! Procedând astfel, faceți QGIS mai accesibil pentru utilizatori și adăugați valoare întregului proiect QGIS.