Créer une définition de clé

Vous pouvez définir une variable dans une carte comme Clé puis insérer cette clé dans autant de rubriques que vous le souhaitez sur la carte.

Pourquoi et quand exécuter cette tâche

Les clés sont utiles pour gérer le contenu avec cohérence et efficacité. Utilisez les clés pour définir les éléments comme les noms des produits ou fonctionnalités, puis modifiez la clé dans la carte qui définit le nom de ce produit ou de cette fonctionnalité.

Les deux méthodes les plus courantes pour définir et ajouter des clés à votre contenu consistent à :

  • Définir les clés dans une carte, et les ajouter aux rubriques de la carte
  • Définir les clés dans une sous-carte, puis réutiliser la sous-carte en l’ajoutant à d’autres cartes avec des rubriques qui nécessitent les clés que vous avez définies.

Vous pouvez également avoir des définitions multiples d’une clé. Si deux cartes contiennent une même clé avec une valeur différente, les rubriques contenant cette clé sont automatiquement actualisées avec le bon nom de produit ou de fonction pour la carte concernée.

S’il existe plusieurs définitions d’une clé dans ne carte, la première définition prend l’ascendant sur toute définition ultérieure, sauf si vous définissez un champ d’application spécifique pour les clés qui affecte ce paramètre par défaut.

Vous devez déverrouiller une carte avant de mettre en application de nouvelles définitions de clés.

Pour créer une définition de clé :

Procédure

  1. Dans la vue Structure pour Éditeur de carte, cliquez sur Modifier.
  2. Sélectionnez l’emplacement de la carte où vous souhaitez ajouter la clé puis cliquez sur .

    Dans une carte, vous pouvez ajouter des définitions clés presque partout. D’un point de vue visuel, il est utile de les ajouter à la fin de la carte afin qu’elles ne soient pas « au milieu du chemin » lorsque vous naviguez dans les rubriques.

    Dans un bookmap, il est très courant d’ajouter des définitions clés en frontmatter ou backmatter. Elles peuvent également être ajoutées en annexe, chapitre, draftintro, glossarylist, notes, partie et préface.

  3. Dans le menu bulle qui en découle, sélectionnez Nouvel élément, puis choisissez Même niveau ou Sous-niveau, selon que vous avez besoin de créer la clé comme sœur ou fille de l’élément que vous avez sélectionné.
  4. Dans la boîte de dialogue Nouvel élément qui s’affiche, cliquez sur le menu déroulant Élément et sélectionnez <keydef>.
  5. Dans le champ Nom de la clé, entrez le nom de la clé.
  6. Pour la Valeur, choisissez l’une des options suivantes :
    • Mot clé vous fournit un ajout à la carte des clés et vous demande de saisir une valeur que vous utiliserez comme référence pour cette clé.
    • Référence de l’objet prend en charge l’insertion d’une référence dans une image, une rubrique ou une carte, mais nécessite que vous saisissiez sa portée comme définie par DITA : local, pairs ou externes.
    • Référence de la nouvelle rubrique prend en charge la création de clés ciblées, à partir des conditions de la rubrique que vous avez définies.
    • Lien Web propose une aide pour le référencement de liens vers des sites web actifs
  7. Cliquez sur Insérer.

Résultats

La carte contient maintenant l’élément <keydef> avec les valeurs que vous avez définies.

Que faire ensuite

Une fois que vous déverrouillez la carte, vous pouvez insérer la clé que vous avez définie dans une rubrique.