Traduire un article de documentation

Topics

La traduction d’un article se fait en suivant la trame de sa version en anglais.

Votre traduction doit respecter le glossaire français de WordPress, rappelez-vous que vous traduisez une documentation qui se réfère à l’interface de WordPress, alors n’utilisez pas votre terminologie mais bien celle utilisée dans WordPress FR.

Vous devez aussi respecter les règles typographiques utilisées pour traduire l’interface de WordPress en français.

Si vous avez des doutes sur un terme ou une phrase, n’hésitez pas à poser vos questions sur le Slack de la communauté française dans le canal #documentation-fr.

Titre et slug

Le titre de l’article doit être traduit, par contre le slug (servant au permalien) doit rester inchangé. Il est indispensable de le laisser en anglais.

Top ↑

URL et liens

Les URL des liens vers d’autres articles de la documentation ne doivent pas être modifiées, car il s’agit de liens relatifs. Il s’agit des liens commençant par « /support/ ».

Lorsque vous traduisez des contenus proposant des liens vers des articles de la documentation non encore traduits, vous pouvez traduire l’intitulé du lien en utilisant un vocabulaire conforme au glossaire.

Si l’article vers lequel pointe le lien est déjà traduit, vous pouvez utiliser le titre français de l’article s’il convient dans la phrase ; s’il ne convient pas, utilisez une terminologie proche du titre de l’article.

Si le lien pointe vers un contenu extérieur à la documentation, pensez à préciser entre parenthèses si le contenu est en anglais de la manière suivante : « intitulé du lien (en anglais) ».

On spécifie la mention « (en anglais) » uniquement pour les liens qui pointent vers autre chose que la documentation, donc si l’url comporte « wordpress.org/support/article…  » alors l’article correspondant à la cible du lien devrait normalement être traduit à terme, donc on ne met pas la langue de la cible.

Attention à la nature des liens externes

Les liens qui ciblent des documentations officielles comme PHP ou MySQL, ou des articles de Wikipédia (si possible mettre une version FR), une extension estampillée « WordPress.org » ou « The WordPress team » sont à conserver. Pour les extensions, pensez à mettre un lien qui correspond à une recherche, par exemple : « https://fr.wordpress.org/plugins/search/RSS/ ».

Par contre, les liens qui ciblent des blogs personnels sont à enlever. L’objectif étant d’éviter l’auto-promotion.

Top ↑

Règles typographiques essentielles

Les règles typographiques à suivre sont les mêmes que celles recommandées pour la traduction de l’interface de WordPress, qui sont résumées ici.

Top ↑

Les bases

  • Utilisation de l’apostrophe courbe, des guillemets français.
  • Pas de capitalisation à l’américaine de chaque lettre dans les intitulés, par exemple « Dashboard » se traduit par « Tableau de bord » sans majuscule à « bord ».
  • Utilisation de l’espace insécable avec les caractères suivants :
:Avant deux points (espace classique après)
;Avant le point virgule (espace classique après)
? !Avant les points d’interrogation et d’exclamation (espace classique après)
«  »Après les guillemets ouvrants et avant les guillemets fermants
% + – = < >Avant pourcentage et les signes mathématiques (espace classique après)

Pour les caractères particuliers de l’apostrophe courbe, des guillemets français et de l’espace insécable, vous êtes invités à consulter l’article concernant le clavier enrichi, qui vous explique comment réaliser ces caractères selon votre système d’exploitation.

Top ↑

Ponctuation des listes

Résumé de la règle : si la liste est constituée d’une phrase que vous découpez en plusieurs éléments pour en faciliter la compréhension, alors pas de majuscule en début de ligne, point virgule (ou virgule en niveau 2) pour chaque élément de la liste, et point pour le dernier élément de la liste. Pour les autres cas comme listes composées de plusieurs phrases, ou listes numérotées : majusucule en début d’élément de liste et point à la fin de chaque élément de liste.

Les paragraphes qui suivent détaillent cette régle.

  • Dans une énumération formant une seule phrase : point-virgule après chaque item de l’énumération, mais point après le dernier élément s’il correspond à la fin d’une phrase ; dans les énumérations imbriquées, point-virgule pour les éléments de niveau 1, virgule pour les éléments de niveau 2.

Exemple :
Pour traduire un article de la documentation :

  • recherchez l’article dans la liste ;
  • puis accédez à l’éditeur pour le modifier ;
  • réalisez votre traduction ;
    • traduisez les paragraphes,
    • ainsi que les titres,
  • et enregistrez le brouillon.
  • Dans une énumération formée de plusieurs phrases : chaque élément de l’énumération se comporte comme un alinéa, soit majuscule en début, point à la fin.

