Personalizar las plantillas de sitio de AEM existentes para AEM Guides
Esta guía proporciona instrucciones paso a paso para personalizar las plantillas de sitio de AEM existentes y utilizarlas con AEM Guides para generar AEM Sites a partir de temas y mapas DITA.
Si está utilizando la plantilla predeterminada AEM Guides (AEMG Docs), las configuraciones y los componentes ya están establecidos y se pueden utilizar tal cual para publicar el contenido de AEM Guides. Sin embargo, si desea utilizar las plantillas de AEM Sites existentes con personalización de marca para publicar contenido de AEM Guides, siga los pasos a continuación para alinear las plantillas de sitios con los requisitos de renderización de AEM Guides.
Requisitos previos
-
Tiene los permisos y el acceso adecuados a las plantillas de AEM.
-
Comprenderá las plantillas editables de AEM y la estructura del sitio de AEM.
-
Tiene una jerarquía de sitio existente creada con plantillas editables.
-
Tiene al menos dos plantillas del proyecto existente:
- Plantilla de página de contenedor de documentación utilizada para procesar el mapa DITA como raíz de documentación.
- Plantilla de página de tema utilizada para procesar páginas de tema DITA individuales.
Consideraciones de nomenclatura de plantillas
Los nombres de las plantillas variarán según la configuración del proyecto. Por ejemplo, en la configuración de documentos de AEMG de OOTB:
-
Página de contenedor de documentación: /conf/AEMG-Docs-Site/settings/wcm/templates/kb-content
-
Página de tema: /conf/AEMG-Docs-Site/settings/wcm/templates/topic-content
Personalización: El proceso de personalización implica dos pasos principales:
- Configuración de plantilla: identifique y configure las dos plantillas (contenedor y tema).
- Componentes de las guías de procesamiento: incruste los componentes de AEM Guides necesarios para habilitar funciones como tabla de contenido, navegación y visualización de metadatos.
Configuración de plantilla
Elija y configure dos plantillas editables del sitio de AEM.
Plantilla de página del contenedor de documentación
La plantilla Página de contenedor de documentación se utiliza para crear la página de contenedor de documentación del producto que procesa el contenido de un mapa DITA.
-
Sirve como punto de entrada o página principal para un conjunto específico de documentación (por ejemplo, un manual o una guía del producto).
-
Agregue la propiedad id="category-page" al jcr:content del nodo inicial de la plantilla. Esto garantiza que AEM Guides trate automáticamente todas las páginas creadas a partir de esta plantilla como contenedores de documentación.
-
Agregue un componente Texto con la propiedad obligatoria: text="$category.html$".
-
Normalmente incluye elementos de navegación, como vínculos a secciones o temas dentro de la documentación.
-
Se puede personalizar para incluir marcas, encabezados, pies de página y otros elementos de diseño.
Ejemplo de caso de uso:
Si dispone de un mapa DITA para un manual de producto, la plantilla de página contenedora de documentación generará la página principal de dicho manual, mostrando una descripción general y vínculos a temas individuales.
Plantilla de página de tema
-
La plantilla de página de tema se usa para crear páginas para temas DITA individuales.
-
Cada tema de un mapa DITA se representa como una página independiente utilizando esta plantilla.
-
Contiene un componente Texto con la propiedad obligatoria: text="$topic.content$".
-
Este marcador de posición se sustituye por el contenido real del tema DITA durante la generación del sitio.
- El componente de texto se suele colocar dentro de un componente Container para garantizar un diseño y un estilo adecuados.
- Se puede personalizar para incluir encabezados, pies de página y elementos de navegación coherentes en todas las páginas de temas.
Ejemplo de caso de uso:
Si tiene un tema DITA sobre "Instrucciones de instalación", la plantilla de página del tema generará una página que mostrará el contenido de ese tema.
Componente de contenedor:
Añada lo mismo (contenedor y componente de texto) en la estructura de la misma plantilla:
Componentes de guías de procesamiento en plantillas personalizadas
Para habilitar las funciones de los componentes principales de AEM Guides, como la tabla de contenido, la redirección de páginas, la navegación y la visualización de metadatos, debe incluir componentes específicos de AEM Guides en las plantillas personalizadas. Estos componentes deben agregarse explícitamente a las plantillas editables correspondientes (Página de contenedor de documentación o Página de tema) para garantizar que la funcionalidad deseada esté disponible durante la generación del sitio y el tiempo de ejecución.
Consulte la tabla siguiente para obtener la lista de componentes y su uso:
Casos de uso de componentes
-
Componente de redireccionamiento (child-direct): Añádalo a la plantilla de página contenedora de documentación para que la página de inicio del producto generada a partir del mapa DITA se redirija automáticamente a la primera página de tema. Si la página contenedora de documentación está diseñada para actuar como una página de inicio independiente con componentes y diseño personalizados, este componente no es obligatorio.
-
Tabla de contenido (guidessidenavigation): Agregue esto a la plantilla de la página del tema para procesar una tabla de contenido navegable junto con el contenido del tema. El índice se deriva del mapa DITA y ayuda a los usuarios a navegar por temas relacionados.
Habilitar las bibliotecas de cliente de Guides
De forma predeterminada, las bibliotecas de cliente (clientlibs) proporcionadas en el paquete de componentes de AEM Guides no se aplican a las plantillas personalizadas. Para habilitarlos:
-
Editar la plantilla:
-
Abra Página de productos en Modo de edición.
-
Seleccione Editar plantilla (se abrirá una dirección URL como conf/settings/wcm/templates/structure.html).
-
-
Actualizar directiva de página:
-
Vaya al botón Información de página y seleccione Política de página.
-
Añada las siguientes bibliotecas de cliente:
- Bibliotecas de cliente
- Encabezado de página JavaScript de bibliotecas de cliente
-
-
Guardar cambios: Guarde la plantilla después de agregar las bibliotecas de cliente necesarias.
Consulte la documentación oficial de AEM Guides y AEM Sites para obtener más detalles.