La présentation et les styles utilisés dans une documentation jouent un rôle important dans sa compréhension par les lecteurs et lectrices, ainsi que dans leur confort de lecture. Si cette présentation et les styles utilisés sont homogènes d’une page à l’autre de la documentation, cela facilite d’autant plus la compréhension, car les lecteurs et lectrices se les approprient au fil de la lecture et interprètent leur signification sous-jacente. Ainsi, par exemple, un même style, répété pour tous les éléments de l’interface, sera repéré comme tel par les lecteurs et lectrices, qui sauront d’emblée qu’il s’agit d’éléments qu’ils retrouveront dans l’interface.
Cette page a été rédigée en s’appuyant sur le WordPress Documentation Style Guide issu du Google Season of Docs 2020 Project.
Styles à utiliser
Afin de faciliter la tâche aux personnes qui traduisent ou rédigent la documentation de WordPress en français, voici un tableau récapitulatif des styles à utiliser dans vos articles.
| Styles | Éléments textuels correspondant à… | Exemples |
|---|---|---|
| Gras | Éléments d’interface1 : noms de champs, options, boutons, titres de fenêtres – Avec la même casse que dans l’interface | Cliquez sur Publier pour mettre en ligne votre publication. |
| Normal | Message d’erreur ou notification2 – À placer entre guillemets | Si le message d’erreur « Page non trouvée » est affiché, effectuez une nouvelle recherche. |
| Normal | URL et nom de domaine2 – Utiliser des minuscules | https://mondomaine.com wordpress.org |
| Normal | Noms de société, de marques2 – Utiliser la casse adoptée par la marque ou l’organisme | WordPress YouTube |
| Italique | Titres de livres, films, articles, publications, journaux et autres œuvres complètes – Pas de guillemets | Référez-vous au guide Bien débuter avec WordPress pour apprendre rapidement. |
| Italique | Éléments à accentuer2 – Pas de guillemets, excepté pour les expressions, ou les mots dans une autre langue | N’utilisez le format 24 heures qu’en cas de nécessité absolue. Entrez une valeur pour les marges internes (ou « padding »). |
| Italique | Constantes et variables mathématiques2 | x = 2a + b |
| Kbd | Touches du clavier ou saisie à effectuer1 – Pour les raccourcis clavier, utilisez le nom français des touches. | Appuyez sur Entrée pour valider. Appuyez sur Ctrl + C pour copier. Saisissez j F Y pour définir le format de date. |
Code | Éléments de code3 – Quelque soit le langage (PHP, HTML, CSS, etc.), en utilisant la casse du langage | alt="The WordPress mascot Wapuu."<link><!DOCTYPE html> |
Code | Noms de dossiers, fichiers et extensions de fichiers3 – En respectant la casse (généralement minuscules) | wp-content |
Code italique | Variables d’espace réservé2 – Avec la casse correspondant à la variable | EMAIL_ADDRESS |
Autres règles
- Le soulignement est réservé aux liens, donc ne pas souligner.
- Ne pas utiliser le texte barré, très difficile à lire.
- Réservez les guillemets aux citations ou aux messages d’erreurs insérés dans le texte, aux expressions, aux mots dans une autre langue.
- Ne pas utiliser des polices différentes au sein d’un même élément de texte. De même pour la taille ou la couleur de la police.
- Dans les titres :
- pas de signes de ponctuation, exceptés « ! » ou « ? » qui sont tolérés ;
- pas de style gras ou italique ;
- pas de liens ni boutons ;
- éviter les éléments de code.
- ne pas ajouter d’espace supplémentaire sous un titre.
Enfin, dans le cadre d’une traduction, les styles recommandés ici sont prioritaires à ceux utilisés dans la source.
1. Voir UI elements and interaction (en anglais)
2. Voir Text formatting (en anglais)
3. Voir Code in text (en anglais)