Reutilización de contenido en AEM Guides

Adobe AEM Guides aprovecha los puntos fuertes de DITA para proporcionar una interfaz fácil de usar para la reutilización de contenido.

Este artículo analizará:

Reutilización mediante referencias de temas (topicref)

Supongamos que es una empresa de fabricación y que tiene temas genéricos para precauciones de seguridad o técnicas de resolución de problemas.

Se pueden consultar y adaptar en manuales de usuario específicos para cada modelo de máquina, reduciendo la redundancia y asegurando que la información de seguridad central siga siendo coherente.

<map id="user_manual_model 100" title="ABC Model 100 User Manual ">


<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.
</map>

Del mismo modo para el modelo 200

<map id="user_manual_model 200" title="ABC Model 200 User Manual ">

<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.

</map>

Reutilización mediante referencia de contenido (conref y conkeyref)

El atributo content reference (conref) permite vincular otras partes del contenido. Esto promueve la reutilización y reduce la redundancia.

Por ejemplo:

Supongamos que es una empresa financiera y tiene un tema genérico para KYC que contiene procedimientos KYC para individuos, empresas, etc.

Desea reutilizar el fragmento KYC individual para los temas "Cuenta de almacenamiento" y "Cuenta de demostración".

<section id="kyc_requirements_saving_account">
  <title>Know Your Customer (KYC) Requirements</title>
  <p>To comply with regulations and ensure customer identification, all individual applicants for savings  accounts must fulfill the KYC requirements as outlined below</p>
  <p conref=kyc_procedures.dita#individual_kyc></p>
</section>

Aquí conref=kyc_procedures.dita#indvidual_kyc key_processes.dita es el identificador de archivo y #individual_kyc es el identificador de fragmento.

Kyc_procedure.dita sigue siendo la única fuente de información. Si los cambios regulatorios requieren actualizaciones en el proceso KYC, actualice la ruta del tema con la nueva. Los cambios se reflejarán automáticamente en todos los temas que hagan referencia a él.

Con AEM Guides, son dos clics

Paso 1: Haga clic en Insertar contenido reutilizable

Paso 2: Seleccione el archivo y el fragmento que debe reutilizarse.

Al igual que "conref", puede utilizar "conkeyref" donde, en lugar de proporcionar una ruta de contenido, se hace referencia al contenido mediante una clave

Ejemplo de código:

<section conkeyref="kyc_procedure/individual_kyc_procedure" id="individual_kyc_procedure"></section>

La definición de la clave tiene este aspecto:

<map id="ABC_manual">
  <title>ABC_Manual</title>
  <topicref href="kyc_procedure_2020.dita" keys="kyc_procedure" processing-role="resource-only" type="concept">
  </topicref>
  <topicref href="savings_account.dita" type="concept">
  </topicref>
</map>

Clave: "Key_procedure" sigue siendo la única fuente de información. Si hay cambios en el proceso KYC según lo requerido por las regulaciones, simplemente necesita actualizar una ruta de tema con una nueva ruta de tema, y esos cambios se reflejan automáticamente en todos los temas que se refieren a ella.

<map id="ABC_manual">
  <title>ABC_Manual</title>
  <topicref href="kyc_procedure_2024.dita" keys="kyc_procedure" processing-role="resource-only" type="concept">
  </topicref>
  <topicref href="savings_account.dita" type="concept">
  </topicref>
</map>

En este caso, la ruta del tema cambia de "kyc_procedure_2020.dita" a "kyc_procedure_2024.dita" debido a los cambios recientes en la regulación.

Con AEM Guides, son dos clics

Paso 1: Haga clic en Insertar contenido reutilizable

Paso 2: Seleccione el mapa raíz (opcional), la clave y el fragmento que debe reutilizarse.

Aquí el mapa raíz se seleccionó automáticamente porque ya estaba abierto en la vista del mapa.

Reutilización del contenido con un solo clic en AEM Guides

AEM Guides ofrece la capacidad "Contenido reutilizable" para agregar referencias de contenido con un solo clic.

Paso 1: Agregar un tema genérico a contenido reutilizable

Paso 2: Una vez agregado, arrastre y suelte el fragmento que desee reutilizar en cualquiera de los temas de destino.

Preguntas más frecuentes

Asignar ID a fragmentos (elementos Dita) que desee reutilizar en otros temas

Publica en la comunidad de AEM Guides forum para cualquier consulta.