Personnaliser une sortie de site AEM existante id166TG0B30WR
AEM Guides prend en charge la création de sorties dans les formats suivants :
- Site AEM
- HTML5
- EPUB
- Sortie personnalisée via DITA-OT
Pour la sortie du site AEM, vous pouvez affecter différents modèles de conception avec différentes tâches de sortie. Ces modèles de conception peuvent effectuer le rendu du contenu DITA dans différentes dispositions. Par exemple, vous pouvez spécifier différents modèles de conception pour les audiences internes et externes.
Vous pouvez également utiliser des modules externes DITA Open Toolkit (DITA-OT) personnalisés avec AEM Guides. Vous pouvez charger ces plug-ins DITA-OT personnalisés pour générer une sortie PDF d’une manière spécifique.
Personnaliser le modèle de conception pour générer la sortie customize_xml-add-on
AEM Guides utilise un ensemble de modèles de conception prédéfinis pour générer une sortie de site AEM. Vous pouvez personnaliser les modèles de conception AEM Guides pour générer une sortie conforme à la valorisation de marque de votre entreprise. Un modèle de conception est un ensemble de différents styles (CSS), scripts (côté serveur et côté client), ressources (images, logos et autres ressources) et nœuds JCR qui lient toutes ces ressources. Un modèle de conception peut être aussi simple qu’un script côté serveur unique avec seulement quelques nœuds JCR ou une combinaison complexe de styles, de ressources et de nœuds JCR. Les modèles de conception sont utilisés par le sous-système de publication d’AEM Guides lors de la génération de la sortie du site AEM et contrôlent la structure, l’aspect et la fonctionnalité de la sortie générée.
Il n’existe aucune restriction quant à l’emplacement des ressources du modèle de conception sur le serveur, mais elles sont généralement organisées de manière logique en fonction de leur fonction. Par exemple, tous les fichiers JavaScript et CSS du modèle par défaut sont stockés dans /etc/designs/fmdita/clientlibs/siteoutput/default dossier . Où que se trouvent ces fichiers, ils sont liés entre eux par un ensemble de nœuds JCR. Ensemble, ces nœuds JCR et les fichiers constituent l’ensemble du modèle de conception.
Le modèle de conception par défaut fourni avec AEM Guides vous permet de personnaliser les composants des pages de destination, de rubrique et de recherche. Vous pouvez faire une copie de la conception par défaut et des modèles de référence correspondants et spécifier différents composants pour générer la sortie souhaitée.
Les onglets suivants fournissent des instructions pour spécifier votre propre modèle de conception à utiliser pour la génération de sortie de site AEM en fonction de votre configuration Experience Manager Guides : Cloud Service ou On-Premise.
-
Utilisez le gestionnaire de packages pour télécharger le modèle de conception par défaut à partir de l’emplacement suivant :
/libs/fmdita/config/templates
-
Créez une copie des fichiers téléchargés à l’emplacement suivant dans votre référentiel Git Cloud Manager :
/apps/fmdita/config/templates
-
Vous devez également télécharger et copier les modèles référencés à partir du nœud de modèle par défaut. Les modèles référencés sont placés sous :
/libs/fmdita/templates/default/cqtemplates
-
Connectez-vous à AEM et ouvrez le mode CRXDE Lite .
-
Accédez au nœud du modèle de conception par défaut. L’emplacement du nœud de modèle de conception par défaut est :
/libs/fmdita/config/templates/ {width="300"}
note NOTE Effectuez une copie des modèles de conception par défaut du dossier libsvers le dossierappset apportez des modifications au dossierapps. Vous devez également apporter des modifications aux modèles référencés à partir du nœud de modèle par défaut. Les modèles référencés sont placés sous/libs/fmdita/templates/default/cqtemplatesnœud . Effectuez une copie des modèles référencés dans le dossierappsavant d’apporter des modifications. -
Cliquez sur le composant default dans le nœud templates pour accéder à ses propriétés.
Les propriétés du modèle de conception AEM Guides sont décrites dans le tableau ci-après.
landingPageTemplate, searchPageTemplate, topicPageTemplate, shadowPageTemplatecq:Template pour ces pages correspondantes (destination, recherche et rubrique). Par défaut, le nœud cq:Template de ces pages se trouve dans /libs/fmdita/templates/default/cqtemplates nœud . Ce nœud définit la structure et les propriétés des pages de destination, de recherche et de rubriqueLe
shadowPageTemplate est utilisé pour optimiser le contenu segmenté. Vous devez définir la valeur de cette propriété sur : fmdita/templates/default/cqtemplates/shadowpageRemarque : vous devez spécifier une valeur pour le
topicPageTemplate. Les propriétés landingPageTemplate et searchPageTemplate sont facultatives. Si vous ne souhaitez pas que les pages de recherche et de destination soient générées, ne spécifiez pas ces propriétés.titletopicContentNodetopicHeadNodetocNodebasePathPropindexPathProppdfPathProppdfTypePropsearchPathPropsiteTitlePropsourcePathProptocPathPropPour plus d’informations, consultez les sections Création de votre premier site web Adobe Experience Manager et Principes de base du développement de votre propre site web sur AEM.
Utiliser le titre du document pour générer la sortie du site AEM
Lors de la génération de la sortie du site AEM, la manière dont les URL sont générées joue un rôle important dans la capacité de découverte de votre contenu. Si vous utilisez des noms de fichiers basés sur l’UUID, la génération d’URL basées sur l’UUID de vos fichiers ne sera pas adaptée à la recherche. En tant qu’administrateur ou éditeur, vous avez le contrôle sur la manière dont vous souhaitez générer les URL pour la sortie de votre site AEM. AEM Guides vous offre une configuration qui vous permet de générer les URL de sortie du site AEM à l’aide du titre du fichier plutôt que des noms de fichier basés sur l’UUID. Par défaut, pour les systèmes de fichiers basés sur UUID, cette option est activée. Cela signifie que lorsque vous générez une sortie AEM Site pour des systèmes de fichiers basés sur l’UUID, les titres des fichiers sont utilisés pour générer les URL et non les UUID des fichiers.
Pour la configuration On-Premise avec des systèmes de fichiers non basés sur UUID, la sortie du site AEM est générée à l’aide des noms de fichier et non des titres du fichier. Par défaut, cette option est désactivée. Cela signifie que lorsque vous générez une sortie de site AEM, les noms de fichier sont utilisés pour générer les URL et non le titre du fichier. Vous pouvez choisir de générer les URL en fonction des titres des fichiers en activant cette option.
Les onglets suivants fournissent des instructions pour configurer la génération d’URL dans la sortie de site AEM en fonction de votre configuration Experience Manager Guides : Cloud Service ou On-Premise.
Suivez les instructions fournies dans Remplacements de la configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (property) suivants pour configurer la génération des URL dans la sortie du site AEM :
| table 0-row-3 1-row-3 | ||
|---|---|---|
| PID | Clé de la propriété | Valeur de la propriété |
com.adobe.fmdita.config.ConfigManager |
aemsite.pagetitle |
Booléen (true/false). Si vous souhaitez générer une sortie à l’aide du titre de la page, définissez cette propriété sur true. Par défaut, il est défini pour utiliser le nom de fichier . Valeur par défaut : false |
| note |
|---|
| NOTE |
La propriété aemsite.pagetitle définit le comportement par défaut au niveau du dossier pour les titres de page du site AEM. Si l’option permettant de sélectionner Topic filename ou Topic title est disponible dans le paramètre prédéfini AEM Sites pour votre environnement, la sélection au niveau du paramètre prédéfini est prioritaire et remplace la configuration au niveau du dossier aemsite.pagetitle pour cette sortie. Par exemple, si aemsite.pagetitle=true mais l’utilisateur sélectionne Nom de fichier de rubrique dans le paramètre prédéfini de sortie, le nom de fichier de rubrique est utilisé. Si aemsite.pagetitle=false l’utilisateur sélectionne Titre du topic, le titre du topic est utilisé. |
-
Ouvrez la page de configuration de la console web Adobe Experience Manager .
L’URL par défaut pour accéder à la page de configuration est :
code language-http http://<server name>:<port>/system/console/configMgr -
Recherchez et cliquez sur le lot com.adobe.fmdita.config.ConfigManager et cliquez dessus.
-
Sélectionnez l’option Utiliser le titre pour les noms de page du site AEM.
note NOTE Si vous souhaitez générer une sortie à l’aide des noms de fichier, désélectionnez cette option. -
Cliquez sur Enregistrer.
Configurez l’URL de sortie du site AEM pour utiliser le titre du document (uniquement pour Cloud Service)
Vous pouvez utiliser les titres du document dans l’URL de la sortie Site AEM. Si le nom de fichier n’existe pas ou contient tous les caractères spéciaux, vous pouvez configurer le système pour remplacer les caractères spéciaux par un séparateur dans l’URL de la sortie du site AEM. Vous pouvez également le configurer pour les remplacer par le nom de la première rubrique enfant.
Pour configurer les noms de page, procédez comme suit :
- Suivez les instructions fournies dans Remplacements de la configuration pour créer le fichier de configuration.
- Dans le fichier de configuration, fournissez les détails (propriété) suivants pour configurer les noms de page pour les rubriques.
com.adobe.fmdita.common.SanitizeNodeNamenodename.systemDefinedPageNametrue/false). Valeur par défaut : falsePar exemple, si le caractère ** dans <topichead> contient tous les caractères spéciaux et que vous définissez la propriété aemsite.pagetitle sur true, alors, par défaut, il utilise un séparateur. Si vous définissez la propriété nodename.systemDefinedPageName sur true, elle affiche le nom de la première rubrique enfant.
Configurez les règles d’assainissement de nom de fichier pour créer des rubriques et publier la sortie dans AEM Sites et d’autres formats id2164D0KD0XA
En tant qu’administrateur, vous pouvez définir une liste de caractères spéciaux valides autorisés dans les noms de fichier, qui constituent à terme l’URL d’une sortie de site AEM. Dans les versions antérieures, les utilisateurs étaient autorisés à définir des noms de fichier contenant des caractères spéciaux tels que @, $, >, etc. Ces caractères spéciaux entraînaient un encodage de l’URL lors de la génération des pages du site AEM.
À partir de la version 3.8, des configurations ont été ajoutées pour définir une liste de caractères spéciaux autorisés dans les noms de fichier. Par défaut, la configuration de nom de fichier valide contient « a-z A-Z 0-9 - _ ». Cela signifie que lors de la création d’un fichier, vous pouvez avoir n’importe quel caractère spécial dans le titre du fichier, mais qu’en interne, il sera remplacé par un trait d’union (-) dans le nom du fichier. Par exemple, si le titre du fichier est Introduction 1 ou Introduction@1, le nom de fichier correspondant généré pour ces deux cas serait Introduction-1.
Lorsque vous définissez une liste de caractères valides, n’oubliez pas que ces caractères « */:[\]|#%{}?&<>"/+ » et a space seront toujours remplacés par un trait d’union (-).
Les onglets suivants fournissent des instructions pour configurer les caractères spéciaux valides dans les noms de fichier et la sortie du site AEM en fonction de votre configuration Experience Manager Guides : Cloud Service ou On-Premise.
Suivez les instructions fournies dans Remplacements de la configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (property) suivants pour configurer les caractères spéciaux valides dans les noms de fichier et la sortie de site AEM :
| table 0-row-3 1-row-3 | ||
|---|---|---|
| PID | Clé de la propriété | Valeur de la propriété |
com.adobe.fmdita.common.SanitizeNodeNameImpl |
aemsite.DisallowedFileNameChars |
Assurez-vous que la propriété est définie sur '<>`@$. Vous pouvez ajouter d’autres caractères spéciaux à cette liste. |
| note |
|---|
| NOTE |
| La configuration ci-dessus s’applique à tous les formats de sortie. Cela signifie que lors de la génération d’une sortie PDF, HTML ou personnalisée, la sortie finale suivra les règles d’assainissement de nom de fichier configurées. |
Vous pouvez également configurer d’autres propriétés, telles que l’utilisation de minuscules dans les noms de fichier, un séparateur pour gérer les caractères non valides et le nombre maximal de caractères autorisés dans les noms de fichier. Pour configurer ces propriétés, ajoutez les paires clé-valeur suivantes dans le fichier de configuration :
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| Clé de la propriété | Valeur de la propriété |
nodename.uselower |
Booléen (true/false). Valeur par défaut : true |
nodename.separator |
N’importe quel caractère. Valeur par défaut : _ (trait de soulignement) |
nodename.maxlength |
Valeur entière. Valeur par défaut : 50 |
-
Ouvrez la page de configuration de la console web Adobe Experience Manager .
L’URL par défaut pour accéder à la page de configuration est :
code language-http http://<server name>:<port>/system/console/configMgr -
Recherchez et cliquez sur le lot com.adobe.fmdita.common.SanitizeNodeNameImpl et cliquez dessus.
-
Dans la propriété Jeu de caractères non autorisé pour la publication sur AEM Sites, assurez-vous que la propriété est définie sur
<>@$. Vous pouvez ajouter d’autres caractères spéciaux à cette liste. Toutefois, elle doit comporter ces caractères spéciaux obligatoires.note NOTE Vous pouvez également configurer d’autres propriétés telles que Utiliser les minuscules dans les noms de fichier, Séparateur pour gérer les caractères non valides et Nombre maximal de caractères autorisé dans les noms de fichier. -
Cliquez sur Enregistrer.
-
Recherchez et cliquez sur le lot com.adobe.fmdita.config.ConfigManager et cliquez dessus.
-
Dans la propriété Regex pour les caractères valides, assurez-vous que la propriété est définie sur
[-a-zA-Z0-9_]. Vous pouvez ajouter d’autres caractères à cette liste. Toutefois, elle doit comporter ces caractères de base et la liste doit commencer par un trait d’union (-).note NOTE Cette propriété définit la liste des caractères valides utilisés pour créer un fichier. -
Cliquez sur Enregistrer.
Configuration de l’aplatissement de la structure du nœud de site AEM
Lorsque vous générez une sortie de site AEM, un nœud pour chaque élément des rubriques est créé en interne. Pour un plan DITA comportant des milliers de rubriques, cette structure de nœud peut devenir trop profonde. Ce type de structure de nœud profondément imbriquée peut présenter des problèmes de performances pour les sites de plus grande taille. L’instantané suivant affiche la structure de nœud profondément imbriquée pour une sortie de site AEM :
Dans l’instantané ci-dessus, notez qu’un nœud est créé pour chaque élément p et ses sous-éléments suivants et qu’une structure similaire est créée pour tous les autres éléments utilisés dans la rubrique.
AEM Guides vous permet de configurer la manière dont la structure de nœud de sortie du site AEM est créée en interne. Vous pouvez aplatir la structure du nœud sur des éléments spécifiés, ce qui signifie que vous pouvez définir un élément qui sera considéré comme l’élément principal et tous les sous-éléments qu’il contient seront fusionnés avec l’élément principal. Par exemple, si vous décidez d’aplatir l’élément p, tout élément apparaissant dans l’élément p sera fusionné avec l’élément p principal. Aucune note distincte ne serait créée pour un sous-élément dans l’élément p. L’instantané suivant affiche la structure du nœud aplatie au niveau de p élément :
Les onglets suivants fournissent des instructions pour aplatir la structure du nœud du site AEM en fonction de votre configuration Experience Manager Guides : Cloud Service ou On-Premise.
-
Identifiez le ou les éléments auxquels vous souhaitez aplatir la structure de nœud :
-
Recouvrez le nœud
libsdans le nœudappset ouvrez le fichier elementmapping.xml . -
Ajoutez la propriété
<flatten>true</flatten>dans la définition de l’élément au niveau duquel vous souhaitez aplatir la structure de nœud. Par exemple, si vous souhaitez aplatir la structure du nœud au niveau de l’élémentp, ajoutez l’attribut flatten dans la définition dep’élément comme illustré ci-dessous :code language-xml <ditaelement> <name>p</name> <class>- topic/p</class> <componentpath>fmdita/components/dita/wrapper</componentpath> <type>COMPOSITE</type> <target>para</target> <flatten>true</flatten> <wrapelement>div</wrapelement> </ditaelement>note NOTE Par défaut, la propriété de nœud flatten a été configurée au niveau de l’élément p. -
Suivez les instructions fournies dans Remplacements de la configuration pour créer le fichier de configuration.
-
Dans le fichier de configuration, fournissez les détails (property) suivants :
table 0-row-3 1-row-3 PID Clé de la propriété Valeur de la propriété com.adobe.dxml.flattening.FlatteningConfigurationServiceflattening.enabledBooléen (true/false).
Valeur par défaut :false
Désormais, lorsque vous générez la sortie du site AEM, les nœuds de l’élément p sont aplatis et stockés dans l’élément p lui-même. Vous trouverez les nouvelles propriétés d’aplatissement de l’élément p dans CRXDE.
-
Indiquez l’élément sur lequel vous souhaitez aplatir la structure du nœud.
-
Recouvrez le nœud
libsdans le nœudappset ouvrez le fichier elementmapping.xml . -
Ajoutez la propriété
<flatten>true</flatten>dans la définition de l’élément au niveau duquel vous souhaitez aplatir la structure de nœud. Par exemple, si vous souhaitez aplatir la structure du nœud au niveau de l’élémentp, ajoutez l’attribut flatten dans la définition dep’élément comme illustré ci-dessous :code language-xml <ditaelement> <name>p</name> <class>- topic/p</class> <componentpath>fmdita/components/dita/wrapper</componentpath> <type>COMPOSITE</type> <target>para</target> <flatten>true</flatten> <wrapelement>div</wrapelement> </ditaelement>note NOTE Par défaut, la propriété de nœud flatten a été configurée au niveau de l’élément p.
-
-
Activez la configuration de l’aplatissement des nœuds de site dans configMgr.
-
Ouvrez la page de configuration de la console web Adobe Experience Manager .
L’URL par défaut pour accéder à la page de configuration est :
code language-http http://<server name>:<port>/system/console/configMgr -
Recherchez et cliquez sur le lot com.adobe.dxml.flattening.FlateningConfigurationService et cliquez dessus.
-
Sélectionnez l’option Propriété flatting.enabled.
-
Cliquez sur Enregistrer.
-
| note important |
|---|
| IMPORTANT |
| Si vous avez apporté des modifications au fichier elementmapping.xml, assurez-vous d’ouvrir configMgr et d’enregistrer le lot pour que les modifications prennent effet. |
Désormais, lorsque vous générez la sortie du site AEM, les nœuds de l’élément p sont aplatis et stockés dans l’élément p lui-même. Vous trouverez les nouvelles propriétés d’aplatissement de l’élément p dans CRXDE.
Recherche d’une chaîne dans le contenu de la sortie du site AEM (uniquement pour Cloud Service)
Par défaut, vous pouvez rechercher une chaîne dans les titres uniquement dans la sortie du site AEM. Vous pouvez configurer le système pour rechercher une chaîne à la fois dans les titres et dans le contenu ou le corps de la sortie du site AEM.
Pour activer la recherche, vous devez configurer l’aplatissement de la structure de nœud du site AEM.
ATTENTION :
Vous pouvez rechercher jusqu’à 1 Mo de contenu aplati. Par exemple, dans la capture d’écran précédente, vous pouvez rechercher si le contenu situé sous la balise <p> est <= 1 Mo.
<flatten> est défini sur true. Par défaut, l’attribut <flatten> d’AEM Guides est défini sur true pour les éléments de texte couramment utilisés, tels que <p> <ul> <lI>. Cependant, si vous avez créé des éléments personnalisés, vous devez définir l’attribut <flatten> sur true dans le fichier elementmapping.xml.Empêcher l’aplatissement de la structure du nœud du site AEM
Tout comme pour la spécification du nœud à aplatir dans la sortie du site AEM, vous pouvez également spécifier un élément que vous souhaitez exclure de cette configuration. Par exemple, si vous souhaitez aplatir les nœuds au niveau de body élément, mais que vous ne souhaitez pas aplatir les éléments table dans body, vous pouvez ajouter la propriété exclude dans la définition de l’élément table.
Pour exclure l’élément table de l’aplatissement, ajoutez la propriété suivante à la définition de l’élément table :
<preventancestorflattening>true|false</preventancestorflattening>
Configurer le contrôle de version des pages supprimées dans la sortie du site AEM
Lorsque vous générez une sortie de site AEM avec les options Supprimer et Créer sélectionnées pour le paramètre Pages de sortie existantes , une version est créée pour la ou les pages en cours de suppression. Vous pouvez configurer le système pour arrêter la création d’une version avant la suppression.
Les onglets suivants fournissent des instructions pour arrêter la création d’une version pour la ou les pages supprimées en fonction de votre configuration Experience Manager Guides : Cloud Service ou On-Premise.
-
Suivez les instructions fournies dans Remplacements de la configuration pour créer le fichier de configuration.
-
Dans le fichier de configuration, fournissez les détails (property) suivants pour configurer l’option Ne pas créer de version pour les pages supprimées :
table 0-row-3 1-row-3 PID Clé de la propriété Valeur de la propriété com.adobe.fmdita.confi g.ConfigManagerno.version.creation.on.deletionBooléen (true/false).
Valeur par défaut :truenote NOTE Lorsque cette option est sélectionnée, les utilisateurs peuvent supprimer directement une ou plusieurs pages sans créer de version pour eux. Si l’option n’est pas sélectionnée, une version est créée avant la suppression de la ou des pages .
-
Ouvrez la page de configuration de la console web Adobe Experience Manager .
L’URL par défaut pour accéder à la page de configuration est :
code language-http http://<server name>:<port>/system/console/configMgr -
Recherchez et cliquez sur le lot com.adobe.fmdita.config.ConfigManager et cliquez dessus.
-
Sélectionnez l option Ne pas créer de version pour les pages supprimées.
note NOTE Lorsque cette option est sélectionnée, les utilisateurs peuvent supprimer directement une ou plusieurs pages sans créer de version pour eux. Si l’option n’est pas sélectionnée, une version est créée avant la suppression de la ou des pages . -
Cliquez sur Enregistrer.
Configuration d’une réécriture personnalisée avec Experience Manager Guides (uniquement pour Cloud Service) custom-rewriter
Experience Manager Guides dispose d’un module sling rewriter personnalisé destiné à gérer les liens générés en cas de mappages croisés (liens entre les rubriques de deux mappages différents). Cette configuration de réécriture est installée au chemin suivant :/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher.
Si votre base de code contient un autre module de réécriture Sling personnalisé, utilisez une valeur de 'order' supérieure à 50, car le module de réécriture Sling de Experience Manager Guides utilise 'order' 50. Pour remplacer ce paramètre, vous avez besoin d’une valeur > 50 . Pour plus d’informations, consultez la section Pipelines de réécriture de sortie.