Recommandations pour la documentation¶

Introduction¶

Ceci est un guide de référence pour l’utilisation de fichiers rst dans la documentation. La documentation sera construite automatiquement sur le serveur à 00:00, 08:00, 16:00 PDT (Pacific Daylight Time) ou UTC-8. Le statut actuel est disponible sur http://docs.qgis.org.

Voir aussi : http://sphinx.pocoo.org/markup/inline.html ou le fichier convention.rst.

En général, lors de la création d’une documentation rst pour le projet QGIS, nous vous recommandons de suivre les recommandations de style de la documentation Python.

Utiliser les titres de chapitre¶

En ajoutant un nouveau titre de chapitre, vous devez utiliser les styles suivants pour les chapitres, sections, sous-section et mini-section.

Titres de chapitre

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

Section
=======

Subsection
----------

Minisec
.......

Balises en ligne¶

• Raccourcis clavier :

  :kbd:`ctrl B`

  affichera Ctrl B

• Interface du menu

  :menuselection:`menu --> submenu`

• Nom du fichier

  :file:`README.rst`

• Icône avec texte en pop up appartenant à l’icône

  |icon| :sup:`popup_text`

  (voir image ci-dessous).

• Boîte de dialogue et titre d’onglet

  :guilabel:`title`

• Texte utilisateur

  ``label``
  

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 n’utilisez pas les notes de pied de page dans une documentation.

Ceci est pour créer une note de pied de page

blabla [1]_

qui pointera vers :

[1]	Mise à jour des extensions principales

Étiquette/référence¶

Ceci est utilisé pour créer une référence quelque part

.. _my_anchor:

Label/reference
===============

Ceci appellera une référence dans la même page

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!)

Donc référence 1 (my_anchor) et référence 2 Étiquette/référence

Parce que souvent une référence affiche le titre complet, il n’est pas nécessaire d’utiliser le mot section

see :ref:`my_anchor`

Figure et image¶

Figure

.. _figure_readme_1:

.. only:: html

   **Figure Readme 1:**

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

   A caption: A logo I like

Le résultat ressemblera à ceci :

Figure Readme 1:

Un titre : Un logo que j’aime

Utilisez .. only:: html pour rendre le numéro de la figure (Figure Readme 1) visible seulement dans les fichiers html. Les scripts inséreront un numéro généré automatiquement avant le titre de la figure en 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 de deux manières, d’abord en utilisant l’étiquette de la référence comme ceci :

(see Figure_Readme_1_).

Cela affichera l’ancre Figure_Readme_1. Vous pouvez mettre en majuscule si vous le désirez. Il doit être utilisé dans le même fichier .rst pas dans un autre.

Vous ne pouvez plus utiliser la référence comme cela parce qu’en html la référence au titre est perdue (il se réfère maintenant avant 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!

Tables¶

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

Le résultat :

Windows	Mac OSX
et bien sur ne pas oublier

Mon tableau établi, voyez-vous ce n’est malheureusement pas considéré comme une légende

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

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

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

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

Index¶

Il existe différents tags d’index dans le format RST. Pour pouvoir traduire l’index, il est nécessaire de l’intégrer dans le texte normal. Dans ce cas, utilisez cette syntaxe :

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

Si le terme n’a pas besoin d’être traduit, utilisez cette syntaxe :

.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...

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/

• même environnement pour toutes les captures d’écran (même OS, même cadrage, même taille de police)

• réduire la fenêtre à l’espace minimal requis pour montrer la fonction (prendre l’écran en entier pour montrer une petite fenêtre modale est excessif)

• Moins il y a d’encombrement, mieux c’est (pas besoin d’activer toutes les barres d’outils)

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

• couper l’arrière-plan

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

• Enregistrez-les au format png (sans artefacts jpeg)

• La capture d’écran devrait montrer un contenu correspondant à ce qui est décrit dans le texte

• 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

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/

• même environnement pour toutes les captures d’écran (même OS, même cadrage, même taille de police)

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

• même taille que les captures d’écran ‘originales’ en anglais, sinon elles seront étirées et laides. Si vous avez besoin d’avoir une taille différente en raison des chaînes d’interface utilisateur, n’oubliez pas de changer la dimension dans le code rst de votre langue.

• réduire la fenêtre à l’espace minimal requis pour montrer la fonction (prendre l’écran en entier pour montrer une petite fenêtre modale est excessif)

• Moins il y a d’encombrement, mieux c’est (pas besoin d’activer toutes les barres d’outils)

• Ne les redimensionnez pas dans un éditeur d’image, la taille sera définie dans les fichiers rst (réduire les dimensions sans augmenter correctement la résolution est laid)

• couper l’arrière-plan

• Enregistrez-les au format png (sans artefacts jpeg)

• La capture d’écran devrait montrer un contenu correspondant à ce qui est décrit dans le texte

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