Important

La traduction est le fruit d’un effort communautaire auquel vous pouvez vous joindre. Cette page est actuellement traduite à 73.15%.

19. Annexe : Contribution à ce manuel

To add materials to this course, you must follow the guidelines in this Appendix. You are not allowed to alter the conditions in this Appendix except for clarification. This is to ensure that the quality and consistency of this manual can be maintained.

19.1. Téléchargement des ressources

La source de ce document est disponible sur GitHub. Consultez GitHub.com pour les instructions d’utilisation du système de contrôle de versionnement git.

19.2. Format du Manuel

Ce manuel est écrit en utilisant Sphinx, un générateur de documentation sous Python utilisant le langage de balise reStructuredText. Les instructions sur l’utilisation de ces outils sont disponibles sur leurs sites respectifs.

19.3. Ajout d’un module

Pour ajouter un nouveau module :

  1. Créez tout d’abord un nouveau répertoire (directement sous le plus haut niveau du répertoire qgis-training-manual) avec le nom du nouveau module.

  2. Under this new directory, create a file called index.rst. Leave this file blank for now.

  3. Open the index.rst file under the top-level directory. Its first lines are:

    .. toctree::
   :maxdepth: 2

   foreword/index
   introduction/index

You will note that this is a list of directory names, followed by the name index. This directs the top-level index file to the index files in each directory. The order in which they are listed determines the order they will have in the document.

  1. Ajoutez le nom de votre nouveau module (c’est-à-dire le nom que vous avez donné au nouveau répertoire), suivi par /index, à cette liste, là où vous voulez que votre module apparaisse.

  2. Souvenez-vous de garder l’ordre des modules logique, de telle sorte que les modules suivants s’appuient sur la connaissance présentée dans les modules précédents.

  3. Ouvrez le fichier index de votre nouveau module ([module name]/index.rst).

  4. Along the top of the page, create the module heading:

    1. write a first line of asterisks (*).

    2. Follow this with a line containing the markup phrase Module:, followed by the name of your module.

    3. End this off with another line of same number of asterisks.

    Note

    The underline and the overline should not be shorter than the line containing the module title.

  5. Laissez une ligne ouverte sous ça.

  6. Écrivez un court paragraphe expliquant la fonction et le contenu de ce module.

  7. Laissez une ligne ouverte, puis ajoutez le texte suivant:

    .. toctree::
   :maxdepth: 2

   lesson1
   lesson2

    … où :lesson1, lesson2, etc., sont les noms de vos leçons prévues.

Le fichier index au niveau du module ressemblera à ceci :

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. Ajout d’une leçon

Pour ajouter une leçon à un module existant ou non:

  1. Ouvrez le répertoire du module.

  2. Open the index.rst file (created above in the case of new modules).

  3. Assurez-vous que le nom de la leçon prévue est listé sous la directive toctree, comme montré ci-dessous.

  4. Créez un nouveau fichier sous le répertoire du module.

  5. Name this file exactly the same as the name you provided in the module’s index.rst file, and add the extension .rst.

Note

For editing purposes, a .rst file works exactly like a normal text file (.txt).

  1. Pour commencer à écrire la leçon, écrivez l’expression de balisage Lesson:, suivie du nom de la leçon.

  2. In the next line, write a line of equal signs (=), not shorter than the lesson title.

  3. Laissez une ligne ouverte après ceci.

  4. Écrivez une courte description du but recherché de la leçon.

  5. Incluez une introduction générale au sujet. Regardez les leçons existantes dans ce manuel pour les exemples.

  6. Sous cela, commencez un nouveau paragraphe, débutant avec cette phrase

    **The goal for this lesson:**

  7. Expliquez brièvement le résultat escompté à la fin de cette leçon.

  8. Si vous ne pouvez pas décrire le but de la leçon en une ou deux phrases, envisagez de couper le sujet en plusieurs leçons.

Chaque leçon sera subdivisée en plusieurs sections, qui seront traitées après.

19.5. Ajout d’une nouvelle section

Il existe deux types de sections: « Étape par étape » et « Essayez vous-même ».

  • Une section « Etape par étape » est un ensemble détaillé d’instructions destinées à apprendre au lecteur comment utiliser tel ou tel aspect de QGIS. Cela se fait habituellement en donnant les instructions clic-par-clic aussi claires que possible, entrecoupées de captures d’écran.

  • A « try yourself » section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer box beneath, which will show or explain how to complete the assignment, and will show the expected outcome if possible.

Chaque section est accompagnée d’un niveau de difficulté. Une section facile est désignée par ★☆☆, modérée par ★★☆ et avancée par ★★★.

19.5.1. Ajout d’une section « Etape par étape »

  1. Pour commencer cette section, écrivez la balise du niveau de difficulté prévu (comme montré ci-dessus).

  2. Laissez un espace puis écrivez Follow Along:.

  3. Laissez un autre espace et écrivez le nom de la section (utilisez seulement une initiation en majuscule, ainsi que les capitales pour les noms propres).

  4. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  5. Écrivez une courte introduction à la section, expliquant ses objectifs. Puis donnez des instructions détaillées (clic-pa-clic) sur la procédure à être démontrée.

  6. Dans chaque section, incluez des liens internes, des liens externes et des captures d’écran au besoin.

  7. Essayez de clore toute section avec un court paragraphe qui la conclut et fait naturellement un lien vers la section suivante, si possible.

