Richtlijnen voor vertalen¶
Introductie¶
Dit zijn richtlijnen voor het algemene gebruik van rst in documentatie voor QGIS . De documentatie zal automatisch op de server worden gebouwd 0, 8am, 4pm PDT (Pacific Daylight Time). De huidige status is beschikbaar op http://docs.qgis.org.
Bekijk ook: http://sphinx.pocoo.org/markup/inline.html of het bestand convention.rst.
Volg in het algemeen, bij het maken van documentatie in rst voor het project QGIS, de Python documentation style guide lines.
Kopregels gebruiken¶
Voor het toevoegen van nieuwe kopregels zou u de volgende stijlen voor hoofdstuk, alinea, alineagedeelte en minisec moeten gebruiken.
kopregels
********
Chapter
********
Section
=======
Subsection
----------
Minisec
.......
Tags in regels¶
Toetsenbord sneltoets:
:kbd:`ctrl B`
zal weergeven Ctrl B
Menu gui
:menuselection:`menu --> submenu`
bestandsnaam
:file:`README.rst`
Pictogram met tekst, die bij het pictogram behoort, in pop-up
|icon| :sup:`popup_text`
(zie image hieronder).
Titel dialoogvenster en tabpagina
:guilabel:`title`
Gebruikerstekst
``label``
Voetnoten¶
Onthoud: Voetnoten worden niet herkend door enige software voor vertalingen en ze worden ook niet juist geconverteerd naar de indeling PDF. Gebruik dus geen voetnoten binnen enige documentatie.
Dit is voor het maken van een voetnoot
blabla [1]_
Die zal wijzen naar:
[1] Bijwerken van plug-ins van de bron
Label/verwijzing¶
Dit wordt gebruikt om ergens een verwijzing te maken
.. _my_anchor:
Label/reference
===============
Dit zal de verwijzing aanroepen op dezelfde pagina
see my_anchor_ for more information. 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. If you use
:ref:`my_anchor` it will display the caption instead
(In this case the title of this section!)
Dus verwijzing 1 (my_anchor) en verwijzing 2 Label/verwijzing
Omdat de verwijzing vaak al een volledig bijschrift weergeeft, is het niet echt nodig om het woord section te gebruiken
see :ref:`my_anchor`
Figuur en afbeelding¶
Figuur
.. _figure_readme_1:
.. only:: html
**Figure Readme 1:**
.. figure:: /static/common/qgislogo.png
:width: 20 em
:align: center
A caption: A logo I like
Het resultaat ziet er uit als:
Figure Readme 1:
Een bijschrift: Een logo dat ik leuk vind
Gebruik .. only:: html om het nummer van de afbeelding (Figure Readme 1) alleen in html-bestanden zichtbaar te maken. De scripts zullen een automatisch gegenereerd nummer invoegen vóór het bijschrift van de afbeelding in pdf.
Voeg eenvoudigweg ingesprongen tekst in na een lege regel in het blok figure om een bijschrift te gebruiken (zie My caption).
Verwijzen naar de afbeelding kan op twee manieren, ten eerste met behulp van het label verwijzing zoals dit
(see Figure_Readme_1_).
Het zal het anker Figure_Readme_1 weergeven. U kunt hoofdletters gebruiken als u dat wilt. Het kan worden gebruikt in hetzelfde .rst-document maar niet in andere .rst-documenten.
U kunt de verwijzing niet meer op deze manier gebruiken, omdat in html de verwijzing naar het bijschrijft verloren gaat (het verwijst nu naar de plaats vóór Figure Readme 1:
see :ref:`figure_readme_1`, does not work due to the lost reference to
the caption of the figure, this is not a 'bug' but a choice we made!
Tabellen¶
een eenvoudige tabel
======= ======= =======
x y z
======= ======= =======
1 2 3
2 4
======= ======= =======
gebruik een \ gevolgd door een lege spatie ‘ ‘ om een lege spatie te maken.
U kunt ook meer gecompliceerde tabellen maken door ze te tekenen met behulp van verwijzingen en zo
.. _my_drawn_table_1:
+---------------+--------------------+
| Windows | Mac OSX |
+---------------+--------------------+
| |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_1_.
Het resultaat:
| Windows | Mac OSX |
 |
 |
en natuurlijk, niet te vergeten, |
|
Helaas is voor de door mij getekende tabel geen bijschrift toegelaten
U kunt er op deze manier naar verwijzen my_drawn_table_1.
Vervanging¶
U kunt een afbeelding binnen tekst plaatsen of een alias toevoegen om het overal te kunnen gebruiken. Maak ergens eenvoudigweg een alias om een afbeelding binnen een alinea te gebruiken,
.. |nice_logo| image:: /static/common/qgislogo.png
:width: 2 em
en het aanroepen in uw alinea
my paragraph begins here with a nice logo |nice_logo|.
Hier is hoe dit voorbeeld er uit zal zien:
mijn alinea begint hier met een mooi logo .
Index¶
Er bestaan verscheidene tags voor index in RST. Het is noodzakelijk om ze in de normale tekst te integreren om in staat te zijn de index te kunnen vertalen. Gebruik in dat geval deze syntaxis:
QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...
Indien de term niet moet worden vertaald, gebruik dan deze syntaxis:
.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...
Toevoegen van nieuwe schermafdrukken¶
Nu volgen enkele tips voor het maken van nieuwe schermafdrukken. Wanneer de schermafdrukken in de gebruikershandleiding moeten komen, plaats deze dan onder: ./resources/en/user_manual/
dezelfde omgeving voor alle schermafdrukken (hetzelfde OS, dezelfde decoratie, dezelfde lettergrootte)
verklein het venster naar de minimale ruimte die nodig is om de mogelijkheid weer te geven (het gehele scherm nemen voor een klein model venster > overkill)
hoe minder vervuiling, hoe beter (niet nodig om alle werkbalken te activeren)
wijzig de afmetingen niet in een programma voor bewerken van afbeeldingen, de grootte zal in de rst-bestanden worden ingesteld (verkleinen van de dimensies zonder de resolutie juist omhoog te brengen > lelijk)
snijd de achtergrond bij
Stel de grootte voor de resolutie voor afdrukken in op 135 dpi (op deze wijze zullen, indien er geen afmeting wordt ingesteld in de rst-bestanden, afmetingen hun originele grootte hebben in html en een goede resolutie voor afdrukken in de PDF)
sla ze als png (geen jpeg-artifacten)
de schermafdruk zou als inhoud moeten tonen wat overeenkomstig wordt beschreven in de tekst
Er zijn een aantal QGIS -projecten beschikbaar in ./qgis-projects die door andere redacteuren zijn gemaakt voor het maken van schermafdrukken. Deze projecten maken het makkelijker om schermafdrukken te reproduceren voor nieuwe versies van QGIS. Alle projecten gebruiken de QGIS voorbeeld dataset die moet worden geplaatst in dezelfde map als de QGIS-Documentation Repository.
Gebruik het volgende commando om de menu functionaliteit in Ubuntu aan te passen. Hierdoor worden in het algemeen de applicatieschermen kleiner en worden menu’s zichtbaar.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt
Schermafdrukken vertalen¶
Nu volgen enkele tips voor het maken van schermafdrukken voor vertalingen. Deze dienen te worden geplaatst onder ./resources/<vertaling>/user_manual/
dezelfde omgeving voor alle schermafdrukken (hetzelfde OS, dezelfde decoratie, dezelfde lettergrootte)
Gebruik de QGIS -projecten uit de QGIS-Documentation Repository (in ./qgis_projects ). Deze projecten zijn gebruikt voor het maken van de ‘originele’ schermafdrukken in de handleidingen. De QGIS voorbeeld dataset dient te worden geplaatst in dezelfde map als de QGIS-Documentation Repository.
dezelfde grootte als de Engelse ‘originele’ schermafdrukken, anders zullen zij vervormen en er lelijk uitzien. Indien u een andere afmeting nodig heeft vanwege langere tekenreeksen in de ui, vergeet dan niet de dimensie te wijzigen in de rst-code van uw taal.
verklein het venster naar de minimale ruimte die nodig is om de mogelijkheid weer te geven (het gehele scherm nemen voor een klein model venster > overkill)
hoe minder vervuiling, hoe beter (niet nodig om alle werkbalken te activeren)
wijzig de afmetingen niet in een programma voor bewerken van afbeeldingen, de grootte zal in de rst-bestanden worden ingesteld (verkleinen van de dimensies zonder de resolutie juist omhoog te brengen > lelijk)
snijd de achtergrond bij
sla ze als png (geen jpeg-artifacten)
de schermafdruk zou als inhoud moeten tonen wat overeenkomstig wordt beschreven in de tekst
Algoritmen voor Processing documenteren¶
Neem, bij het schrijven van documentatie voor algoritmen van Processing, de volgende richtlijnen in overweging:
Overschrijf geen bestaande documentatie bestanden door bestanden uit andere bronnen, ook niet uit andere QGIS gerelateerde Repositories. Deze bestanden hebben vaak een ander (onjuist) formaat.
De hulpteksten voor verwerkingsalgoritmen zijn onderdeel van de QGIS gebruikershandleiding en volgen dezelfde richtlijnen.
Voorkom het gebruik van zinnen als “Dit algoritme doet dit en dat...” als eerste zin in de beschrijving van een algoritme. Probeer meer beeldende zinnen te gebruiken. Neem de beschrijvingen voor de TauDEM of GRASS algoritmen als voorbeeld.
Wanneer afbeeldingen gewenst zijn dan kunnen deze worden toegevoegd. Gebruik het PNG bestandsformaat en volg de algemene richtlijn voor het maken van documentatie.
Indien verwijzing naar externe bronnen gewenst zijn (bijv. publicaties of webpagina’s), plaats deze dan in de “Zie ook” sectie
Geef duidelijke uitleg over de parameters en de resultaten van algoritmen (Ook hier kun je GRASS en TauDEM als voorbeelden nemen).
Wijzig geen parameter of resultaat namen. Gevonden type- of spellingsfout kunnen worden gerapporteerd in het foutmeldingensysteem zodat ontwikkelaars deze kunnen aanpassen.
geef geen overzicht van beschikbare opties in de beschrijving van het algoritme, beschikbare opties worden al weergegeven in de beschrijving van de parameter.
Geef geen informatie over de typen geometrie in de beschrijving van algoritme of parameter zonder duidelijke reden. Deze informatie wordt al beschikbaar gemaakt in de beschrijving van de parameter.