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

20. Anexă: Contribuții La Acest Manual

Pentru a adăuga material în acest curs este necesar de urmărit ghidul din anexă. Nu aveți voie să alterați condițiile din Anexă dar puteți extinde cu clarificări. Acest lucru este necesar pentru siguranța calității și consistenței acestui manual.

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

20.2. Formatul Manualului

Acest manual este scris folosind Sphinx, un generator de documente Python care folosește limbajul cu marcaje reStructuredText. Instrucțiuni privind modul de utilizare a acestor instrumente sunt disponibile pe site-urile corespunzătoare.

20.3. Adăugarea unui Modul

  • Pentru a adăuga un nou modul, mai întâi creați un nou director (direct sub nivelul superior al directorului qgis-training-manual) având numele noului modul.

  • În cadrul acestui nou director, creați un fișier denumit index.rst. Lăsați acest fișier gol pentru moment.

  • Deschideți fișierul index.rst de sub directorul de nivel superior. Primele linii sunt:

    .. toctree::
       :maxdepth: 2
    
    
       foreword/index
       introduction/index

Rețineți că aceasta este o listă a numelor de directoare, urmată de denumirea index. Ea direcționează fișierul index de nivel superior spre fișierele index din fiecare director. Ordinea în care sunt listate determină ordinea pe care o vor avea în document.

  • Adăugați numele noului modul (adică, numele dat noului director), urmat de /index, în această listă, ori de câte ori doriți să apară modulul.

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

  • Deschideți propriul fișier index al noului modul ([module name]/index.rst).

  • În partea de sus a paginii, adăugați o linie de 80 de asteriscuri (*). Aceasta reprezintă un antet de modul.

  • Follow this with a line containing the markup phrase |MOD| (which stands for “module”), followed by the name of your module.

  • Încheiați cu o altă linie de 80 de asteriscuri.

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

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

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

    .. toctree::
       :maxdepth: 2
    
    
       lesson1
       lesson2

    ... unde lesson1, lesson2, etc., sunt numele lecțiilor planificate.

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

*******************************************************************************
|MOD| Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2


   lesson1
   lesson2

20.4. Adăugarea unei Lecții

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

  • Deschideți directorul modulului

  • Deschideți fișierul index.rst (creat mai sus, în cazul noilor module).

  • Asigurați-vă că numele lecției planificate este listat sub directiva toctree, așa cum se arată mai sus.

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

  • Folosiți pentru acest fișier exact același nume pe care l-ați specificat în fișierul modulului index.rst, appoi adăugați extensia .rst.

Note

În scopuri de editare, un fișier .rst funcționează exact ca un fișier text obișnuit (.txt).

  • Pentru a începe scrierea lecției, scrieți fraza de marcare |LS|, urmată de numele lecției.

  • În următoarea linie, adăugați 80 de semne egal (=).

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

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

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

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

    **The goal for this lesson:**
  • Explicați pe scurt rezultatul intenționat al completării acestei lecții.

  • Î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.

20.5. Adăugarea unei Secțiuni

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

  • A “follow along” section is a detailed set of directions intended to teach the reader how to use a given aspect of QGIS. This is typically done by giving click-by-click directions as clearly as possible, interspersed with screenshots.
  • A “try yourself” section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer sheet at the end of the documentation, 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 |basic|, moderate by |moderate|, and advanced by |hard|.

20.5.1. Adăugați o secțiune “procedați în mod similar”

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

  • Lăsați un spațiu și apoi scrieți |FA| (pentru “procedați în mod similar”).

  • 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).

  • În linia următoare, introduceți 80 de minusuri/liniuțe (-). Asigurați-vă că editorul de text nu înlocuiește caracterul implicit pentru minus/liniuță, cu o linie mai lungă sau un alt caracter.

  • 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ă.

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

  • Î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.

20.5.2. Adăugați o secțiune “încercați singuri”

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

  • Lăsați un spațiu și apoi scrieți |TY| (pentru “încercați singuri”).

  • În linia următoare, introduceți 80 de minusuri/liniuțe (-). Asigurați-vă că editorul de text nu înlocuiește caracterul implicit pentru minus/liniuță, cu o linie mai lungă sau un alt caracter.

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

  • 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 add an entry in the answer sheet.

  • First, decide on a unique name for the answer. Ideally, this name will include the name of the lesson and an incrementing number.

  • Creați o legătură pentru acest răspuns:

    :ref:`Check your results <answer-name>`
  • Deschideți pagina răspunsului (answers/answers.rst).

  • Creați o legătură către secțiunea “încercați singuri”, prin scrierea acestei linii:

    .. _answer-name:
  • Scrieți instrucțiunile despre modul de completare a sarcinii, folosind link-uri și imagini acolo unde este nevoie.

  • Pentru a încheia, includeți o legătură către secțiunea “încercați singuri”, prin scrierea acestei linii:

    :ref:`Back to text <backlink-answer-name>`
  • Pentru a face această linie să funcționeze, includeți linia următoare deasupra antetului secțiunii “încercați singuri”:

    .. _backlink-answer-name:

Remember that each of these lines shown above must have a blank line above and below it, otherwise it could cause errors while creating the document.

20.6. Adăugarea unei Concluzii

  • To end a lesson, write the phrase |IC| for “in conclusion”, followed by a new line of 80 minuses/dashes (-). Write a conclusion for the lesson, explaining which concepts have been covered in the lesson.

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

  • Această secțiune este opțională.

  • Folosiți acronimul FR în loc de “lecturi suplimentare”, urmat de o linie nouă cu 80 de minusuri/liniuțe (-).

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

20.8. Adăugarea Secțiunii “Ce Urmează”

  • Folosiți acronimul |WN| pentru “ce urmează”, urmat de o linie nouă cu 80 de minusuri/liniuțe (-).

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

  • Remember to change the “what’s next” section of the previous lesson if necessary, so that it refers to your new lesson. This will be necessary if you have inserted a new lesson among existing lessons, or after an existing lesson.

20.9. Utilizarea Marcajelor

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

20.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*.

20.9.2. Atenție specială

  • Pentru a evidenția un termen esențial, care nu reprezintă un concept nou, scrieți termenul cu caractere aldine, încadrându-l între asteriscuri duble (**).

  • 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.**

20.9.3. Imagini

  • Când adăugați o imagine, salvați-o în folderul _static/lesson_name/.

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

    .. image:: /static/training_manual/lesson_name/image_file.extension
       :align: center
  • Nu uitați să lăsați o linie, deasupra și dedesubtul marcajului imaginii.

20.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: :kbd:`path/to/file`.

20.9.7. Etichetarea elementelor GUI

  • If you are referring to a GUI item, such as a button, you must write its name in the GUI label format. For example:

    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.

20.9.9. Adăugarea notelor

  • Este posibil să vă trebuiască introducerea unui text sub formă de notă, în care să oferiți detalii suplimentare care nu reies cu ușurință din fluxul lecției. Acesta este marcajul:

    [Normal paragraph.]
    
    .. note:: Note text.
       New line within note.
    
       New paragraph within note.
    
    [Unindented text resumes normal paragraph.]

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

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