Exemple

  • Les articles de la documentation seront traduits au fur et à mesure.
  • Tous les articles ne seront pas forcément traduits.
  • Il est possible de créer des articles.
  • Dans une énumération ordonnée : lorsque chaque paragraphe est introduit par un numéro suivi d’un point, on débute le paragraphe par une majuscule et on le termine par un point, car il s’agit de phrases indépendantes.

Exemple

  1. Réalisez la traduction.
  2. Appliquez l’état en attente de relecture.
  3. Informez l’équipe que vous avez terminé la traduction et que l’article est en attente de relecture.

Top ↑

Images et autres médias

Il n’est pas obligatoire de faire les captures d’écran en français.

Si vous conservez les captures d’écran en anglais, pensez à traduire le texte de l’attribut alt, ainsi que la légende. Il en est de même pour les autres médias.

Pour réaliser des captures d’écran, il vous faudra une installation de WordPress avec la dernière version et le thème par défaut qui lui est associé.

Quelques recommandations :

  • Nommez les fichiers avec des termes en français décrivant le contenu de l’image, par exemple « bloc-image-barre-outils » sans accent, ni caractères spéciaux, en commençant par l’élément principal, dans notre exemple « bloc image » vers le détail, « barre outils ». Pas de « image1 », « capture » ou autre « 2020-12-18 » qui n’indique absolument rien sur ce que représente l’image.
  • Utilisez un environnement clair. Pas de thème sur le navigateur.
  • Les éléments (tels que photos ou vidéos) sur la capture doivent être libres de droits.
  • Compressez vos images ou utilisez le format *.webp.
  • Si vous devez remplacer votre capture, supprimez-la d’abord de la médiathèque (sobriété numérique).
  • N’oubliez pas de compléter si nécessaire l’attribut alt.

Pour savoir si vous devez compléter l’attribut alt, déterminez la situation dans laquelle vous vous trouvez :

  1. L’image apporte une information qui n’est pas dans le texte qui l’accompagne, alors il faut la décrire, de façon exhaustive.
  2. L’image n’apporte aucune information qui n’est pas déjà dans le texte, on ne la décrit pas et donc on ne saisit pas de texte alternatif dans l’attribut alt.

Top ↑

Éléments de code

Les éléments de code peuvent être placés dans un bloc nommé « SyntaxHighlighterCode », pour lequel vous pouvez dans les réglages du bloc : choisir le langage du code, numéroter les lignes et surligner des lignes particulières.

Top ↑

Blocs vides

Si vous rencontrez des blocs vides avec un fond gris, il s’agit probablement de blocs réutilisables dont nous ne disposons pas de la source. L’article Note concernant les blocs sans contenu vous explique comment traduire ces blocs.

Top ↑

Dernières étapes

Une fois votre traduction terminée :

Pensez à décocher l’option Autoriser les commentaires, car nous avons décidé d’abandonner l’utilisation des commentaires pour obtenir des retours sur la documentation. En effet, ces commentaires étaient majoritairement utilisés pour des demandes d’aide.

  • Ajoutez la composition « Boîte des auteurs », disponible dans la liste des compositions accessible via l’Outil d’insertion de bloc puis Compositions puis My patterns.
  • Saisissez vos prénom et nom à la place de « Prénom Nom » et compléter le lien vers votre profil. Supprimez le texte entre parenthèses.

Traduit par Prénom Nom (lien profil wp.org)
Relu par Prénom Nom (lien profil wp.org) & Prénom Nom (lien profil wp.org)
Dernière mise à jour le 22 janvier 2020

  • Indiquez finalement la date de dernière modification de l’article. Utilisez un format de date explicite comme il est suggéré dans la composition et recommandé dans la checklist de référence de l’Opquast.

Important : Les liens vers des sites autres que votre profil WordPress.org ne sont pas acceptés (mais il est possible de mettre un lien vers votre site sur votre profil).

Enfin, dernière étape, dans les Réglages du Document :

  • Cochez l’option « Pending Review » pour attribuer le statut « En attente de relecture ».
  • Autorisez la visualisation en cochant « Enable public preview ».

Vous obtiendrez ainsi un lien de prévisualisation qui peut être partagé aux autres membres de l’équipe de traduction de la documentation pour relecture. Copiez le lien pour signaler ultérieurement qu’un article est à relire.

Enregistrez ensuite votre travail en cliquant sur « Save Draft ».

Dernière mise à jour :