Astuces

Positionnement des ancres de liens dans le texte

Lorsque l’on place une ancre (texte cliquable) d’un lien dans un texte, il est recommandé de respecter les normes d’accessibilité, et donc de placer l’ancre sur un texte qui a du sens hors contexte, et de ne pas la placer sur un texte générique comme « en savoir plus », « ici » ou « plus d’informations », ou encore « cliquez ici ».

Exemples
❌ Incorrect : Pour en savoir plus sur l’insertion de blocs, cliquez ici.
✔ Correct : En savoir plus sur l’insertion de blocs.

Top ↑

Créer un lien vers une ancre comportant un caractère spécial ?

Dans certains articles, il existe des liens vers une ancre dans un autre article ou encore des liens internes vers une ancre dans le même article, cette astuce vous explique comment bien définir le lien.

Dans la documentation, chaque titre, correspondant à une balise Hn, constitue une ancre implicite, utilisée pour créer la table des matières. Cette ancre est encodée en UTF-8, selon l’encodage avec pourcentage pour les caractères spéciaux, les espaces étant remplacés par des tirets « – ».

Top ↑

Ancre sans caractère spécial

Lorsque l’ancre ne comporte pas de caractère spécial, pour définir le lien, il suffit de saisir la chaîne normalisée correspondant au titre dans le champ de saisie du lien. Par exemple, si le titre est « Enregistrer les modifications », la chaîne normalisée pour créer le lien vers l’ancre sera « enregistrer-les-modifications ».

Top ↑

Ancre avec caractère spécial

Par contre, si l’ancre contient un caractère spécial, il faudra saisir la chaîne normalisée correspondant au titre en utilisant l’encodage avec pourcentage en UTF-8 pour les caractères spéciaux. Par exemple, « Comment installer l’extension ? » est encodée de la manière suivante : « comment-installer-l%e2%80%99extension-%3F ».

Voici un moyen simple de récupérer cette chaîne normalisée correctement encodée :

  1. Prévisualisez ou affichez l’article où se trouve l’ancre.
  2. Dans la table des matières de l’article, recherchez l’entrée correspondant à l’ancre que vous souhaitez cibler.
  3. Effectuez un clic droit pour Copier l’adresse du lien.
  4. Affichez l’article où vous souhaitez placer le lien.
  5. Sélectionnez ou saisissez le texte du lien.
  6. Cliquez sur l’outil Link et coller le contenu du presse-papiers (soit l’adresse du lien copié précédemment).
  7. Supprimez le début de l’URL, pour ne garder que la partie utile.

Par exemple, pour un lien interne, la partie de l’URL à conserver sera « #comment-installer-l%e2%80%99extension-%3F » et pour un lien vers une ancre d’un autre article : « /support/article/slug-article/#comment-installer-l%e2%80%99extension-%3F ».

Top ↑

Convertir un bloc réutilisable en bloc normal

Lorsque vous ajoutez un bloc réutilisable, avant de l’éditer il est impératif de le convertir en bloc normal, sinon c’est le bloc réutilisable lui-même que vous modifiez.

Pour convertir le bloc réutilisable en bloc normal :

  • Sélectionnez le bloc.
  • Vérifiez dans la barre d’outils du bloc qu’il porte un nom.
    • Si ce n’est pas le cas, dans le fil d’ariane (en bas de l’écran de l’éditeur, par exemple « Document –> Signature contributeurs –> Paragraph »), il devrait y avoir un bloc parent du bloc que vous avez sélectionné.
    • Cliquez sur ce bloc parent.
  • Dans la barre d’outils du bloc (comportant le nom du bloc, surligné en jaune ci-dessous), cliquez sur le bouton Convert to regular block.
Convertir un bloc réutilisable en bloc normal
  • Modifiez ensuite le bloc à votre convenance.

Top ↑

Comment accéder rapidement aux articles en attente de relecture ?

Cette animation vous montre comment appliquer un filtre, modifier des données, et ensuite supprimer le filtre :

Top ↑

Copier le lien vers l’article en attente de relecture

Lorsque vous avez terminé de traduire un article, et que vous passez son statut en « En attente de relecture », il vous faut copier le lien de l’article afin que les relecteurs le trouvent facilement.
Aussi à la fin de votre travail de traduction, lorsque vous cochez les options « Pending review » et « Enable public preview » (voir Dernières étapes de Traduire un article de documentation), pensez à copier le lien qui s’affiche sous ces options et à le coller dans le tableau d’avancement (en modifiant le statut de l’article en même temps) et vers le canal #Documentation-fr du slack.

Copier le lien vers l’article en attente de relecture
Coller le lien dans le tableau d’avancement

Dernière mise à jour :