Handleiding voor documentatie¶

Kopregels¶

Elke webpagina van de documentatie komt overeen met een .rst-bestand.

Secties die worden gebruikt om de tekst te structureren worden geïdentificeerd door middle van hun titel die onderstreept is (en met een streep boven voor het eerste niveau). Titels op hetzelfde niveau moeten hetzelfde teken gebruiken voor eenduidig onderstrepen. In QGIS Documentation zou u de volgende stijlen moeten gebruiken voor hoofdstuk, sectie, subsectie en minisec.

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Subminisec
^^^^^^^^^^

Inline tags¶

U kunt binnen de tekst enkele tags gebruiken om enkele items te benadrukken.

• Menu gui: to mark a complete sequence of menu selections, including selecting submenus and choosing a specific operation, or any subsequence of such a sequence.

  :menuselection:`menu --> submenu`
  

• Dialog and Tab title: Labels presented as part of an interactive user interface including window title, tab title and option labels.

  :guilabel:`title`
  

• Button labels

  **[Apply]**
  

• Bestandsnaam of -map

  :file:`README.rst`
  

• Pictogram met pop-uptekst behorende tot het pictogram

  |icon| :sup:`popup_text`
  

  (zie image hieronder).

• Shorcut keyboard

  :kbd:`ctrl B`
  

  will show Ctrl B

• Gebruikerstekst

  ``label``
  

Label/verwijzing¶

Verwijzingen worden gebruikt om ankers binnen de tekst te plaatsen. Het helpt u dan om hyperlinks te maken of aan te roepen tussen secties of pagina.

Het voorbeeld hieronder maakt het anker van een sectie (bijv., titel voor label/verwijzing)

.. _my_anchor:

Label/reference
---------------

Gebruik, om de verwijzing op dezelfde pagina aan te roepen,

see my_anchor_ for more information.

wat terug zal geven:

bekijk my_anchor voor meer informatie.

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.

Een andere manier om naar dezelfde plek te springen vanuit ergens in de documentatie is om de rol :ref: te gebruiken.

see :ref:`my_anchor` for more information.

wat in plaats daarvan het bijschrift zal weergeven (in dit geval de titel van deze sectie!):

bekijk Label/verwijzing voor meer informatie.

Dus verwijzing 1 (my_anchor) en verwijzing 2 (Label/verwijzing). Omdat de verwijzing vaak het volledige bijschrift weergeeft, is er niet echt de noodzaak om het woord sectie te gebruiken. Onthoud dat u ook een aangepast bijschrift kunt gebruiken om de verwijzing te beschrijven

see :ref:`Label and reference <my_anchor>` for more information.

wat teruggeeft:

bekijk Label and reference Vpor meer informatie.

Figure and image¶

Afbeeldingen¶

gebruik, om een afbeelding in te voegen

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

wat teruggeeft

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

my paragraph begins here with a nice logo |nice_logo|.

Figuur¶

.. _figure_logo:

.. figure:: /static/common/qgislogo.png
   :width: 20 em
   :align: center

   A caption: A logo I like

Het resultaat ziet er uit als dit:

Een bijschrift: Een logo dat ik leuk vind

To avoid possible conflict with another references, always begin figures anchor with _figure_ and prefer using terms that can easily refer to the figure caption. While only the centered alignment is mandatory for the image, feel free to use any other options for figure (such as width, height, scale...) if needed.

The scripts will insert an automatical generated number before the caption of the figure 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 worden gedaan met behulp van het label verwijzing zoals dit

(see Figure_logo_).

Het zal het anker Figure_logo weergeven. U kunt hoofdletters gebruiken als u dat wilt. Het kan worden gebruikt in hetzelfde .rst-document maar niet in andere. U kunt nog steeds de rol :ref: gebruiken voor verwijzingen vanuit andere bestanden, maar onthoud dat dit het volledige bijschrift van de afbeelding zal teruggeven.

see :ref:`figure_logo`

geeft terug:

zie Een bijschrift: Een logo dat ik leuk vind

Tabellen¶

Een eenvoudige tabel maken

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

gebruik een \ gevolgd door een lege spatie om een lege spatie te laten.

U kunt ook meer gecompliceerde tabellen maken door ze te tekenen met behulp van verwijzingen en zo

.. _my_drawn_table:

+---------------+--------------------+
| Windows       | macOS              |
+---------------+--------------------+
| |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_.

Het resultaat:

Windows	MacOS
en natuurlijk, niet te vergeten,

