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

Recommandations pour la documentation

Introduction

QGIS Documentation will be built automatically on the server at 0, 8am, 4pm US/Pacific (Pacific Time). The current status is available at http://docs.qgis.org.

QGIS Documentation is mainly written using the reStructuredText (reST) format syntax, coupled with some scripts from the Sphinx toolset to post-process the HTML output. See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html or http://sphinx.pocoo.org/markup/inline.html.

In general, when creating rst documentation for the QGIS project, please follow the Python documentation style guidelines. Below are exposed some general guidelines to follow when using reST for the QGIS documentation writing.

If you are looking for general rules on contributing to QGIS project or managing repositories, you may find help at Get Involved in the QGIS Community.

Rédiger la Documentation

Titres de chapitre

À chaque page web de la documentation correspond un fichier « .rst ».

Les différentes parties qui structurent le texte sont identifiées par leur titre qui est souligné (et surligné pour le premier niveau). Les titres de même niveau doivent utiliser le même caractère de soulignement. Dans la documentation QGIS, voici les styles à utiliser pour le chapitre, la section, la sous-section et la mini section.

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

Section
=======

Subsection
----------

Minisec
.......

Subminisec
^^^^^^^^^^

Inline tags

Quelques balises peuvent être utilisées dans le texte pour mettre en valeur certains éléments.

  • 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]**

  • Nom de fichier ou de répertoire

    :file:`README.rst`

  • Icone et texte du popup de l’icone

    |icon| :sup:`popup_text`

    (voir image ci-dessous).

  • Shorcut keyboard

    :kbd:`ctrl B`

    will show Ctrl B

  • Texte utilisateur

    ``label``

Étiquette/référence

Les références servent de repères dans le texte. Cela facilite la création et l’utilisation d’hyperliens entre les sections ou les pages.

L’exemple ci-dessous crée la référence d’une section (e.g., Libellé/titre de la référence)

.. _my_anchor:

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

Pour appeler la référence dans la même page, utilisez

see my_anchor_ for more information.

qui renverra :

voir my_anchor pour plus d’informations.

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.

Une autre façon de créer un lien accessible depuis n’importe où dans la documentation est d’utiliser :ref:.

see :ref:`my_anchor` for more information.

qui affichera la légende à la place (dans ce cas le titre de la section!):

voir Étiquette/référence pour plus d’informations.

On a donc référence 1 (my_anchor) et référence 2 (Étiquette/référence). Parce que la référence affiche souvent une description complète, il n’est pas vraiment utile d’utiliser le mot section. Notez que vous pouvez aussi utiliser une description personnalisée pour la référence

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

renvoyant :

voir Label and reference pour d’avantage de détails.

Figure and image

Illustrations

Pour insérer une image, utilisez

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

qui renvoie

../../_images/qgislogo.png

Remplacement

You can put an image inside text or add an alias to use everywhere. To use an image inside a paragraph, just create an alias somewhere.

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

and call it in your paragraph:

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

Here is how this example become:

my paragraph begins here with a nice logo nice_logo.

Note

Currently, to ensure consistency and help in the use of QGIS icons a list of alias is built and available in Substitutions chapter.

Figure

.. _figure_logo:

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

   A caption: A logo I like

Le résultat ressemble à ceci :

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.

Pour utiliser un titre (voir Mon titre) insérez juste un texte indenté après une ligne blanche dans le bloc de la figure.

La référence à la figure peut être faite en utilisant l’étiquette de la référence comme ceci :

(see Figure_logo_).

Il montrera l’ancre Figure_logo. Vous pouvez utiliser des majuscules si vous le souhaitez. Il peut être utilisé dans le même fichier: fichier .rst mais pas dans les autres. Vous pouvez toujours utiliser le rôle ``: ref: `` pour l’utiliser à partir d’autres fichiers, mais gardez à l’esprit que cela renvoie la légende complète de l’image.

see :ref:`figure_logo`

renvoie :

voir Un titre : Un logo que j’aime

Tables

Pour créer une table simple

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

Utilisez un \ suivi par un espace vide pour laisser un espace vide.

Vous pouvez aussi utiliser des tableaux plus compliqués en les dessinant avec des références etc.

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

Le résultat :

Windows macOS
win osx

et bien sûr, ne pas oublier nix

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

Vous pouvez le référencer comme ceci my_drawn_table.

Index

Un index est un moyen pratique d’aider le lecteur à trouver facilement une information dans un document. La documentation QGIS fournit les principaux index. Il y a quelques règles à suivre pour conserver un ensemble d’index vraiment utiles (cohérents, cohérents et vraiment connectés les uns aux autres):

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

Il existe différents tags d’index dans le format RST. Vous pouvez soit utiliser le tag :index: à l’intérieur de votre paragraphe.

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

Ou vous pouvez utiliser le tag .. index:: de niveau paragraphe et qui précède la section en question. Du fait des règles mentionnées précédemment, il est conseillé de privilégier cette seconde forme car plus facile à utiliser.

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

Commentaires Spéciaux

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.

Note

Alors que le texte dans les notes, astuces et avertissements sont traduisibles, sachez que les blocs de code ne permettent pas la traduction. Évitez donc les commentaires qui ne sont pas liés à l’exemple de code et gardez-le aussi court que nécessaire.

Notes de pied de page

Attention : les notes de pied de page ne sont pas reconnues par les logiciels de traduction et ne sont pas converties correctement dans le format PDF. Donc, si possible, n’utilisez pas les notes de pied de page dans une documentation.

This is for creating a footnote

blabla [1]_

qui pointera vers :

[1]

Mise à jour des extensions principales

Les Captures d’écrans

Ajouter de nouvelles captures d’écran

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.

  • Utilisez la commande suivante pour supprimer la fonction de menu global sous Ubuntu pour créer des écrans d’application plus petits avec leurs menus :

sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

Traduire les captures d’écran

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

Documenter les algorithmes de traitement

Si vous désirez écrire de la documentation pour des algorithmes de Traitement, merci de suivre ces recommandations :

  • 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