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

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:

../../_images/qgislogo.png

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
win osx

en natuurlijk, niet te vergeten, nix

Helaas is voor de door mij getekende tabel geen bijschrift toegelaten

U kunt er op deze manier naar verwijzen my_drawn_table_1.

Afbeeldingen

Afbeelding

.. image:: /static/common/qgislogo.png
   :width: 10 em

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 nice_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

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./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)

  • don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
  • snijd de achtergrond bij

  • Set print size resolution to 135 dpi (this way, if no size is set in the rst files, images will be at original size in html and at a good print resolution in the PDF)
  • sla ze als png (geen jpeg-artifacten)

  • de schermafdruk zou als inhoud moeten tonen wat overeenkomstig wordt beschreven in de tekst

  • you can find some prepared QGIS -projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS sample dataset which should be placed in the same folder as the QGIS-Documentation Repository.
  • Use the following command to remove the global menu function in Ubuntu to create smaller application screens with menu’s.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

Schermafdrukken vertalen

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

  • dezelfde omgeving voor alle schermafdrukken (hetzelfde OS, dezelfde decoratie, dezelfde lettergrootte)

  • use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample dataset should be placed in the same folder as the 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

Documenting Processing algorithms

If you want to write documentation for Processing algorithms consider this guidelines:

  • don’t overwrite existing help files by files from other sources (e.g. QGIS source tree or Processing-Help repository), this files have different formats
  • Processing algorithm help files are part of QGIS User Guide, so use same formatting as User Guide and other documentation
  • avoid use “This algoritm does this and that...” as first sentence in algorithm description. Try to use more general words like in TauDEM or GRASS algoritms help
  • add images if needed. Use PNG format and follow general guidelines for documentation.
  • if necessary add links to additional information (e.g. publications or web-pages) to the “See also” section
  • give clear explanation for algorithm parameters and outputs (again GRASS and TauDEM are good examples).
  • don’t edit parameter or output names. If you found typo or wrong spelling — report this in bugracker, so developers can fix this in Processing code too
  • don’t list available options in algorithm description, options already listed in parameter description.
  • don’t add information vector geometry type in algorithm or parameter description without compelling reason as this information already available in parameter description