Personnaliser les modèles de site AEM existants pour AEM Guides
Ce guide fournit des instructions détaillées pour personnaliser les modèles de site AEM existants à utiliser avec AEM Guides afin de générer AEM Sites à partir de cartes et de rubriques DITA.
Si vous utilisez le modèle prêt à l’emploi AEM Guides (AEMG Docs) , les configurations et les composants sont déjà en place et peuvent être utilisés en l’état pour publier votre contenu AEM Guides. Cependant, si vous souhaitez utiliser vos modèles AEM Sites existants avec une valorisation de marque personnalisée pour publier du contenu AEM Guides, suivez les étapes ci-dessous pour aligner vos modèles de sites sur les exigences de rendu AEM Guides.
Prérequis
-
Vous disposez des autorisations appropriées et de l’accès aux modèles AEM.
-
Vous comprenez les modèles modifiables AEM et la structure du site AEM.
-
Une hiérarchie de site existante est créée à l’aide de modèles modifiables.
-
Votre projet existant contient au moins deux modèles :
- Modèle de page de conteneur de documentation utilisé pour effectuer le rendu du plan DITA en tant que racine de documentation.
- Modèle de page de rubrique utilisé pour effectuer le rendu de pages de rubrique DITA individuelles.
Considérations relatives aux noms de modèles
Les noms des modèles varient en fonction de la configuration du projet. Par exemple, dans la configuration des documents AEM prêts à l’emploi :
-
Page du conteneur de documentation : /conf/AEMG-Docs-Site/settings/wcm/templates/kb-content
-
Page de rubrique : /conf/AEMG-Docs-Site/settings/wcm/templates/topic-content
Personnalisation : le processus de personnalisation comprend deux étapes principales :
- Paramétrage des modèles : identifiez et paramétrez les deux modèles (conteneur et rubrique).
- Composants des guides de rendu : incorporez les composants AEM Guides requis pour activer des fonctionnalités telles que la table des matières, la navigation et l’affichage des métadonnées.
Configuration du modèle
Choisissez et configurez deux modèles modifiables à partir de votre site AEM.
Modèle de page du conteneur de documentation
Le modèle de page Conteneur de documentation est utilisé pour créer la page Conteneur de documentation de produit , qui effectue le rendu du contenu d'un plan DITA.
-
Il sert de point d’entrée ou de page d’accueil pour un ensemble spécifique de documentation (par exemple, un manuel ou un guide du produit).
-
Ajoutez la propriété id=« category-page » au jcr:content du nœud initial du modèle. Cela permet de s’assurer que toutes les pages créées à partir de ce modèle sont automatiquement traitées comme des conteneurs de documentation par AEM Guides.
-
Ajoutez un composant Texte avec la propriété obligatoire : text=« $category.html$ ».
-
Inclut généralement des éléments de navigation, tels que des liens vers des sections ou des rubriques de la documentation.
-
Il peut être personnalisé pour inclure l’identité graphique, les en-têtes, les pieds de page et d’autres éléments de conception.
Exemple de cas d’utilisation :
Si vous disposez d'un plan DITA pour un manuel de produit, le modèle de page conteneur de documentation génère la page d'accueil de ce manuel, affichant un aperçu et des liens vers des rubriques individuelles.
Modèle de page de rubrique
-
Le modèle de page de rubrique permet de créer des pages pour des rubriques DITA individuelles.
-
Chaque rubrique d'un plan DITA est rendue en tant que page distincte à l'aide de ce modèle.
-
Contient un composant de texte avec la propriété obligatoire : text=« $topic.content$ ».
-
Cet espace réservé est remplacé par le contenu réel de la rubrique DITA lors de la génération du site.
- Le composant de texte est généralement placé à l’intérieur d’un composant de conteneur pour garantir une mise en page et un style appropriés.
- Peut être personnalisé pour inclure des en-têtes, des pieds de page et des éléments de navigation cohérents sur toutes les pages de rubrique.
Exemple de cas d’utilisation :
Si vous disposez d'une rubrique DITA sur les « Instructions d'installation », le modèle de page de rubrique génère une page affichant le contenu de cette rubrique.
Composant de conteneur :
Ajoutez le même (composant de conteneur et de texte) dans la structure du même modèle :
Composants des guides de rendu dans des modèles personnalisés
Pour activer les fonctionnalités des composants AEM Guides principaux tels que la table des matières, la redirection de page, la navigation et l’affichage des métadonnées, vous devez inclure des composants AEM Guides spécifiques dans vos modèles personnalisés. Ces composants doivent être explicitement ajoutés aux modèles modifiables correspondants (page Conteneur de documentation ou page de rubrique) pour garantir que la fonctionnalité prévue est disponible pendant la génération et l’exécution du site.
Consultez le tableau ci-dessous pour obtenir la liste des composants et leur utilisation :
Cas d’utilisation de composants
-
Composant de redirection (redirection enfant) : ajoutez-le au modèle de page du conteneur de documentation afin que la page d'accueil du produit générée à partir du plan DITA redirige automatiquement vers la première page de rubrique. Si votre page de conteneur de documentation est conçue pour agir en tant que page d’accueil autonome avec des composants et une disposition personnalisés, ce composant n’est pas nécessaire.
-
Table des matières (guidessidenavigation) : ajoutez-la au modèle de page de rubrique pour effectuer le rendu d’une table des matières navigable avec le contenu de rubrique. La table des matières est dérivée du plan DITA et permet aux utilisateurs de naviguer entre les rubriques frères.
Activation des bibliothèques clientes Guides
Par défaut, les bibliothèques clientes (clientlibs) fournies dans le package de composants AEM Guides ne sont pas appliquées aux modèles personnalisés. Pour les activer :
-
Modifier le modèle :
-
Ouvrez la page produit en mode Éditeur.
-
Sélectionnez Modifier le modèle (une URL telle que conf/settings/wcm/templates/structure.html s’ouvre alors).
-
-
Mettre à jour la politique de page :
-
Accédez au bouton Informations sur la page et sélectionnez Politique de page.
-
Ajoutez les bibliothèques clientes suivantes :
- Bibliothèques clientes
- En-tête de page JavaScript des bibliothèques clientes
-
-
Enregistrer les modifications : enregistrez le modèle après l’ajout des bibliothèques clientes requises.
Pour plus d’informations consultez la documentation officielle deAEM Guides et AEM Sites.