19.5.2. Ajout d’une section « Essayez vous-même »

  1. Pour commencer cette section, écrivez la balise du niveau de difficulté prévu (comme montré ci-dessus).

  2. Laissez un espace puis écrivez Try Yourself:.

  3. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  4. Expliquez l’exercice que vous voulez que le lecteur fasse. Référez-vous aux sections, leçons ou modules précédents si nécessaire.

  5. Incluez des captures d’écran pour clarifier les exigences si une description textuelle n’est pas claire.

In most cases, you will want to provide an answer regarding how to complete the assignment given in this section. To do so, you will need to create and feed an answer block beneath the instructions.

  1. First, create the custom collapsible widget that contains the answer:

    .. admonition:: Answer
   :class: dropdown

  2. Keeping an indentation with regard to the above block, write the instructions on how to complete the assignment, using links and images where needed.

19.6. Ajout d’une conclusion

To end a lesson:

  1. Écrivez l’expression Conclusion, suivie d’une nouvelle ligne de tirets (-).

  2. Écrivez une conclusion pour la leçon, expliquant les concepts traités dans la leçon.

19.7. Ajout d’une section Pour aller plus loin

Cette section est optionnelle.

  • Write the phrase Further Reading, followed by a new line of minuses/dashes (-).

  • Incluez des liens vers des sites externes appropriés.

19.8. Ajout d’une section La suite ?

  1. Write the phrase What's Next?, followed by a new line of minuses/dashes (-).

  2. Expliquez comment cette leçon a préparé les étudiants à la prochaine leçon ou au prochain module.

  3. Pensez à changer la section « La suite ? » de la précédente leçon si nécessaire, afin qu’elle fasse référence à votre leçon. Cela sera nécessaire si vous avez inséré une nouvelle leçon entre les leçons déjà existantes, ou après une leçon existante.

19.9. Utilisation des balises

Pour adopter les standards de ce document, vous devrez ajouter des balises standards à votre texte.

19.9.1. Nouveaux concepts

If you are explaining a new concept, you will need to write the new concept’s name in italics by enclosing it in asterisks (*).

This sample text shows how to introduce a *new concept*.

19.9.2. Accentuation

  • To emphasize a crucial term which is not a new concept, write the term in bold by enclosing it in double asterisks (**).

  • Utilisez cela avec modération ! Si vous l’utilisez trop, il peut sembler au lecteur que vous criez ou que vous êtes condescendant.

This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**

19.9.3. Images

  • When adding an image, save it to an img folder next to the lesson file.

  • Incluez-la dans le document comme ceci

    .. figure:: img/image_file.extension
   :align: center

  • Souvenez-vous de laisser une ligne vide en-dessus et en-dessous de la balise de l’image.

19.9.6. Utilisant du texte mono-espacé

  • When you are writing text that the user needs to enter, a path name, or the name of a database element such as a table or column name, you must write it in monospaced text. For example:

    Enter the following path in the text box: ``path/to/file``.

19.9.7. Étiqueter les éléments de l’interface

  • Quand vous faites référence à un élément de l’interface, comme un bouton, vous devez écrire son nom dans le format des éléments de l’interface. Par exemple :

    To access this tool, click on the :guilabel:`Tool Name` button.

  • Cela s’applique également si vous mentionnez le nom d’un outil sans obliger l’utilisateur à cliquer sur un bouton.

19.9.9. Ajout de notes

  • You might need to add a note in the text, which explains extra details that can’t easily be made part of the flow of the lesson. This is the markup:

    [Normal paragraph.]

.. note:: Note text.
  New line within note.

  New paragraph within note.

[Unindented text resumes normal paragraph.]

19.9.10. Ajouter une note sur l’auteur ou le sponsor

Si vous écrivez un nouveau module, une nouvelle leçon ou une section par le financement d’un sponsor, vous devez y inclure un message de leur choix. Cela indique au lecteur le nom du sponsor et il doit apparaître en dessous de l’entête du module, de la leçon ou de la section sponsorisé(e). Néanmoins, il ne s’agit pas d’une publicité pour leur entreprise.

If you have volunteered to write a module, lesson or section in your own capacity, and not on behalf of a sponsor, you may include an authorship note below the heading of the module, lesson or section that you authored. This must take the form This [module/lesson/section] contributed by [author name]. Do not add further text, contact details, etc. Such details are to be added in the « Contributors » section of the Foreword, along with the name(s) of the part(s) you added. If you only made enhancements, corrections and/or additions, list yourself as an editor.

19.10. Merci !

Merci de votre contribution à ce projet ! En contribuant, vous rendez QGIS plus accessible aux utilisateurs et ajoutez de la valeur au projet QGIS dans son ensemble.