Documentation AEM Guides Documentation d’AEM Guides

Activation des variables de contenu contextuel (CCVAR) dans les pages AEM Sites générées à partir d’AEM Guides

Last update: Wed Jan 22 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :

Créé pour :

Utilisateur ou utilisatrice
Administration

Les variables de contenu contextuel (CCVAR) sont une fonctionnalité d’ACS Commons qui permet aux auteurs d’utiliser des variables de contenu dynamique directement dans leur texte créé. Bien que CCVAR soit couramment utilisé dans AEM Sites, cet article explique comment obtenir des fonctionnalités similaires par le biais de pages générées à partir de contenu créé dans AEM Guides principalement à l'aide de mots-clés définis dans le plan DITA.

Que sont les variables de contenu contextuel (CCVAR) ?

La CVAR permet aux créateurs et créatrices d’insérer des variables dynamiques dans leur contenu, qui sont résolues au moment de l’exécution en fonction du contexte. Par exemple, des variables telles que ((page_properties.pageTitle)) peuvent extraire dynamiquement le titre de la page pendant le rendu du contenu.

Comment activer la fonction CCVAR dans les pages AEM Sites générées à partir d’AEM Guides ?

AEM Guides étant utilisé comme source de tout le contenu (y compris AEM Sites, PDF ou HTML5), pour activer les CCVAR sur les pages générées à partir d’AEM Guides, vous devez utiliser des mots-clés pour définir le nom de la CCVAR. Pour ce faire dans les guides, définissez mots-clés dans votre plan DITA à l'aide d'éléments <keydef>. Ces mots-clés peuvent correspondre à des valeurs dynamiques (ou à des noms de CVAR), ce qui vous permet de les référencer dans vos rubriques DITA.

Prérequis

Avant de poursuivre, vérifiez que les conditions préalables suivantes sont remplies :

AEM ACS Commons Installé :
- Vérifiez que ACS AEM Commons est installé sur votre instance AEM. Obligatoire pour l’utilisation de la CCVAR.
Configuration des variables de contenu contextuel :
- Effectuez la configuration de Variables de contenu contextuel dans AEM à l’aide de la documentation officielle. Cela inclut les éléments suivants :
  - Activation de l’agrégation des propriétés.
  - Configuration de la réécriture d'HTML (si vous utilisez la sortie d'HTML).
  - Configuration de la réécriture JSON (si vous utilisez la sortie JSON).

Procédure d’activation de la CCVAR dans AEM Guides

1. Définir des mots-clés dans le plan DITA

Dans AEM Guides, définissez des mots-clés à l’aide des éléments <keydef> dans le plan DITA pour correspondre à la variable CCVAR.
Par exemple :

  <keydef keys="product">
    <topicmeta>
      <keywords>
        <keyword>((page_properties.pageTitle))</keyword>
      </keywords>
    </topicmeta>
  </keydef>

L'attribut keys (product dans cet exemple) sera utilisé pour référencer cette variable dans vos rubriques DITA.

2. Utiliser des mots-clés dans les rubriques DITA

Dans la rubrique , utilisez le mot-clé à l’endroit où la CCVar doit être utilisée.
Par exemple :

  <p>This is the title of the product: <keyword keyref="product"/> </p>

L’attribut keyref pointe vers la valeur keys définie dans l’élément <keydef> (product dans ce cas).
Lors de la génération de la sortie, le mot-clé est remplacé par la valeur CCVar correspondante.

3. Générer une sortie

Lorsque vous générez une sortie pour AEM Sites, les références aux mots-clés sont résolues sur les valeurs dynamiques correspondantes.
Par exemple :
- Si ((page_properties.pageTitle)) correspond à My Product, la sortie affiche :

   This is the title of the product: My Product.

Exemple de cas d’utilisation

Supposons que vous souhaitiez insérer de manière dynamique la langue de la page dans vos rubriques DITA. Pour ce faire, procédez comme suit :

Définissez le mot-clé dans le plan DITA :

   <keydef keys="pageLanguage">
     <topicmeta>
       <keywords>
         <keyword>((inherited_page_properties.jcr:language))</keyword>
       </keywords>
     </topicmeta>
   </keydef>

Référencer le mot-clé dans une rubrique DITA :

   <p>The title of this page is: <keyword keyref="pageLanguage"/>.</p>

Sortie générée :

Si ((inherited_page_properties.jcr:language)) correspond à en, la sortie affiche :

     The language of this page is: en.

Ressources

Pour plus d’informations sur les variables de contenu contextuelles, consultez la documentation officielle :
Variables de contenu contextuelles dans AEM Commons

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178