Définir une clé

Dans IXIASOFT CCMS Web, vous pouvez définir des variables dans les cartes et les insérer dans des rubriques sous forme de clé. Vous pouvez utiliser des clés pour modifier automatiquement le contenu de rubriques en fonction de la carte dans laquelle se trouve la rubrique.

Par exemple, vous pouvez utiliser des clés pour définir des noms pour les produits ou des fonctions de produit. Si les noms changent, vous n'avez pas à modifier toutes les rubriques. Il suffit de modifier la clé dans la carte qui définit le nom. De plus, si dans deux cartes la même clé définit un nom différemment, les rubriques contenant cette clé sont automatiquement actualisées avec le nom de la carte où elles se trouvent.

Vous pouvez définir et ajouter des clés à votre contenu de différentes façons. Les façons les plus courantes d'utiliser les clés sont les suivantes :

  • Définir les clés dans la carte, et les ajouter aux rubriques de la carte.
  • Définir les clés dans une sous-carte, que vous pouvez ajouter ensuite à d'autres cartes. Ainsi vous définissez la clé une fois insérée dans la carte, puis vous réutilisez la carte sous forme de sous-carte lorsque vous souhaitez ajouter ces clés à une rubrique.
Remarque : Si des clés sont définies à différents endroits, les clés définies dans la carte principale (la carte racine) sont prioritaires sur les clés des sous-cartes, sauf si une portée spécifique pour les clés est définie.

Vous devez déverrouiller une carte avant d'utiliser de nouvelles clés.

Pour définir une clé :

  1. Dans Éditeur de cartes, sélectionnez dans la rubrique l'emplacement où vous souhaitez ajouter la clé.
  2. Dans la barre d'outils, cliquez sur Définir Variable (clé DITA).
    La boîte de dialogue Définir Variable s'affiche.
  3. Dans le champ Nom, entrez le nom de la clé.
    Vous pouvez entrer n'importe quelle chaîne de caractères, du moment qu'il n'y a aucun espace. Ce nom permet de référencer la clé à partir d'une rubrique.
  4. Dans le champ Valeur, entrez la valeur à afficher lorsque la clé est utilisée.
  5. Pour utiliser des clés pour définir des liens (tels que des liens externes de sites Web), vous devez modifier la clé dans l'éditeur de texte XML:
    1. Dans la barre d'outils Oxygen Web Author, cliquez sur bouton Préférences.
    2. Dans la liste déroulante, sélectionnez Éditer comme XML.
      Le contenu de la zone Principale zone d'édition charge l'éditeur de texte XML.
    3. Modifier le fichier XML de la clé directement :

      Voici un exemple de fichier XML de lien externe :

      <keydef format="html" href="https://www.ixiasoft.com/documentation-guide/" 
keys="IXIAsitedocs" processing-role="resource-only" scope="external"/>
  6. Cliquez sur OK

A <keydef> Inséré dans la carte avec les valeurs définies.

Lorsque la carte est déverrouillée, la clé peut être insérée dans des rubriques.