Важно

Prevod je zajednički napor :ref:`možete se pridružiti `. Ova stranica je trenutno prevedena na |napredak prevođenja|.

19. Dodatak: Doprinos ovom priručniku

Da biste dodali materijale u ovaj kurs, morate se pridržavati smernica iz ovog dodatka. Nije vam dozvoljeno da menjate uslove iz ovog dodatka, osim radi pojašnjenja. Time se obezbeđuje da se kvalitet i doslednost ovog priručnika mogu održati.

19.1. Preuzimanje resursa

Izvor ovog dokumenta dostupan je na GitHub-u. Uputstva za korišćenje sistema za kontrolu verzija git potražite na GitHub.com.

19.2. Format priručnika

Ovaj priručnik napisan je pomoću alata Sphinx, generatora dokumenata u Pythonu koji koristi jezik za obeležavanje reStructuredText. Uputstva za korišćenje ovih alata dostupna su na njihovim sajtovima.

19.3. Dodavanje modula

Da biste dodali novi modul:

  1. Prvo napravite novi direktorijum (direktno u korenu direktorijuma qgis-training-manual) sa nazivom novog modula.

  2. U tom novom direktorijumu napravite datoteku pod nazivom index.rst. Za sada je ostavite praznu.

  3. Otvorite datoteku index.rst u korenom direktorijumu. Njeni prvi redovi su:

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

Primetićete da je ovo lista naziva direktorijuma, praćena nazivom index. Time se korena indeksna datoteka usmerava ka indeksnim datotekama u svakom direktorijumu. Redosled kojim su navedeni određuje njihov redosled u dokumentu.

  1. Dodajte naziv svog novog modula (tj. naziv koji ste dali novom direktorijumu), praćen sa /index, u ovu listu, na mesto gde želite da se vaš modul pojavi.

  2. Ne zaboravite da redosled modula bude logičan, tako da se kasniji moduli nadovezuju na znanje izloženo u ranijim modulima.

  3. Otvorite indeksnu datoteku svog novog modula (module_name/index.rst).

  4. Na vrhu stranice napravite naslov modula:

    1. napišite prvi red zvezdica (*).

    2. Zatim napišite red koji sadrži oznaku Module:, praćenu nazivom vašeg modula.

    3. Završite to još jednim redom sa istim brojem zvezdica.

    Белешка

    Podvučeni i nadvučeni red ne smeju biti kraći od reda koji sadrži naslov modula.

  5. Ostavite jedan prazan red ispod ovoga.

  6. Napišite kratak pasus koji objašnjava svrhu i sadržaj modula.

  7. Ostavite jedan prazan red, a zatim dodajte sledeći tekst:

    .. toctree::
       :maxdepth: 2
    
       lesson1
       lesson2
    

    … gde su lesson1, lesson2 itd. nazivi vaših planiranih lekcija.

Indeksna datoteka na nivou modula izgledaće ovako:

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

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. Dodavanje lekcije

Da biste dodali lekciju u novi ili postojeći modul:

  1. Otvorite direktorijum modula.

  2. Otvorite datoteku index.rst (napravljenu gore u slučaju novih modula).

  3. Uverite se da je naziv planirane lekcije naveden ispod direktive toctree, kao što je prikazano gore.

  4. Napravite novu datoteku u direktorijumu modula.

  5. Nazovite ovu datoteku tačno isto kao naziv koji ste naveli u datoteci index.rst modula i dodajte ekstenziju .rst.

Белешка

Za potrebe uređivanja, datoteka .rst funkcioniše potpuno isto kao obična tekstualna datoteka (.txt).

  1. Da biste počeli da pišete lekciju, napišite oznaku Lesson, praćenu nazivom lekcije.

  2. U sledećem redu napišite red znakova jednakosti (=), ne kraći od naslova lekcije.

  3. Ostavite jedan prazan red nakon ovoga.

  4. Napišite kratak opis namene lekcije.

  5. Uključite opšti uvod u temu. Za primere pogledajte postojeće lekcije u ovom priručniku.

  6. Ispod ovoga započnite novi pasus, koji počinje ovom frazom:

    **The goal for this lesson:**
    
  7. Ukratko objasnite željeni ishod ove lekcije.

  8. Ako ne možete da opišete cilj lekcije u jednoj ili dve rečenice, razmislite o deljenju teme na više lekcija.

Svaka lekcija biće podeljena na više odeljaka, o čemu je reč u nastavku.

19.5. Dodavanje odeljka

Postoje dve vrste odeljaka: „prati korake“ i „probajte sami“.

  • Odeljak „prati korake“ je detaljan skup uputstava namenjen da čitaoca nauči kako da koristi određeni deo QGIS-a. To se obično radi davanjem uputstava klik po klik, što jasnije moguće, propraćenih snimcima ekrana.

  • Odeljak „probajte sami“ daje čitaocu kratak zadatak da ga sam uradi. Obično je povezan sa unosom u polju sa odgovorom ispod, koje pokazuje ili objašnjava kako zadatak da se uradi i, ako je moguće, prikazuje očekivani ishod.

Svaki odeljak ima nivo težine. Lak odeljak označava se sa ★☆☆, srednji sa ★★☆, a napredni sa ★★★.