My drawn table, mind you this is unfortunately not regarded a caption

U kunt er op deze manier naar verwijzen my_drawn_table.

Index¶

Een index is een handige manier om de lezer te helpen om op eenvoudige wijze informatie te zoeken in een document. Documentatie voor QGIS verschaft enkele essentiële indices. Er zijn een aantal regels die moeten worden gevolgd om een set indices te behouden die echt nuttig zijn (coherent, consistent en echt met elkaar verbonden):

• Index should be human readable, understandable and translatable; an index can be made from many words but you should avoid any unneeded _, -... characters to link them i.e., Loading layers instead of loading_layers or loadingLayers.
• Always capitalize only the first letter of the index unless the word has a particular spelling, in which case keep using its spelling e.g., Loading layers, Atlas generation, WMS, pgsql2shp
• Keep an eye on the existing Index list in order to reuse the most convenient expression with the right spelling and avoid wrong duplicates.

Er bestaan verscheidene tags voor index in RST. U kunt ofwel de inregelige tag :index: binnen de normale tekst gebruiken.

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

Of u kunt het blokniveau markup .. index:: gebruiken dat koppelt naar het begin van de volgende alinea. Vanwege de hierboven vermelde regels wordt aanbevolen deze laatste tag te gebruiken omdat het eenvoudiger is om daaraan te voldoen.

.. index:: WMS, WFS, Loading layers

It’s also recommanded to use index parameters such as single, pair, see... in order to build a more structured and interconnected table of index. See http://www.sphinx-doc.org/en/stable/markup/misc.html#index-generating-markup for more information on index creation.

Speciale opmerkingen¶

Sometimes, you may want to emphasize some points of the description, either to warn, remind or give some hints to the user. In QGIS Documentation, we use reST special directives such as .. warning::, .. note:: and .. tip:: generating particular frames that highlight your comments. See http://www.sphinx-doc.org/en/stable/markup/para.html#paragraph-level-markup for more information. A clear and appropriate title is required for both warnings and tips.

.. tip:: **Always use a meaningful title for tips**

 Begin tips with a title that summarizes what it is about. This helps
 users to quickly overview the message you want to give them, and
 decide on its relevance.

Code snippets¶

You may also want to give examples and insert a code snippet. In this case, write the comment below a line with the :: directive inserted. However, for a better rendering, especially to apply color highlighting to code according to its language, use the code-block directive, e.g. .. code-block:: xml. By default, Python code snippets do not need this reST directive. More details at http://www.sphinx-doc.org/en/stable/markup/code.html.

Voetnoten¶

Onthoud: Voetnoten worden niet herkend door enige software voor vertalingen en ze worden ook niet juist geconverteerd naar de indeling PDF. Gebruik dus indien mogelijk geen voetnoten binnen enige documentatie.

This is for creating a footnote

blabla [1]_

Die zal wijzen naar:

[1]	Bijwerken van plug-ins van de bron

Nieuwe schermafdrukken toevoegen¶

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

• same environment for all the screen caps (same OS, same decoration, same font size). We have used Ubuntu with Unity and the default “ambience” theme. For screenshots of QGIS main window and composer we have set it to show menus on the window (not the default in unity).
• reduce the window to the minimal space needed to show the feature (taking the all screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• 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)
• cut the background
• make the top corners transparent if the background is not white
• Set print size resolution to 135 dpi (e.g. in Gimp set the print resolution image ‣ print size and save). This way, images will be at original size in html and at a good print resolution in the PDF. You can also use ImageMagick convert command to do a batch of images

convert -units PixelsPerInch input.png -density 135 output.png

• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the text
• 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 Data (aka Alaska Dataset), which should be placed in the same folder as the QGIS-Documentation Repository.

• Gebruik de volgende opdracht om de globale menufunctie in Ubuntu te verwijderen om kleinere schermen voor de toepassing te maken met 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/

• same environment for all the screen caps (same OS, same decoration, same font size)
• 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 Data (aka Alaska Dataset) should be placed in the same folder as the QGIS-Documentation Repository.
• same size as the english ‘original’ screenshots, otherwise they will be stretched and look ugly. If you need to have a different size due to longer ui strings, don’t forget to change the dimension in the rst code of your language.
• reduce the window to the minimal space needed to show the feature (taking all the screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• don’t resize them in an image editor, the size will be set into the rst files (downscaling the dimensions without properly upping the resolution > ugly)
• cut the background
• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the text