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.
Remplacement¶
Vous pouvez placer une image dans un texte ou ajouter un alias pour l’utiliser régulièrement. Pour utiliser une image dans un paragraphe, créez juste un alias quelque part
.. |nice_logo| image:: /static/common/qgislogo.png
:width: 2 em
et l’appeler dans votre paragraphe
my paragraph begins here with a nice logo |nice_logo|.
Voici comment l’exemple apparaît :
mon paragraphe commence ici avec un joli 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¶
Voici quelques conseils pour créer de nouvelles captures d’écran harmonieuses. Celles du guide utilisateur sont situées dans ./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)
Ne les redimensionnez pas dans un éditeur d’image, si nécessaire la taille sera définie dans les fichiers rst (réduire les dimensions sans augmenter correctement la résolution dégrade fortement l’image)
couper l’arrière-plan
Fixez la résolution d’impression à 135 dpi (de cette manière, si aucune résolution n’est définie dans le fichier rst, les images seront en taille originale en html et en résolution satisfaisante en 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
Vous pouvez trouvez des QGIS -projets tout faits qui ont été utilisés avant la création des captures d’écran dans ./qgis-projects. Cela permettra de rendre plus facile la reproduction des captures d’écran pour la prochaine version de QGIS. Ces projets utilisent le jeu de données d’exemple de QGIS qui devrait être stocké dans le même répertoire que le dépôt de la documentation QGIS.
Utilisez la commande suivante pour supprimer la fonction de menu global sous Ubuntu pour créer des écrans d’application plus petits avec leurs menu.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt
Traduire les captures d’écran¶
Voici quelques astuces pour créer des captures d’écran à destination de la traduction du guide de l’utilisateur. Elles seront situées dans ./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)
Utilisez les QGIS -projets inclus dans le dépôt de la documentation QGIS (dans ./qgis_projects ). Ils ont été utilisés pour produire les captures d’écran ‘originelles’ du manuel. Le jeu de données QGIS exemple devrait être situé dans le même répertoire que le dépôt de la documentation QGIS.
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
Documenter les algorithmes de Traitement¶
Si vous désirez écrire de la documentation pour un algorithme de Traitement, merci de suivre ces recommandations :
n’écrasez pas les fichiers d’aide déjà existants par des fichiers d’autre provenance (ex : l’arbre des sources QGIS ou le dépôt d’aide des Géotraitements), ces fichiers ont des formats différents
Les fichiers d’aide des algorithmes de géotraitement font partie du Guide Utilisateur de QGIS. Utilisez le même format que ce guide et des autres documentations
Évitez d’utiliser la phrase “Cet algorithme fait ci et ça...” comme phrase d’introduction de la description de l’algorithme. Essayez d’utiliser des mots plus génériques comme ceux de l’aide des algorithmes GRASS ou TauDEM
Ajoutez des images si nécessaire. Utilisez le format PNG et suivez les recommandations générales sur la documentation.
Si nécessaire, ajoutez des liens vers des informations complémentaires (ex: des publications ou des pages web) à la section “Voir également”.
Donnez une explication claire des paramètres de l’algorithme ainsi que de ses sorties (encore une fois, les exemples de GRASS et Taudem sont de bons exemples).
Ne modifiez pas les noms des paramètres ou de sorties. Si vous remarquez une erreur de syntaxe ou une mauvaise orthographe, reportez-la au niveau du bugtracker afin que les développeurs puissent corriger le problème directement dans le code du Géotraitement.
Ne listez pas les options disponibles dans la description de l’algorithme, les options sont déjà listées dans la description des paramètres.
N’ajoutez pas d’information sur le type de géométrie dans la description de l’algorithme ou de ses paramètres sans vous être assuré que cette information n’est pas déjà disponible dans la description des paramètres.