19.5.1. Dodavanje odeljka „prati korake“

  1. Da biste započeli ovaj odeljak, napišite oznaku željenog nivoa težine (kao što je prikazano gore).

  2. Ostavite razmak, a zatim napišite Follow Along:.

  3. Ostavite još jedan razmak i napišite naziv odeljka (koristite veliko slovo samo na početku, kao i za vlastite imenice).

  4. U sledećem redu napišite red crtica (-), ne kraći od naslova odeljka.

  5. Napišite kratak uvod u odeljak, objašnjavajući njegovu svrhu. Zatim dajte detaljna uputstva (klik po klik) o postupku koji se prikazuje.

  6. U svakom odeljku uključite interne veze, spoljne veze i snimke ekrana po potrebi.

  7. Pokušajte da svaki odeljak završite kratkim pasusom koji ga zaokružuje i prirodno vodi ka sledećem odeljku, ako je moguće.

19.5.2. Dodavanje odeljka „probajte sami“

  1. Da biste započeli ovaj odeljak, napišite oznaku željenog nivoa težine (kao što je prikazano gore).

  2. Ostavite razmak, a zatim napišite Try Yourself:.

  3. U sledećem redu napišite red crtica (-), ne kraći od naslova odeljka.

  4. Objasnite vežbu koju želite da čitalac uradi. Uputite na prethodne odeljke, lekcije ili module ako je potrebno.

  5. Uključite snimke ekrana da biste razjasnili zahteve ako običan tekstualni opis nije dovoljno jasan.

U većini slučajeva želećete da date odgovor o tome kako da se uradi zadatak dat u ovom odeljku. Za to ćete morati da napravite i popunite blok sa odgovorom ispod uputstava.

  1. Prvo napravite prilagođeni sklopivi vidžet koji sadrži odgovor:

    .. admonition:: Answer
       :class: dropdown
    
  2. Zadržavajući uvlačenje u odnosu na gornji blok, napišite uputstva o tome kako da se zadatak uradi, koristeći veze i slike po potrebi.

19.6. Dodavanje zaključka

Da biste završili lekciju:

  1. Napišite frazu In Conclusion, praćenu novim redom crtica (-).

  2. Napišite zaključak lekcije, objašnjavajući koji su pojmovi obrađeni u lekciji.

19.7. Dodavanje odeljka za dalje čitanje

Ovaj odeljak je opcion.

  • Napišite frazu Further Reading, praćenu novim redom crtica (-).

  • Uključite veze ka odgovarajućim spoljnim sajtovima.

19.8. Dodavanje odeljka „Šta je sledeće“

  1. Napišite frazu What's Next?, praćenu novim redom crtica (-).

  2. Objasnite kako je ova lekcija pripremila polaznike za sledeću lekciju ili modul.

  3. Ne zaboravite da po potrebi izmenite odeljak „šta je sledeće“ prethodne lekcije, tako da upućuje na vašu novu lekciju. To će biti potrebno ako ste umetnuli novu lekciju među postojeće lekcije ili posle postojeće lekcije.

19.9. Korišćenje oznaka

Da biste se pridržavali standarda ovog dokumenta, moraćete da svom tekstu dodate standardne oznake.

19.9.1. Novi pojmovi

Ako objašnjavate novi pojam, naziv tog novog pojma morate napisati kurzivom, tako što ćete ga staviti između zvezdica (*).

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

19.9.2. Isticanje

  • Da biste istakli ključni termin koji nije novi pojam, napišite termin podebljano tako što ćete ga staviti između dvostrukih zvezdica (**).

  • Koristite ovo štedljivo! Ako se koristi previše, čitaocu može delovati da vičete ili da ste snishodljivi.

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

  • Kada dodajete sliku, sačuvajte je u folder img pored datoteke lekcije.

  • Uključite je u dokument ovako:

    .. figure:: img/image_file.extension
       :align: center
    
  • Ne zaboravite da ostavite prazan red iznad i ispod oznake za sliku.

19.9.6. Korišćenje teksta sa fiksnom širinom znakova

  • Kada pišete tekst koji korisnik treba da unese, naziv putanje ili naziv elementa baze podataka kao što je naziv tabele ili kolone, morate ga napisati kao tekst sa fiksnom širinom znakova. Na primer:

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

19.9.7. Označavanje stavki grafičkog okruženja

  • Ako upućujete na stavku grafičkog okruženja, kao što je dugme, njen naziv morate napisati u formatu za oznake grafičkog okruženja. Na primer:

    To access this tool, click on the :guilabel:`Tool Name` button.
    
  • Ovo važi i ako pominjete naziv alatke, a da od korisnika ne tražite da klikne na dugme.

19.9.9. Dodavanje napomena

  • Možda ćete morati da u tekst dodate napomenu koja objašnjava dodatne detalje koje nije lako uklopiti u tok lekcije. Ovo je oznaka:

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

19.9.10. Dodavanje napomene o sponzorstvu/autorstvu

Ako pišete novi modul, lekciju ili odeljak u ime sponzora, morate uključiti kratku sponzorsku poruku po njihovom izboru. Ona mora obavestiti čitaoca o nazivu sponzora i mora se pojaviti ispod naslova modula, lekcije ili odeljka koji su sponzorisali. Međutim, ne sme biti reklama za njihovu kompaniju.

Ako ste se dobrovoljno prijavili da napišete modul, lekciju ili odeljak u svoje ime, a ne u ime sponzora, možete uključiti napomenu o autorstvu ispod naslova modula, lekcije ili odeljka koji ste napisali. Ona mora biti u obliku This [module/lesson/section] contributed by [author name]. Ne dodajte dodatni tekst, kontakt podatke i sl. Takvi podaci dodaju se u odeljak „Contributors“ u Predgovoru, zajedno sa nazivima delova koje ste dodali. Ako ste napravili samo poboljšanja, ispravke i/ili dopune, navedite se kao urednik.

19.10. Hvala vam!

Hvala vam što doprinosite ovom projektu! Time činite QGIS pristupačnijim korisnicima i dodajete vrednost celom QGIS projektu.