19. Appendix: Bijdragen aan deze handleiding
U moet de richtlijnen in deze Appendix volgen om materiaal aan deze cursus toe te voegen. U wordt geacht de voorwaarden in deze Appendix niet te wijzigen, uitgezonderd om te verduidelijken. Dat is om er voor te zorgen dat de kwaliteit en consistentie van deze handleiding kunnen worden onderhouden.
19.1. Bronnen downloaden
De bron van dit document is beschikbaar op GitHub. Consulteer GitHub.com voor instructies over hoe het versiebeheerssysteem GIT te gebruiken.
19.2. Indeling handleiding
Deze handleiding is geschreven met behulp van Sphinx, een Python documentgenerator door middel van de opmaaktaal reStructuredText . Instructies over hoe deze gereedschappen te gebruiken zijn beschikbaar op hun respectievelijke sites.
19.3. Een module toevoegen
Maak eerst een nieuwe map (direct onder het bovenste niveau van de map qgis-training-manual) met de naam voor de nieuwe module om een nieuwe module toe te voegen.
Maak, onder deze nieuwe map, een bestand genaamd index.rst. Laat dit voor nu blanco.
Open het bestand index.rst in de map van het bovenste niveau. De eerste regels daarvan zijn:
.. toctree:: :maxdepth: 2 foreword/index introduction/index
Het zal u opvallen dat dit een lijst met namen van mappen is, gevolgd door de naam index. Dit verwijst het index-bestand op het bovenste niveau naar de indexbestanden in elke map. De volgorde waarin zij staan bepaalt de volgorde die zij in het document zullen hebben.
Voeg de naam van uw nieuwe module (d.i. de naam die u aan de nieuwe map gaf), gevolgd door /index, aan die lijst toe, waar u wilt dat uw module zou moeten verschijnen.
Onthoud om de volgorde van de modules logisch te houden, en wel zo dat latere modules zijn gebouwd op de in eerder modules gepresenteerde kennis.
Open het indexbestand van uw eigen module ([naam module]/index.rst).
Schrijf, aan het begin van de pagina, een regel met 80 asterisken (*). Dat staat voor een kop van een module.
Vervolg deze regel met een regel die de frase voor opmaak |MOD| (wat “module” betekent) bevat, gevolgd door de naam van uw module.
Sluit dit af met nog een regel met 80 asterisken.
Laat hieronder een regel open.
Schrijf een korte alinea die het doel en de inhoud van de module uitlegt.
Laat één regel open en voeg dan de volgende tekst toe:
.. toctree:: :maxdepth: 2 lesson1 lesson2
… waar lesson1, lesson2, etc., de namen zijn van uw geplande lessen.
Het indexbestand op het niveau van de module zal er zo uitzien dit:
*******************************************************************************
|MOD| Module Name
*******************************************************************************
Short paragraph describing the module.
.. toctree::
:maxdepth: 2
lesson1
lesson2
19.4. Een les toevoegen
Een les toevoegen aan een nieuwe of bestaande module:
Open de map van de module.
Open het bestand index.rst (in het geval van nieuwe modules, hierboven gemaakt).
Zorg er voor dat de naam van de geplande les is vermeld onder de vermelding toctree, zoals hierboven weergegeven.
Maak een nieuw bestand aan in de map van de module.
Noem dit bestand exact hetzelfde als de naam die u heeft vermeld in het bestand index.rst van de module, en voeg de extensie .rst toe.
Notitie
Voor bewerkingsdoeleinden werkt een .rst-bestand exact hetzelfde als een normaal tekstbestand (.txt).
Schrijf de frase voor opmaak |LS|, gevolgd door de naam van de les om te beginnen met het schrijven van de les.
Schrijf, op de volgende regel, een regel met 80 ‘is gelijk aan’-tekens (=).
Laat hieronder een regel open.
Schrijf een korte omschrijving van het beoogde doel van de les.
Neem een algemene introductie op voor het onderwerp. Bekijk de bestaande lessen in de handleiding voor voorbeelden.
Begin hieronder een nieuwe alinea, beginnend met deze frase:
**The goal for this lesson:**
Leg in het kort de bedoelde leerdoelen uit van het voltooien van deze les.
Als u het doel van de les niet kunt uitleggen in één of twee zinnen, overweeg dan om het onderwerp op te delen in meerdere lessen.
Elke les zal worden opgedeeld in meerdere gedeelten, die hierna zullen worden besproken.
19.5. Een gedeelte toevoegen
Er zijn twee typen gedeelten: “follow along” en “try yourself”.
Een gedeelte “follow along” is een gedetailleerde verzameling aanwijzingen die zijn bedoeld om de lezer te leren hoe een bepaald aspect van QGIS te gebruiken. Dit wordt over het algemeen gedaan door zo duidelijk mogelijke klik-na-klik aanwijzingen te geven, afgewisseld met schermafdrukken.
Een gedeelte “try yourself” geeft de lezer een korte opdracht om zelf te proberen. Het wordt gewoonlijk geassocieerd met een item in het antwoordenblad aan het einde van de documentatie, wat zal weergeven of verklaren hoe de opdracht te voltooien, en zal, indien mogelijk, de verwachte uitvoer weergeven.
Elk gedeelte heeft een niveau van moeilijkheid. Een eenvoudig gedeelte wordt vermeld als |basic|, gemiddeld door |moderate|, en moeilijk door |hard|.
19.5.1. Een gedeelte “follow along” toevoegen
Vermeld, om dit gedeelte te beginnen, de frase voor opmaak van de bedoelde moeilijkheidsgraad (zoals hierboven weergegeven).
Plaats een spatie en schrijf dan |FA| (voor “follow along”).
Plaats nog een spatie en vermeld de naam van het gedeelte (gebruik alleen een hoofdletter aan het begin, en voor eigennamen).
Schrijf, op de volgende regel, een regel met 80 minussen/streepjes (-). Zorg er voor dat uw tekstverwerker niet het standaard teken minus/streepje vervangt door een lang streepje of ander teken.
Schrijf een korte introductie voor het gedeelte, die het doel ervan uitlegt. Geef dan gedetailleerde (klik-na-klik) instructies over de procedure die moet worden gedemonstreerd.
Neem in elk gedeelte de benodigde interne links, externe links en schermafdrukken op.
Probeer elk gedeelte af te sluiten met een korte alinea met een conclusie en die op natuurlijke wijze leidt naar het volgende gedeelte, indien mogelijk.
19.5.2. Een gedeelte “try yourself” toevoegen
Vermeld, om dit gedeelte te beginnen, de frase voor opmaak van de bedoelde moeilijkheidsgraad (zoals hierboven weergegeven).
Plaats een spatie en schrijf dan |TY| (voor “try yourself”).
Schrijf, op de volgende regel, een regel met 80 minussen/streepjes (-). Zorg er voor dat uw tekstverwerker niet het standaard teken minus/streepje vervangt door een lang streepje of ander teken.
Leg de oefening uit die u de lezer wilt laten voltooien. Verwijs, indien nodig, naar eerdere gedeelten, lessen of modules.
Neem schermafdrukken op om de vereisten te verduidelijken als een heldere tekstuele omschrijving niet duidelijk is.
In de meeste gevallen zult u een antwoord willen verschaffen met betrekking tot hoe de in dit gedeelte vermelde opdracht zou moeten worden voltooid. To do so, U zult een item in het antwoordenblad moeten toevoegen om dat te doen.
bepaal eerst een unieke naam voor het antwoord. Idealiter zal deze naam de naam van de les bevatten en een volgnummer.
Een koppeling voor dit antwoord maken:
:ref:`Check your results <answer-name>`
Open het antwoordenblad (answers/answers.rst).
Maak een koppeling naar het gedeelte “try yourself” door deze regel te vermelden:
.. _answer-name:
Schrijf de instructies over hoe de opdracht te voltooien, gebruik, waar nodig, koppelingen en afbeeldingen.
Neem, om het af te sluiten, een koppeling terug op naar het gedeelte “try yourself” door deze regel te vermelden:
:ref:`Back to text <backlink-answer-name>`
Voeg, om deze koppeling te laten werken, de volgende regel toe boven de kop naar het gedeelte “try yourself”:
.. _backlink-answer-name:
Onthoud dat elk van deze hierboven weergegeven regels een lege regel erboven en eronder moet hebben, anders zou het fouten kunnen veroorzaken bij het maken van het document.
19.6. Een conclusie toevoegen
Vermeld, om een les te beëindigen, de frase |IC| voor “in conclusion”, gevolgd door een nieuwe regel met 80 minussen/streepjes (-). Schrijf een conclusie voor de les waarin u uitlegt welke concepten zijn behandeld in de les.
19.7. Een gedeelte Meer informatie toevoegen
Dit gedeelte is optioneel.
Schrijf de frase FR voor “further reading”, gevolgd door een nieuwe regel van 80 minussen/streepjes (-).
Neem koppelingen op naar de van toepassing zijnde externe websites.
19.8. Een gedeelte Wat nu toevoegen
Schrijf de frase |WN| voor “what’s next”, gevolgd door een nieuwe regel van 80 minussen/streepjes (-).
Leg uit hoe deze les studenten heeft voorbereid voor de volgende les of module.
Onthoud om het gedeelte “what’s next” van de vorige les indien nodig te wijzigen, zodat die verwijst naar uw nieuwe les. Dit zal nodig zijn als u een nieuwe les tussen bestaande lessen heeft ingevoegd, of na een bestaande les.
19.9. Opmaak gebruiken
U zult standaard opgemaakte tekst zullen moeten toevoegen aan uw tekst om de standaarden van dit document te volgen,
19.9.1. Nieuwe concepten
Als u een nieuw concept uitlegt,zult u de naam van het nieuwe concept cursief moeten schrijven door het te omsluiten met asterisken (*).
This sample text shows how to introduce a *new concept*.
19.9.2. Benadrukken
Een cruciale term benadrukken die geen nieuw new concept is, schrijf de term vet door die te omsluiten met dubbele asterisken (**).
Gebruik dit spaarzaam! Als u dit teveel gebruikt kan het voor de lezer lijken of u schreeuwt of neerbuigend doet.
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. Afbeeldingen
Bij het toevoegen vaneen afbeelding, sla die op in de map _static/naam_les/.
Neem die als volgt op in het document:
.. figure:: img/image_file.extension :align: center
Onthoud om een lege regel over te laten boven en onder de opmaak voor de afbeelding.
19.9.4. Interne koppelingen
Schrijf, om een anker voor een koppeling te maken, de volgende regel boven de plaats waar u wilt dat de koppeling naar verwijst:
.. _link-name:
Voeg deze regel toe om een koppeling te maken:
:ref:`Descriptive link text <link-name>`
Onthoud om een lege regel boven en onder deze regel te houden.
19.9.5. Externe koppelingen
Schrijf, om een externe koppeling te maken, die als volgt uit:
`Descriptive link text <link-url>`_
Onthoud om een lege regel boven en onder deze regel te houden.
19.9.6. Mono gespatieerde tekst gebruiken
Wanneer u tekst schrijft die de gebruiker moet invoeren, een padnaam, of de naam van een element van een database, zoals een naam van een tabel of kolom, moet u die schrijven in mono gespatieerde tekst. Biijvoorbeeld:
Enter the following path in the text box: :kbd:`path/to/file`.
19.9.7. Items voor de GUI labelen
Indien u verwijst naar een item van de GUI, zoals een knop, moet u de naam ervan schrijven in de opmaak voor label van de GUI. Bijvoorbeeld:
To access this tool, click on the :guilabel:`Tool Name` button.
Dit is ook van toepassing als u de naam van een gereedschap vermeld, zonder dat de gebruiker op een knop hoeft te drukken.
19.9.9. Opmerkingen toevoegen
U wilt misschien een opmerking in de tekst opnemen, die extra details uitlegt die niet eenvoudig deel van de les kunnen worden gemaakt. Dit is de opmaak:
[Normal paragraph.] .. note:: Note text. New line within note. New paragraph within note. [Unindented text resumes normal paragraph.]
19.10. Dank u wel!
Dank u voor uw bijdrage aan dit project! Hierdoor maakt u QGIS meer toegankelijk voor gebruikers en voegt u waarde toe aan het project QGIS als geheel.