Habilitar variables de contenido contextual (CCVAR) en páginas de AEM Sites generadas desde AEM Guides
Variables de contenido contextual (CCVAR) es una capacidad de ACS Commons que permite a los autores utilizar variables de contenido dinámico directamente en el texto creado. Aunque CCVAR se usa comúnmente en AEM Sites, este artículo explica cómo lograr una funcionalidad similar a través de páginas generadas a partir de contenido creado en AEM Guides principalmente mediante palabras clave definidas en el mapa DITA.
¿Qué son las variables de contenido contextual (CCVAR)?
CCVAR permite a los autores insertar variables dinámicas en su contenido, que se resuelven durante la ejecución en función del contexto. Por ejemplo, variables como ((page_properties.pageTitle)) pueden extraer dinámicamente el título de la página durante la representación del contenido.
¿Cómo se habilita la CCVAR en las páginas de AEM Sites generadas desde AEM Guides?
Teniendo en cuenta que AEM Guides se utiliza como fuente de todo el contenido (incluido AEM Sites, PDF o HTML5), para habilitar las CCVAR en páginas generadas a partir de AEM Guides, debe utilizar palabras clave para definir el nombre de la CCVAR. Para ello en Guides, defina keywords en su mapa DITA usando <keydef> elementos. Estas palabras clave pueden corresponder a valores dinámicos (o nombres de CCVAR), lo que permite hacer referencia a ellos en los temas DITA.
Requisitos previos
Antes de continuar, asegúrese de que se cumplen los siguientes requisitos previos:
-
AEM Se instaló ACS Commons de forma conjunta:
- AEM AEM Asegúrese de que ACS Commons esté instalado en la instancia de la instancia de la. Esto es necesario para utilizar CCVAR.
-
Configuración de variables de contenido contextual:
-
AEM Complete la configuración de Variables de contenido contextuales en el uso de la documentación oficial en el. Esto incluye:
- Habilitando agregación de propiedades.
- Configurando reescritura de HTML (si se usa la salida de HTML).
- Configurando reescritura de JSON (si se usa la salida JSON).
-
Pasos para habilitar CCVAR en AEM Guides
1. Definir palabras clave en el mapa DITA
- En AEM Guides, defina palabras clave utilizando
<keydef>elementos en el mapa DITA para corresponder a la CCVAR. - Por ejemplo:
<keydef keys="product">
<topicmeta>
<keywords>
<keyword>((page_properties.pageTitle))</keyword>
</keywords>
</topicmeta>
</keydef>
- El atributo
keys(producten este ejemplo) se utilizará para hacer referencia a esta variable en los temas DITA.
2. Usar palabras clave en temas DITA
- En el tema, utilice la palabra clave dondequiera que se vaya a utilizar la CCVar.
- Por ejemplo:
<p>This is the title of the product: <keyword keyref="product"/> </p>
- El atributo
keyrefseñala al valorkeysdefinido en el elemento<keydef>(producten este caso). - Durante la generación de resultados, la palabra clave se reemplaza por el valor de CCVar correspondiente.
3. Generar salida
- Cuando se genera una salida para AEM Sites, las referencias de palabras clave se resuelven en los valores dinámicos correspondientes.
- Por ejemplo:
- Si
((page_properties.pageTitle))se resuelve enMy Product, se mostrará el resultado:
- Si
This is the title of the product: My Product.
Ejemplo de caso de uso
Supongamos que desea insertar dinámicamente el idioma de la página en los temas DITA. A continuación se indica cómo lograrlo:
Definir la palabra clave en el mapa DITA:
<keydef keys="pageLanguage">
<topicmeta>
<keywords>
<keyword>((inherited_page_properties.jcr:language))</keyword>
</keywords>
</topicmeta>
</keydef>
Hacer referencia a la palabra clave en un tema DITA:
<p>The title of this page is: <keyword keyref="pageLanguage"/>.</p>
Salida generada:
Si ((inherited_page_properties.jcr:language)) se resuelve en en, se mostrará el resultado:
The language of this page is: en.
Recursos
Para obtener más información sobre variables de contenido contextual, consulte la documentación oficial:
AEM Variables de contenido contextual en Commons de la comunidad de la comunidad de la comunidad de datos