Recommandations pour les traductions¶
Introduction¶
Ceci sont des recommandations pour utiliser la conversion LaTeX vers rst.
Il y a également des informations sur l’utilisation générale du rst dans la documentation de QGIS.
Voir aussi le fichier : http://sphinx.pocoo.org/markup/inline.html or convention.rst.
En général, lors de la création d’un documentation rst pour le projet QGIS, suivez s’il vous plaît les`recommandations de style de la documentation Python <http://docs.python.org/devguide/documenting.html>`_.
Utiliser les têtes de chapitre¶
En ajoutant un nouveau titre de chapitre, vous devez utiliser les styles suivants pour les chapitres, sections, sous-section et mini-section.
Têtes 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¶
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 reference 1 (my_anchor) et reference 2 Étiquette/référence
Parce que souvent une référence affiche le titre complet, il n’est pas nécessaire d’utiliser la section ‘word’
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:
A caption: A logo I like
Utilisez .. only:: html pour rendre le numéro de la figure (Figure Readme 1) visible seulement dans les fichiers html. Les script 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 peut être utilisé dans le même fichier .rst mais 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 perdu (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 en utilisant 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 de partout. 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 appeler le dans votre paragraphe
my paragraph begins here with a nice logo |nice_logo|.
Voici comment apparaît l’exemple :
mon paragraphe commence ici avec un jolie logo .
Index¶
Several index tag exists in RST. To be able to translate the index, it is necessary to integrate it into the normal text. Otherwise software like linguist or transifex won’t add it to the translatable text. Usage is:
QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...