Aller au contenu
For the complete DHIS2 documentation index, see llms.txt.

Guide sur la documentation du DHIS 2

Présentation du système de documentation du DHIS 2

Le DHIS 2 est un système de gestion de l'information basé sur le web, qui fait l'objet d'un développement très actif, avec généralement deux versions majeures par an. Chaque version comprend généralement quelques nouveautés et des fonctionnalités supplémentaires. Compte tenu de la rapidité du développement, du grand nombre d'utilisateurs et de la distribution du système à l'échelle mondiale, un système de documentation détaillé est requis.

Dans ce chapitre, nous allons décrire le système de documentation du DHIS 2 et comment vous pouvez y contribuer.

Introduction

La documentation du DHIS 2 est rédigée au format Markdown [Commonmark] (https://commonmark.org). L'un des principaux avantages du format Markdown est que le contenu et la présentation sont totalement séparés. Commonmark est une spécification fortement définie et hautement compatible du format Markdown. Étant donné que le format Markdown peut être transformé en une grande variété de formats (HTML, PDF, etc.) et qu'il est basé sur du texte, il est idéal pour la documentation du système.

Il existe une large gamme d'éditeurs de texte qui peuvent être utilisés pour la création de fichiers Markdown. Pour Linux et Windows, ghostwriter est une bonne option ; il est gratuit et prend en charge l'aperçu par page double et les feuilles de style personnalisées.

L'un des concepts clés à prendre en compte lors de la conception d'une documentation au format Markdown ou dans d'autres formats de présentation neutre est que le contenu du document doit être traité en premier lieu. La présentation du document se fera dans une étape de transformation distincte, au cours de laquelle le texte source sera rendu dans différents formats, tels que HTML et PDF. Le document doit donc être bien organisé et structuré, en tenant compte des balises et des éléments de structure appropriés.

Il est conseillé de subdiviser le document en plusieurs sections à l'aide des en-têtes de section. De cette façon, les chapitres très complexes pourront être subdivisés en éléments plus petits et plus faciles à gérer. Ce concept est pratiquement identique à celui de Microsoft Word ou d'autres programmes de traitement de texte. Le processus se chargera automatiquement de la numérotation des sections lors de la conception du document.

Premiers pas avec GitHub

Le système de documentation du DHIS 2 est géré sur [GitHub] (https://github.com/dhis2) à travers une variété de dépôts de code source. GitHub est une plateforme qui permet à plusieurs personnes de collaborer sur des projets de logiciels. Pour ce faire, un système de contrôle de version est nécessaire pour gérer toutes les modifications que les utilisateurs peuvent apporter. GitHub utilise le système de contrôle de source git. Bien que ce document ne décrive pas les fonctionnalités de git, les utilisateurs qui souhaitent produire de la documentation devront au minimum comprendre les principes de base du fonctionnement du système. Une orientation de base est fournie à cet effet dans la section suivante. Le lecteur est invité à consulter le [git manual] (https://git-scm.com/book/en/v2) pour plus d'informations.

Pour pouvoir commencer à faire des ajouts ou à apporter des modifications à la documentation, vous devez d'abord procéder à une extraction du code source. Si vous n'avez pas encore de compte GitHub, vous devez en créer un. Vous pouvez le faire [ici] (https://github.com/). Une fois inscrit sur GitHub, vous devrez demander l'accès au groupe dhis2-documenters si vous souhaitez modifier directement le code source de la documentation. Cependant, tout le monde peut cloner la documentation dans son propre référentiel, lui apporter des modifications et demander à ce que ces modifications soient intégrées au code source de la documentation via une demande de fusion (pull request) au référentiel principal.

La structure du site de documentation est définie dans le référentiel de construction dhis2-docs-builder. Si vous souhaitez apporter votre contribution à la structure, des modifications seront requises ; cela ne concerne généralement que l'équipe interne du DHIS2.

Conseil

La meilleure façon de trouver la source du document que vous souhaitez modifier est de le chercher sur le site Web docs.dhis2.org. Lorsque vous le trouvez, cliquez sur l'icône "Modifier" en haut de la page.

Obtenir la source du document

Pour pouvoir modifier la documentation, vous devez télécharger la source de la documentation sur votre ordinateur. GitHub utilise un système de contrôle de version appelé Git. Il existe différentes méthodes pour faire fonctionner Git sur votre système, en fonction du système d'exploitation que vous utilisez. Un bon guide détaillé sur les systèmes d'exploitation Microsoft peut être consulté [ici] (https://help.github.com/articles/getting-started-with-github-for-windows). Par ailleurs, si la ligne de commande vous convient, vous pouvez télécharger Git à partir de cette page. Si vous utilisez Linux, vous devrez installer Git sur votre système via votre gestionnaire de packages ou à partir du code source. Une référence très complète sur l'utilisation de git est disponible sous plusieurs formats différents ici.

Une fois que vous avez installé Git sur votre système, vous devrez télécharger la source du document. Suivez cette procédure :

  1. Assurez-vous que Git est installé.

  2. Dans les systèmes Windows, visitez l'URL du dépôt concerné et cliquez sur "Cloner dans le bureau". Si vous utilisez la ligne de commande, tapez simplement git clone git@github.com:dhis2/dhis2-docs.git (notez que dans cet exemple dhis2 est le propriétaire du dépôt et dhis2-docs est le nom du dépôt)

  3. Le processus de téléchargement devrait commencer et tous les fichiers source de la documentation seront téléchargés dans le dossier que vous avez spécifié.

  4. Une fois que vous avez les sources, assurez-vous de créer votre propre branche pour l'éditer. Exécutez simplement git checkout -b mybranchmybranch est le nom de la branche que vous souhaitez créer.

Modifier la documentation

Lorsque vous rédigez ou modifiez la documentation, il existe quelques conventions clés spécifiques au projet dont vous devez tenir compte. Elles sont décrites dans cette section. De plus, plusieurs extensions Markdown sont implémentées et présentées pour des raisons pratiques dans la section [Markdown support and extensions] (Prise en charge du Markdown et extensions) (#markdown_support_and_extensions) plus loin dans ce document.

Utiliser les images

Les ressources images doivent être placées dans un sous-dossier en lien avec document en cours d'édition. Par exemple, pour le chapitre content/android/android-event-capture-app.md, les images se trouvent dans le dossier content/android/resources/images/<rest-of-path> et sont référencées de la manière suivante ![](resources/images/<rest-of-path>)

modeler les images

Si vous souhaitez contrôler l'alignement et la taille des images, vous pouvez profiter d'une extension Markdown que nous utilisons. Il vous permet de définir des attributs tels que la largeur, la hauteur et la classe entre accolades à la fin de la définition de l'image. Par exemple:

![](resources/images/maintainence/predictor_sequential.png){ largeur=50% }
fera de votre image 50 % de la largeur de la page (il est préférable d'utiliser des pourcentages pour prendre en charge une variété de formulaires de sortie), tandis que
![](resources/images/maintainence/predictor_sequential.png){ .largeur du centre=50% }
va également centrer l'image sur la page (en raison de la définition de la classe .center en css).

Lorsque les images sont écrites comme

![Approuver et accepter](resources/images/data_approval/approval_level_steps.png)
C'est-à-dire qu'avec la mention entre crochets, ils sont rendus sous forme de figures avec des mentions. Ceux-ci sont centrés par défaut, avec une mention centrée en italique.

Faire des captures d'écran

Pour les captures d'écran de l'interface Web de DHIS 2, nous vous recommandons d'utiliser le navigateur Chrome, avec les deux extensions suivantes : 1. Window Resizer. Utilisez ceci pour régler la résolution sur 1440x900 2. Fireshot. Utilisez ceci pour créer rapidement un instantané de la partie visible

Fireshot peut même capturer toute la page, c'est-à-dire en la faisant défiler, si vous le souhaitez. Il peut également capturer uniquement une zone sélectionnée (mais la largeur maximale doit toujours être de 1440px)

Lorsque vous faites des captures d'écran avec l'application Android, la taille doit être définie sur 360x640.

Localiser les images

La localisation des images est possible si les versions d'une image spécifiques à une langue sont stockées à côté de l'image d'origine. Le nom du fichier doit être le même que celui de la version originale en anglais, mais doit inclure _ plus le code de la langue à la fin du nom, avant l'extension.

Par exemple, si vous voulez avoir une version française de ressources/images/my_screenshot.png Vous pouvez simplement créer la version française et l'enregistrer sous ressources/images/my_screenshot_fr.png

Le lien dans la documentation doit toujours renvoyer à l'image originale. Lorsque le site de la documentation prend en charge chacune des langues, les images localisées seront identifiées et utilisées à la place des images originales en anglais.

Le code de langue est la première partie de l'URL que vous voyez après "docs.dhis2.org/" lorsque vous consultez la version localisée de la documentation. Au moment de la rédaction, par exemple, nous avons fr, es_419, pt, cs et zh.

Références de section

Afin de fournir des références fixes (ancres) dans la documentation, nous pouvons définir une chaîne de texte fixe qui sera appliquée à toutes les sections. Avec notre processeur Markdown, cela se fait par ajout d'un identifiant de hachage entre les crochets, à la fin de la ligne comportant le titre de la section, par exemple

## Validation { #webapi_validation }

Pour générer un résumé de validation des données, vous pouvez faire interagir ...

Définit l'identifiant de section de l'en-tête de niveau 2 Validation sur "webapi_validation", qui peut alors être référencé comme "#webapi_validation" à partir de tout fichier html.

Remarque

Afin de permettre la création de liens par référence d'ancre à partir d'autres documents, essayez de garder les identifiants de section uniques. Par exemple, si "#webapi_validation" est unique dans toute la documentation, vous pouvez y faire référence à partir de n'importe quelle autre partie de la documentation en utilisant simplement [nom du lien](#webapi_validation). Si l'identifiant de la section référencée n'est pas unique, le processeur document tentera de résoudre l'ancre la plus proche avec ce nom. Lorsque le fichier de liaison appartient à une version spécifique, le processeur ignorera les ancres appartenant à des versions différentes.

Attention

Notre documentation est compilée à la fois en pages et en documents complets. Pour cette raison, il n'est pas conseillé d'inclure des chemins d'accès dans les références inter-documents. Veuillez utiliser des identifiants de section uniques, comme décrit ci-dessus, afin que les liens soient correctement définis dans les deux types de documents.

Veuillez suivre la convention des lettres minuscules et des traits de soulignement, afin de créer des identifiants qui servent également de noms de fichiers lorsque nous procédons à un fractionnement des fichiers comme partie intégrante du processus de génération du document.

Tableaux

En tant qu'extension du Commonmark pur, sont également pris en charge les tableaux GFM (définis avec des canaux de communication|), tels que:

| Type de tableau | Descriptif |
|:--|:----|
|Commonmark (HTML)| Tableaux décrits en HTML pur |
|Github Flavour Markdown (GFM) | Tableaux décrits avec des canaux de communication : plus faciles à lire/éditer, mais limités en complexité |

qui produit une sortie comme:

Type de tableau Description
Commonmark (HTML) Tableaux décrits en HTML pur
Github Flavour Markdown (GFM) Tableaux décrits avec des canaux de communication : plus faciles à lire/éditer, mais limités en complexité

Les tableaux simples sont bien plus faciles à utiliser. Ils se limitent à une seule ligne de texte (c'est-à-dire que chaque rangée doit occuper une seule ligne), mais vous pouvez, par exemple, utiliser les tags <br> pour créer des sauts de ligne et si nécessaire, scinder les paragraphes à l'intérieur des cellules. Vous pouvez également continuer à utiliser les tableaux HTML lorsque vous avez vraiment besoin d'une plus grande complexité (mais vous pouvez également vous demander s'il existe une meilleure façon de présenter les données).

Bibliographie du DHIS 2

Pour l'instant, les références bibliographiques ne sont pas prises en charge dans la version Markdown de la documentation DHIS 2.

Gestion d'une documentation multilingue

La documentation DHIS 2 a été traduite dans plusieurs langues différentes, notamment le français, l'espagnol et le portugais. Si vous souhaitez
traduire la documentation ou contribuer à l'une des traductions existantes, veuillez contacter l'équipe chargée de la documentation du DHIS 2 via l'e-mail fourni à la fin de ce chapitre.

Validation de vos modifications sur GitHub

Après avoir édité votre document, vous devez valider vos modifications sur GitHub. Ouvrez une invite de commande sur Windows ou un shell sur Linux, et accédez au dossier dans lequel vous avez placé votre documentation. Si vous avez ajouté de nouveaux fichiers ou dossiers à votre répertoire local, vous devrez les ajouter à l'arborescence source avec la commande git add, suivie du/des nom(s) du/des dossier(s) ou du/des fichier(s) que vous avez ajouté. Assurez-vous d'inclure un commentaire descriptif lors de votre validation.

git commit -m "Documentation améliorée sur les importations d'unités d'organisation avec CSV."

Enfin, vous devez pousser les modifications vers votre référentiel avec la commande git push origin mybranch, où "mybranch" est le nom de la branche que vous avez créée lorsque vous avez extrait le document source ou sur laquelle vous êtes en train de travailler. Pour ce faire, vous aurez besoin des autorisations requises pour confirmer vos modifications dans le référentiel. Une fois les modifications confirmées, [vous pouvez faire une demande de fusion] (https://github.com/dhis2/dhis2-docs/pulls) pour qu'elles soient fusionnées avec la branche principale (master branch). Vos modifications seront examinées par l'équipe chargée de la documentation principale et testées pour s'assurer de leur pertinence, ainsi que de leur qualité. Comme mentionné précédemment, vous pouvez également ajouter vos modifications à votre propre référentiel GitHub, si vous n'avez pas accès au référentiel principal, et faire une demande d'intégration pour que vos modifications soient intégrées à la branche principale.

Si vous avez des questions ou si vous avez du mal à vous en sortir, posez simplement une question sur notre communauté de pratique de développement.

Prise en charge du Markdown et extensions

Cette section tente de capturer le Markdown et les extensions qui sont prises en charge dans le cadre de la documentation du DHIS 2, et de fournir un aperçu des styles appliqués.

Titre h3

Titre h4

Titre h5
Titre h6

Corps du texte.

Règles horizontales

___

---

***



Importance{ #emphasis }

Ce texte est en gras

Ce texte est en gras

Ce texte est en italique

Ce texte est en italique

Barré

Blocs de citations

Les blocs de citations peuvent également être insérés...

...en utilisant d'autres signes supérieurs côte à côte...

... ou avec des espaces entre les flèches.

> Les blocs de citations peuvent également être insérés...
>> ...en utilisant d'autres signes supérieurs côte à côte...
> > > ... ou avec des espaces entre les flèches.

Code

code incorporé

Code incorporé mis en évidencevar test = 0; fait dans

`#!js var test = 0;`

Code indenté

// Certains commentaires
ligne 1 du code
ligne 2 du code
ligne 3 du code

Code de bloc "clôtures"

Texte d'exemple ici...

Mise en évidence de la syntaxe

var foo = fonction (barre) {
  barre de retour++;
};

console.log(foo(5));

Longues lignes

Buffle buffle (les animaux appelés "buffle" de la ville de Buffle) [qui] Buffle buffle buffle (que les animaux de la ville intimident) buffle Buffalo buffle (intimident ces animaux dans cette ville).

Mise en surbrillance de lignes spécifiques

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
``` py hl_lines="2 3"
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
```

Ajouter un titre

bubble_sort.py
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
``` py hl_lines="2 3" title="bubble_sort.py"
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
```

Listes

Non ordonné

  • Créez une liste en commençant une ligne par +, - ou *
  • Les sous-listes sont générées en indentant 2 espaces :
    • Le changement de caractère marqueur force le début d'une nouvelle liste :

      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet

        an indented code block
        
      • Nulla volutpat aliquam velit

      • Très facile!

Ordonné

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa

  4. Vous pouvez utiliser des numéros séquentiels...

  5. ... ou conservez tous les numéros comme au 1.

Commencer la numérotation avec un décalage ? :

  1. foo
  2. bar

Multi-niveaux

  1. premier élément
  2. encore premier niveau
    1. deuxième niveau
    2. encore deuxième
      1. troisième niveau
        a block of code at the third level
        
      2. encore troisième niveau
    3. à nouveau deuxième niveau
  3. retour au premier niveau
    1. deuxième
      1. Oh, arrêtez !

Tableaux

Paramètre de retour Description
aoc Identifiant de combinaison d'options d'attributs
pe Identifiant de période
ou Identifiant d'unité d'organisation
autorisations Les autorisations : 'mayApprove' (peut approuver), 'mayUnapprove'(peut désapprouver), 'mayAccept' (peut accepter), 'mayUnaccept' (peut ne pas accepter) et 'mayReadData' (peut lire les données) (mêmes définitions que pour obtenir le statut d'approbation unique.)
État Un des états d'approbation des données (comme pour obtenir un statut d'approbation unique.)
wf Identifiant du workflow d'approbation des données

Colonnes alignées à droite et centrées

Paramètre de retour Description
aoc Identifiant de combinaison d'options d'attributs
pe Identifiant de période
ou Identifiant d'unité d'organisation
autorisations Les autorisations : 'mayApprove' (peut approuver), 'mayUnapprove'(peut désapprouver), 'mayAccept' (peut accepter), 'mayUnaccept' (peut ne pas accepter) et 'mayReadData' (peut lire les données) (mêmes définitions que pour obtenir le statut d'approbation unique.)
État Un des états d'approbation des données (comme pour obtenir un statut d'approbation unique.)
wf Identifiant du workflow d'approbation des données

link text

lien avec le titre

Lien converti automatiquement https://github.com/dhis2

Images

Les images sont affichées en taille réelle avec une largeur maximale de 100 %

![](resources/images/dhis2_screenshots.jpg)

L'ajout d'un titre rend automatiquement le résultat sous forme de figure. Les classes et les styles incorporés peuvent être ajoutés entre accolades.

![Le titre](resources/images/dhis2_screenshots.jpg){ .largeur du centre=50% }

Le titre

Youtube

Les vidéos Youtube peuvent être intégrées de la même manière que les images. Mettez simplement le lien d'intégration de la vidéo Youtube au lieu d'un fichier image

![](https://www.youtube.com/embed/UqXSMaXBtD8)

Remarque

Assurez-vous d'utiliser le lien d'"intégration" youtube!

Comme avec les images, l'ajout d'un titre rendra la vidéo sous forme de figure

![DHIS2 : Informations pour l'action](https://www.youtube.com/embed/UqXSMaXBtD8)

DHIS2 : Informations pour l'action

Avertissements{ #admonitions }

Les avertissements suivants sont pris en charge, avec des styles prédéfinis, en plus des blocs de citations généraux.

Remarque

Remarque

Une note contient des informations supplémentaires qui doivent être prises en compte ou une référence vers plus d'informations potentiellement utiles.

> **Note**
>
> A note contains additional information which should be considered or a
> reference to more information which may be helpful.

Conseil

Astuce

Une astuce peut être utile, par exemple comment effectuer une tâche particulière plus efficacement.

> **Tip**
>
> A tip can be a useful piece of advice, such as how to perform a
> particular task more efficiently.

Important

Important

Les informations importantes ne doivent pas être ignorées. Elles indiquent généralement des éléments nécessaires à l'application.

> **Important**
>
> Important information should not be ignored, and usually indicates
> something which is required by the application.

Attention

Attention

Les informations contenues dans ces sections doivent être pris en compte. Dans le cas contraire, des résultats inattendus peuvent survenir dans l'analyse, la performance ou les fonctionnalités.

> **Caution**
>
> Information contained in these sections should be carefully
> considered, and if not heeded, could result in unexpected results in
> analysis, performance, or functionality.

Avertissement

Attention

Si les informations contenues dans ces sections ne sont pas prises en compte, cela pourrait entraîner une perte permanente des données ou rendre moins facile l'utilisation du système en général.

> **Warning**
>
> Information contained in these sections, if not heeded, could result
> in permanent data loss or affect the overall usability of the system.

Travail en cours

Travail en cours

Les informations contenues dans ces sections indiqueront les problèmes ou erreurs sur lesquels nous travaillons actuellement.

> **Work In Progress**
>
> Information contained in these sections, will indicate that these are issues or errors we are currently working on.

Exemple

Exemple

Une façon de porter une attention particulière aux exemples.

Les avertissements peuvent inclure des blocs de code

var foo = fonction (barre) {
barre de retour++ ;
} ;

console.log(foo(5));
> **Example**
>
> A way to bring special attention to examples.
>
> Admonitions can include a code blocks
>
> ```js
> var foo = function (bar) {
>   return bar++;
> };
>
> console.log(foo(5));
> ```

Équations mathématiques

MathJax permet d'afficher du contenu mathématique dans le navigateur en prenant en charge la composition mathématique sous diverses formes (par exemple LaTeX, MathML, AsciiMath).

Les blocs doivent être entourés de \[ ... \] ou $$ ... $$ ou \commencer{} ... \se terminer{} sur des lignes séparées. Les blocs incorporés doivent être entourés de $...$ ou \(...\).

\[ Indicateur = {\frac{BcgVaccinationsMoinsD'unAn}{PopulationCibleMoinsD'unAn}} \times 100 \]
\[3 < 4\]
\[\begin{align} p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\ p(h_j=1|\mathbf{v}) & = \sigma\left(\sum_i w_{ij}v_i + c_j\right) \end{align}\]

L'équation d'onde pour \( u \) est

\begin{équation} \frac{\partial^2u}{\partial t^2} = c2\nabla2u \end{équation}

\( \nabla^2 \) est le laplacien spatial et \( c \) est constant.

Cette équation \(p(x|y) = \frac{p(y|x)p(x)}{p(y)}\) est inline.

L'homomorphisme \(f\) est injectif si et seulement si son noyau n'est que l' ensemble singleton \(e_G\), car sinon \(\existe a,b\in G\) avec \(a\neq b\) tel que \(f(a)=f(b)\).

\[
Indicator = {\frac{BcgVaccinationsUnder1Year}{TargetPopulationUnder1Year}} \times 100
\]

\[3 < 4\]

\begin{align}
    p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\
    p(h_j=1|\mathbf{v}) & = \sigma\left(\sum_i w_{ij}v_i + c_j\right)
\end{align}

The wave equation for \( u \) is

\begin{equation}
  \frac{\partial^2u}{\partial t^2} = c^2\nabla^2u
\end{equation}

where \( \nabla^2 \) is the spatial Laplacian and \( c \) is constant.

This equation $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$ is inline.

The homomorphism $f$ is injective if and only if its kernel is only the 
singleton set $e_G$, because otherwise $\exists a,b\in G$ with $a\neq b$ such that $f(a)=f(b)$.

Remplacements typographiques

Markdown Résultat
(tm)
(c) (c)
(r) ®
c/o
+/- ±
-->
<--
<-->
=/=
1/4, etc. ¼, etc.
1er 2ème etc. 1er 2ème etc

Indice inférieur / Indice supérieur

- 19^th^
- H~2~O
  • 19th
  • H2O

++Texte inséré++

Texte marqué

Notes de bas de page

Lien de la note de bas de page 1[^premier].

Lien de la note de bas de page 2[^deuxième].

Définition de la note de bas de page inline ^ [Texte de la note de bas de page inline].

Référence de note de bas de page dupliquée[^deuxième].

Listes des définitions

Terme 1
Définition 1 avec une continuation paresseuse.
Terme 2 avec balisage inline

Définition 2

{ quelques codes font partie de la définition 2 }

Troisième paragraphe de la définition 2.

Keys

Keys une extension qui facilite la saisie et le design des touches du clavier. D'un point de vue syntaxique, les touches sont constituées autour du symbole +. Une touche ou une combinaison de touches est entourée de ++, chaque touche étant séparée des autres par un +.

Exemple

++ctrl+alt+suppr++.

++ctrl+alt+suppr++

Le rendu de clé suivant est pris en charge.

Nom Affichage Pseudonymes
alt Alt
left-alt Left Alt lalt
right-alt Right Alt ralt
alt-graph AltGr altgr
command Cmd cmd
left-command Left Command lcommand, lcmd, left-cmd
right-command Right Command rcommand, rcmd, right-cmd
control Ctrl ctrl
left-control Left Ctrl lcontrol, lctrl, left-ctrl
right-control Right Ctrl rcontrol, rctrl, right-ctrl
function Fn fn
meta Meta
left-meta Left Meta lmeta
right-meta Right Meta rmeta
option Option opt
left-option Left Option loption, lopt, left-opt
right-option Right Option roption, ropt, right-opt
shift Shift
left-shift Left Shift lshift
right-shift Right Shift rshift
super Super
left-super Left Super lsuper
right-super Right Super rsuper
windows Win win
left-windows Left Win lwindows, left-win, lwin
right-windows Right Win rwindows, right-win, rwin
Nom Affichage Pseudonymes
f1 F1
f2 F2
f3 F3
f4 F4
f5 F5
f6 F6
f7 F7
f8 F8
f9 F9
f10 F10
f11 F11
f12 F12
f13 F13
f14 F14
f15 F15
f16 F16
f17 F17
f18 F18
f19 F19
f20 F20
f21 F21
f22 F22
f23 F23
f24 F24
Nom Affichage Pseudonymes
0 0
1 1
2 2
3 3
4 4
5 5
6 6
7 7
8 8
9 9
a A
b B
c C
d D
e E
f F
g G
h H
i I
j J
k K
l L
m M
n N
o O
p P
q Q
r R
s S
t T
u U
v V
w W
x X
y Y
z Z
espace ++espace++ spc

Nom | Affichage | Pseudonymes

--------------- | ----------------- | ------- barre oblique inverse | ++barre oblique inverse++ | bar | | | barre verticale accolade gauche | ++accolade-gauche++ | accolade ouverte accolade droite | ++accolade droite++ | fermer la parenthèse parenthèse-gauche | ++parenthèse-gauche++ | parenthèse ouverte parenthèse droite | ++parenthèse-droite++ | fermer la parenthèse deux points | ++deux-points++ | virgule | ++virgule++ | guillemets doubles | ++guillemet double++ | dblquote égal | ++égal++ | exclamation | ! | exclamation grave | ` | accent grave plus grand | ++plus grand++ | supérieur à, gt moins | ++moins++ | inférieur à, lt moins | ++moins++ | trait d'union période | ++période++ | plus | + | question | ? | point d'interrogation point-virgule | ++point-virgule++ | guillemet simple | ++apostrophe++ | barre oblique | ++barre oblique++ | tilde | ~ | tiret bas | ++tiret bas++ |

Name Affichage Pseudonymes
flèche vers le haut ++flèche vers le haut++ vers le haut
flèche vers le bas ++flèche vers le bas++ vers le bas
flèche-gauche ++flèche-gauche++ gauche
flèche-droite ++flèche-droite++ droit
page précédente ++page précédente++ prior, page précédente, pg-up
page suivante ++page suivante++ suivant, page-dn, pg-dn
accueil ++accueil++
fin ++fin++
onglet ++onglet++ tabulateur
Nom Affichage Pseudonymes
retour arrière ++retour arrière++ retour, bksp
supprimer ++supprimer++ sup
insérer ++insérer++ ins
Nom Affichage Pseudonymes
pause Pause annuler
verrouillage des majuscules ++verrouillage des majuscules++ capitale, cplk
clair Clear clr
éjecter ++éjecter++
entrer Enter retourner
échapper ++échapper++ éch
aide ++aide++
écran d'impression ++écran d'impression++ prtsc
arrêt-défilement Scroll Lock faire défiler
Nom Affichage Pseudonymes
num0 Num 0
num1 Num 1
num2 Num 2
num3 Num 3
num4 Num 4
num5 Num 5
num6 Num 6
num7 Num 7
num8 Num 8
num9 Num 9
num-astérisque ++num-astérisque++ multiplier
num-clair ++num-clair++
num-supprimer ++num-supprimer++ num-sup
num-égal ++num-égal++
verrouillage numérique ++verr-num++ numlk, numlock
num-moins ++num-moins++ soustraire
num-plus Num + ajouter
num-séparateur ++num-séparateur++ décimal, séparateur
num-slash Num / diviser
num-entrer ++num-entrer++
Nom Affichage Pseudonymes
backtab Back Tab bktab
navigateur-retour ++navigateur-retour++
favoris du navigateur ++ favoris du navigateur ++ favoris
navigateur-avant ++navigateur-avant++ avant
accueil-navigateur ++accueil-navigateur++
rafraîchissement-navigateur ++ rafraîchissement-navigateur ++ rafraîchir
recherche-navigateur ++recherche-navigateur++ rechercher
navigateur-arrêt ++navigateur-arrêt++
copier ++copier++
menu contextuel ++menu contextuel++ applications, menu
empreinte digitale ++empreinte digitale++ empreinte digitale
mail Mail lancer-mail
média ++média++ lancer-media
media-piste-suivante ++media-piste-suivante++ piste suivante
média-pause Pause mettre en pause
lecture-media ++lecture-media++ lecture
media-lecture-pause ++media-lecture-pause++ lecture-pause
media-piste-précédente ++media-piste-précédente++ piste-précédente
media-arrêt ++media-arrêt++ arrêter
pouvoir ++pouvoir++
imprimer ++imprimer++
réinitialiser ++réinitialiser++
sélectionner ++sélectionner++
veille ++veille++
volume-bas ++volume-bas++ vol-bas
volume-muet ++volume-muet++ muet
augmenter-volume ++augmenter-volume++ augmenter-volume
zoomer ++zoomer++
Nom Affichage Pseudonymes
bouton gauche ++bouton-gauche++ lbouton
bouton du milieu ++bouton du milieu++ mbouton
bouton droit ++bouton droit++ rbouton
bouton-x1 ++x-bouton1++ xbouton1
x-bouton2 ++x-bouton2++ xbouton2

Émojis

Plusieurs ensembles d'emojis sont pris en charge en saisissant le nom de l'emoji entouré de deux-points: par exemple, :smile:. Vous trouverez ci-dessous la liste des ensembles communs ; ceux qui n'ont pas de résultats ne sont actuellement pas pris en charge.

:bowtie: 😄 😆 😊 😃 ☺️ 😏 😍 😘 😚 😳 😌 😆 😁 😉 😜 😝 😀 😗 😙 😛 😴 😟 😦 😧 😮 😬 😕 😯 😑 😒 😅 😓 😥 😩 😔 😞 😖 😨 😰 😣 😢 😭 😂 😲 😱 :neckbeard: 😫 😠 😡 😤 😪 😋 😷 😎 😵 👿 😈 😐 😶 😇 👽 💛 💙 💜 ❤️ 💚 💔 💓 💗 💕 💞 💘 💖 ✨ ⭐ 🌟 💫 💥 💥 💢 ❗ ❓ ❕ ❔ 💤 💨 💦 🎶 🎵 🔥 💩 💩 💩 👍 👍 👎 👎 👌 👊 👊 ✊ ✌️ 👋 ✋ ✋ 👐 ☝️ 👇 👈 👉 🙌 🙏 👆 👏 💪 🤘 🖕 🚶 🏃 🏃 👫 👪 👬 👭 💃 👯 🙆‍♀️ 🙅 💁 🙋 👰‍♀️ :person_with_pouting_face: :person_frowning: 🙇 💏 💑 💆 💇 💅 👦 👧 👩 👨 👶 👵 👴 :person_with_blond_hair: 👲 👳‍♂️ 👷 👮 👼 👸 😺 😸 😻 😽 😼 🙀 😿 😹 😾 👹 👺 🙈 🙉 🙊 💂‍♂️ 💀 🐾 👄 💋 💧 👂 👀 👃 👅 💌 👤 👥 💬 💭

☀️ ☔ ☁️ ❄️ ⛄ ⚡ 🌀 🌁 🌊 🐱 🐶 🐭 🐹 🐰 🐺 🐸 🐯 🐨 🐻 🐷 🐽 🐮 🐗 🐵 🐒 🐴 🐎 🐫 🐑 🐘 🐼 🐍 🐦 🐤 🐥 🐣 🐔 🐧 🐢 🐛 🐝 🐜 🪲 🐌 🐙 🐠 🐟 🐳 🐋 🐬 🐄 🐏 🐀 🐃 🐅 🐇 🐉 🐐 🐓 🐕 🐖 🐁 🐂 🐲 🐡 🐊 🐪 🐆 🐈 🐩 🐾 💐 🌸 🌷 🍀 🌹 🌻 🌺 🍁 🍃 🍂 🌿 🍄 🌵 🌴 🌲 🌳 🌰 🌱 🌼 🌾 🐚 🌐 🌞 🌝 🌚 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 🌜 🌛 🌔 🌍 🌎 🌏 🌋 🌌 ⛅ :octocat: :squirrel:

🎍 💝 🎎 🎒 🎓 🎏 🎆 🎇 🎐 🎑 🎃 👻 🎅 🎄 🎁 🔔 🔕 🎋 🎉 🎊 🎈 🔮 💿 📀 💾 📷 📹 🎥 💻 📺 📱 ☎️ ☎️ 📞 📟 📠 💽 📼 🔉 🔈 🔇 📢 📣 ⌛ ⏳ ⏰ ⌚ 📻 📡 ➿ 🔍 🔎 🔓 🔒 🔏 🔐 🔑 💡 🔦 🔆 🔅 🔌 🔋 📲 📧 📫 📮 🛀 🛁 🚿 🚽 🔧 🔩 🔨 💺 💰 💴 💵 💷 💶 💳 💸 📧 📥 📤 ✉️ 📨 📯 📪 📬 📭 🚪 🚬 💣 🔫 🔪 💊 💉 📄 📃 📑 📊 📈 📉 📜 📋 📆 📅 📇 📁 📂 ✂️ 📌 📎 ✒️ ✏️ 📏 📐 📕 📗 📘 📙 📓 📔 📒 📚 🔖 📛 🔬 🔭 📰 🏈 🏀 ⚽ ⚾ 🎾 🎱 🏉 🎳 ⛳ 🚵 🚴 🏇 🏂 🏊 🏄 🎿 ♠️ ♥️ ♣️ ♦️ 💎 💍 🏆 🎼 🎹 🎻 👾 🎮 🃏 🎴 🎲 🎯 🀄 🎬 📝 📝 📖 🎨 🎤 🎧 🎺 🎷 🎸 👞 👡 👠 💄 👢 👕 👕 👔 👚 👗 🎽 👖 👘 👙 🎀 🎩 👑 👒 👞 🌂 💼 👜 👝 👛 👓 🎣 ☕ 🍵 🍶 🍼 🍺 🍻 🍸 🍹 🍷 🍴 🍕 🍔 🍟 🍗 🍖 🍝 🍛 🍤 🍱 🍣 🍥 🍙 🍘 🍚 🍜 🍲 🍢 🍡 🥚 🍞 🍩 🍮 🍦 🍨 🍧 🎂 🍰 🍪 🍫 🍬 🍭 🍯 🍎 🍏 🍊 🍋 🍒 🍇 🍉 🍓 🍑 🍈 🍌 🍐 🍍 🍠 🍆 🍅 🌽

🏠 🏡 🏫 🏢 🏣 🏥 🏦 🏪 🏩 🏨 💒 ⛪ 🏬 🏤 🌇 🌆 🏯 🏰 ⛺ 🏭 🗼 🗾 🗻 🌄 🌅 🌠 🗽 🌉 🎠 🌈 🎡 ⛲ 🎢 🚢 🚤 ⛵ ⛵ 🚣 ⚓ 🚀 ✈️ 🚁 🚂 🚊 🚞 🚲 🚡 🚟 🚠 🚜 🚙 🚘 🚗 🚗 🚕 🚖 🚛 🚌 🚍 🚨 🚓 🚔 🚒 🚑 🚐 🚚 🚋 🚉 🚆 🚅 🚄 🚈 🚝 🚃 🚎 🎫 ⛽ 🚦 🚥 ⚠️ 🚧 🔰 🏧 🎰 🚏 💈 ♨️ 🏁 🎌 🏮 🗿 🎪 🎭 📍 🚩 🇯🇵 🇰🇷 🇨🇳 🇺🇸 🇫🇷 🇪🇸 🇮🇹 🇷🇺 🇬🇧 🇬🇧 🇩🇪

1️⃣ 2️⃣ 3️⃣ 4️⃣ 5️⃣ 6️⃣ 7️⃣ 8️⃣ 9️⃣ 🔟 🔢 0️⃣ #️⃣ 🔣 ◀️ ⬇️ ▶️ ⬅️ 🔠 🔡 🔤 ↙️ ↘️ ➡️ ⬆️ ↖️ ↗️ ⏬ ⏫ 🔽 ⤵️ ⤴️ ↩️ ↪️ ↔️ ↕️ 🔼 🔃 🔄 ⏪ ⏩ ℹ️ 🆗 🔀 🔁 🔂 🆕 🔝 🆙 🆒 🆓 🆖 🎦 🈁 📶 🈹 🈴 🈺 🈯 🈷️ 🈶 🈵 🈚 🈸 🈳 🈲 🈂️ 🚻 🚹 🚺 🚼 🚭 🅿️ ♿ 🚇 🛄 🉑 🚾 🚰 🚮 ㊙️ ㊗️ Ⓜ️ 🛂 🛅 🛃 🉐 🆑 🆘 🆔 🚫 🔞 📵 🚯 🚱 🚳 🚷 🚸 ⛔ ✳️ ✴️ 💟 🆚 📳 📴 💹 💱 ♈ ♉ ♊ ♋ ♌ ♍ ♎ ♏ ♐ ♑ ♒ ♓ ⛎ 🔯 ❎ 🅰️ 🅱️ 🆎 🅾️ 💠 ♻️ 🔚 🔛 🔜 🕐 🕜 🕙 🕥 🕚 🕦 🕛 🕧 🕑 🕝 🕒 🕞 🕓 🕟 🕔 🕠 🕕 🕡 🕖 🕢 🕗 🕣 🕘 🕤 💲 ©️ ®️ ™️ ❌ ❗ ‼️ ⁉️ ⭕ ✖️ ➕ ➖ ➗ 💮 💯 ✔️ ☑️ 🔘 🔗 ➰ 〰️ 〽️ 🔱 :black_square: :white_square: ✅ 🔲 🔳 ⚫ ⚪ 🔴 🔵 🔷 🔶 🔹 🔸 🔺 🔻 :shipit:

Mermaid

Les diagrammes Mermaid.js sont désormais pris en charge.

Organigrammes

Flowcharts sont des diagrammes qui représentent les charges de travail ou processus. Les étapes sont rendues sous forme de nœuds de différents types et sont reliées par des arêtes, décrivant l'ordre approprié des étapes:

graphique LR
A[Début] --> B{Erreur ?} ;
B -->|Oui| C[Hum...] ;
C --> D[Débogage] ;
D --> B ;
B ---->|Non| E[Yay !] ;
    ``` mermaid
    graph LR
    A[Start] --> B{Error?};
    B -->|Yes| C[Hmm...];
    C --> D[Debug];
    D --> B;
    B ---->|No| E[Yay!];
    ```

Diagrammes de séquence

Les Diagrammes de séquence décrivent un scénario spécifique comme les interactions séquentielles entre plusieurs objets ou acteurs, y compris les messages échangés entre ces acteurs:

%%{init: {'mirrorActors': false } }%%

sequenceDiagram

    autonumber
    participant G as package URL<br><br>(github/S3)
    participant M as metatran
    participant T as transifex
    participant F as filesystem<br><br>(path)
    G->>M: package file 
    T->>M: pull latest translation strings
    opt 
        note over M: swap base language
    end

    opt 
        note over M: include/exclude languages
    end
    M->>+F: New package file
    ``` mermaid
    %%{init: {'mirrorActors': false } }%%

    sequenceDiagram

        autonumber
        participant G as package URL<br><br>(github/S3)
        participant M as metatran
        participant T as transifex
        participant F as filesystem<br><br>(path)
        G->>M: package file 
        T->>M: pull latest translation strings
        opt 
            note over M: swap base language
        end

        opt 
            note over M: include/exclude languages
        end
        M->>+F: New package file
    ```

graphiques git

Les Graphiques Git fournissent une représentation graphique des commits git et des actions git sur diverses branches.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'gitGraph': {
'showBranches': true, 
'showCommitLabel':false, 
'mainBranchName': 'master'}} 
}%%

gitGraph
    commit
    commit
    branch "2.39"
    checkout "2.39"
    commit
    checkout master
    commit
    checkout "2.39"
    branch "patch/2.39.0"
    checkout "patch/2.39.0"
    commit
    checkout master
    commit
    checkout "2.39"
    commit
    checkout "patch/2.39.0"
    commit tag: "2.39.0"
    checkout master
    commit
    checkout "2.39"
    commit
    commit
    checkout "master"
    commit
    checkout "2.39"
    branch "patch/2.39.1"
    checkout "patch/2.39.1"
    commit
    commit tag: "2.39.1"
    checkout "2.39"
    commit
    checkout "patch/2.39.1"
    branch "hotfix 2.39.1.1"
    commit tag: "2.39.1.1"
    ``` mermaid
    %%{init: { 'logLevel': 'debug', 'theme': 'dark', 'gitGraph': {
    'showBranches': true, 
    'showCommitLabel':false, 
    'mainBranchName': 'master'}} 
    }%%

    gitGraph
        commit
        commit
        branch "2.39"
        checkout "2.39"
        commit
        checkout master
        commit
        checkout "2.39"
        branch "patch/2.39.0"
        checkout "patch/2.39.0"
        commit
        checkout master
        commit
        checkout "2.39"
        commit
        checkout "patch/2.39.0"
        commit tag: "2.39.0"
        checkout master
        commit
        checkout "2.39"
        commit
        commit
        checkout "master"
        commit
        checkout "2.39"
        branch "patch/2.39.1"
        checkout "patch/2.39.1"
        commit
        commit tag: "2.39.1"
        checkout "2.39"
        commit
        checkout "patch/2.39.1"
        branch "hotfix 2.39.1.1"
        commit tag: "2.39.1.1"
    ```

  1. La note de bas de page peut avoir un balisage

    et plusieurs paragraphes. 

  2. Texte de la note de bas de page.