Configuration des paramètres de génération de sortie id181AI0B0E30
AEM Guides contient de nombreuses options de configuration vous permettant de personnaliser le processus de génération de sortie. Cette rubrique couvre toutes les configurations et personnalisations qui vous aideront à configurer votre processus de génération de sortie.
Configuration de l’onglet Ligne de base dans le tableau de bord de la carte DITA id223MD0D0YRM
Pour masquer l’onglet Ligne de base dans le tableau de bord de la carte DITA, procédez comme suit :
- Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration.
- Dans le fichier de configuration, fournissez les détails (propriété) suivants pour configurer l’onglet de ligne de base sur le tableau de bord de carte.
com.adobe.fmdita.config.ConfigManager
hide.tabs.baseline
true/false
).Valeur par défaut: true
Configuration de la publication mixte dans un site AEM existant id1691I0V0MGR
Si vous disposez d’un site AEM qui contient du contenu DITA, vous pouvez configurer la sortie AEM site pour publier du contenu DITA vers un emplacement prédéfini de votre site. Par exemple, dans la capture d’écran suivante d’une page AEM Site, la variable ditacontent
est réservé au stockage du contenu DITA :
Les autres noeuds de la page sont créés directement à partir de l’éditeur de site AEM. La configuration du paramètre de publication pour publier du contenu DITA vers un emplacement prédéfini garantit qu’aucun de vos contenus non DITA existants n’est modifié par le processus de publication AEM Guides.
Vous devez effectuer les configurations suivantes sur votre site existant pour permettre la publication de contenu DITA sur un noeud prédéfini :
-
Configuration des propriétés de modèle de votre site
-
Ajout de noeuds sur votre site pour publier du contenu DITA
Effectuez les étapes suivantes pour configurer les propriétés de modèle de votre site existant :
-
Utilisez le gestionnaire de modules pour télécharger le fichier /libs/fmdita/config/templates/default .
note note NOTE Ne pas mettre à disposition des personnalisations dans les fichiers de configuration par défaut dans le libs
noeud . Vous devez créer une superposition de la variablelibs
dans le noeudapps
et mettez à jour les fichiers requis dans leapps
uniquement. -
Ajoutez les propriétés suivantes :
table 0-row-3 1-row-3 2-row-3 Nom de la propriété Type Valeur topicContentNode
Chaîne Indiquez le nom du noeud dans lequel vous souhaitez publier le contenu DITA. Par exemple, le noeud par défaut où AEM Guides publie du contenu DITA est le suivant : jcr:content/contentnode
topicHeadNode
Chaîne Indiquez le nom du noeud dans lequel vous souhaitez stocker les informations de métadonnées de votre contenu DITA. Par exemple, le noeud par défaut où AEM Guides stocke les informations de métadonnées est le suivant : jcr:content/headnode
La prochaine fois que vous publierez du contenu DITA à l’aide des configurations de modèle de votre site, le contenu sera publié dans les noeuds spécifiés dans la variable topicContentNode
et topicHeadNode
propriétés.
Personnalisation de la sortie AEM site id166TG0B30WR
AEM Guides prend en charge la création de sorties dans les formats suivants :
- AEM site
- HTML5
- EPUB
- Sortie personnalisée via DITA-OT
Pour la sortie Site AEM, vous pouvez affecter différents modèles de conception avec différentes tâches de sortie. Ces modèles de conception peuvent rendre le contenu DITA dans différentes mises en page. Par exemple, vous pouvez spécifier différents modèles de conception pour les audiences internes et externes.
Vous pouvez également utiliser les modules externes de boîte à outils ouverte DITA personnalisés (DITA-OT) avec les AEM Guides. Vous pouvez charger ces modules externes 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 AEM site. Vous pouvez personnaliser les modèles de conception des Guides d’AEM pour générer la 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 noeuds JCR qui lient toutes ces ressources. Un modèle de conception peut être aussi simple qu’un seul script côté serveur avec quelques noeuds JCR ou une combinaison complexe de styles, de ressources et de noeuds JCR. Les modèles de conception sont utilisés par AEM sous-système de publication Guides lors de la génération de la sortie AEM site et contrôlent la structure, l’aspect et l’aspect de la sortie générée.
Il n’y a aucune restriction quant à l’emplacement des ressources du modèle de conception sur le serveur, mais elles sont généralement logiquement organisées selon leur fonction. Par exemple, le modèle par défaut contient tous ses fichiers JavaScript et CSS stockés sous /etc/designs/fmdita/clientlibs/siteoutput/default
dossier. Où que ces fichiers soient situés, ils sont liés ensemble par une collection de noeuds JCR. Ensemble, ces noeuds JCR et les fichiers constituent l’ensemble du modèle de conception.
Le modèle de conception par défaut fourni avec les AEM Guides vous permet de personnaliser les composants de page d’entrée, 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.
Effectuez les étapes suivantes pour spécifier votre propre modèle de conception à utiliser pour AEM génération de sortie de site :
-
Utilisez le gestionnaire de modules 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 le référentiel Git de Cloud Manager :
/apps/fmdita/config/templates
-
Vous devez également télécharger et copier les modèles référencés à partir du noeud de modèle par défaut. Les modèles référencés sont placés sous :
/libs/fmdita/templates/default/cqtemplates
Les propriétés du modèle de conception des Guides d’AEM sont décrites dans le tableau suivant.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 Propriété Description landingPageTemplate
,searchPageTemplate
,topicPageTemplate
,shadowPageTemplate
Spécifiez la variable cq:Template
noeud pour ces pages correspondantes (entrée, recherche et rubrique). Par défaut, la variablecq:Template
Le noeud de ces pages se trouve dans/libs/fmdita/templates/default/cqtemplates
noeud . Ce noeud définit la structure et les propriétés des pages d’entrée, de recherche et de rubrique.
La variableshadowPageTemplate
est utilisé pour optimiser le contenu fragmenté. Vous devez définir la valeur de cette propriété sur :fmdita/templates/default/cqtemplates/shadowpage
Remarque : Vous devez spécifier une valeur pour la variabletopicPageTemplate
. La variablelandingPageTemplate
etsearchPageTemplate
sont des propriétés facultatives. Si vous ne souhaitez pas que la recherche et les landing pages soient générées, ne spécifiez pas ces propriétés.title
Nom descriptif de votre modèle de conception. topicContentNode
Emplacement du noeud qui contiendra le contenu DITA dans une page de rubrique. Le chemin d’accès est relatif à la page de rubrique. topicHeadNode
L’emplacement du noeud qui contiendra les valeurs d’en-tête (ou metadata) dérivées du contenu DITA. Le chemin d’accès est relatif à la page de rubrique. tocNode
Emplacement du noeud qui contiendra la table des matières. Le chemin d’accès est relatif à la page d’entrée ou au chemin de destination. basePathProp
Nom de la propriété pour stocker le chemin d’accès de la racine du site publié. indexPathProp
Nom de la propriété pour le stockage du chemin d’accès à la page d’entrée/d’index du site publié. pdfPathProp
Nom de propriété pour le stockage du chemin du PDF de rubrique, si la génération du PDF de rubrique est activée. pdfTypeProp
Nom de la propriété pour le stockage du type de génération de PDF. Actuellement, cette propriété contient toujours "Topic". searchPathProp
Nom de la propriété pour stocker le chemin d’accès à la page de recherche, si le modèle inclut une page de recherche. siteTitleProp
Nom de la propriété pour stocker le titre du site en cours de publication. Ce titre est généralement identique au titre de la carte en cours de publication. sourcePathProp
Nom de la propriété pour le stockage du chemin d’accès de la rubrique DITA source pour la page active. tocPathProp
Nom de la propriété pour stocker le chemin d’accès de la racine de la table des matières du site publié.
Pour plus d’informations, voir Création de votre premier site web Adobe Experience Manager et Principes de base de développer votre propre site web sur AEM.
Utiliser le titre du document pour générer AEM sortie du site
Lors de la génération de la sortie AEM site, la manière dont les URL sont générées joue un rôle important dans la découverte de votre contenu. Si vous utilisez des noms de fichier UUID, la génération d’URL basées sur l’UUID de vos fichiers ne serait pas compatible avec 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 votre sortie de site AEM. AEM Guides vous donne une configuration par laquelle vous pouvez choisir de générer les URL d’AEM sortie de site à 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 UUID, cette option est activée. Cela impliquait que lorsque vous générez AEM sortie Site pour les systèmes de fichiers UUID, les titres du fichier sont utilisés pour générer les URL et non les UUID des fichiers.
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (propriété) suivants pour configurer la génération des URL dans AEM sortie Site :
com.adobe.fmdita.config.ConfigManager
aemsite.pagetitle
Valeur par défaut: false
Configurez l’URL de la sortie Site AEM pour utiliser le titre du document.
Vous pouvez utiliser les titres des documents dans l’URL de la sortie AEM Site. 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 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 de la section Remplacements de 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 des rubriques.
com.adobe.fmdita.common.SanitizeNodeName
nodename.systemDefinedPageName
true/false
). Valeur par défaut: false
Par exemple, si la variable @navtitle in <topichead>
comporte tous les caractères spéciaux et vous définissez la variable aemsite.pagetitle
sur true, puis, par défaut, il utilise un séparateur. Si vous définissez la variable nodename.systemDefinedPageName
sur true, il affiche le nom de la première rubrique enfant.
Configuration des règles d’assainissement des noms de fichier pour la création de rubriques et la publication AEM sortie du site 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 forment éventuellement l’URL d’une sortie 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 l’encodage d’URL lors de la génération de pages de site AEM.
À compter 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 du 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 en interne, il sera remplacé par un trait d’union (-
) dans le nom du fichier. Par exemple, le titre du fichier peut être 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
sera toujours remplacé par un trait d’union (-
).
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (propriété) suivants pour configurer les caractères spéciaux valides dans les noms de fichier et AEM sortie Site :
com.adobe.fmdita.common.SanitizeNodeNameImpl
aemsite.DisallowedFileNameChars
'<>`@$
. Vous pouvez ajouter des caractères spéciaux à cette liste.Vous pouvez également configurer d’autres propriétés, telles que l’utilisation de minuscules dans les noms de fichier, le 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 :
nodename.uselower
Valeur par défaut: true
nodename.separator
Valeur par défaut: _ (trait de soulignement)
nodename.maxlength
Valeur par défaut: 50
Configuration de l’aplatissement de AEM structure de noeuds Site
Lorsque vous générez AEM sortie Site, un noeud pour chaque élément des rubriques est créé en interne. Pour un mappage DITA contenant des milliers de rubriques, cette structure de noeud peut devenir trop profonde. Ce type de structure de noeuds profondément imbriqués peut présenter des problèmes de performances pour les sites plus volumineux. L’instantané suivant affiche la structure de noeuds profondément imbriqués pour une sortie AEM Site :
Dans l’instantané ci-dessus, notez qu’un noeud est créé pour chaque p
et ses sous-éléments suivants, ainsi qu’une structure similaire, sont créés pour chaque autre élément utilisé dans la rubrique.
AEM Guides vous permet de configurer la manière dont AEM structure de noeud de sortie de site est créée en interne. Vous pouvez aplatir la structure du noeud au niveau 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 la variable p
, puis tout élément apparaissant dans la variable p
est fusionné avec l’élément principal. p
élément . Une note distincte ne serait créée pour aucun sous-élément dans la variable p
élément . L’instantané suivant affiche la structure de noeud aplatie au niveau de p
element:
Pour aplatir AEM structure de noeuds de site, procédez comme suit :
-
Identifiez l’élément(s) sur lequel vous souhaitez aplatir la structure de noeud :
-
Incrustation de la
libs
dans le noeudapps
et ouvrez le fichier elementmapping.xml . -
Ajoutez la variable
<flatten>true</flatten>
dans la définition de l’élément sur lequel vous souhaitez aplatir la structure du noeud. Par exemple, si vous souhaitez aplatir la structure de noeud au niveau de la propriétép
, puis ajoutez l’attribut flatten dans la définition dep
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 NOTE Par défaut, la propriété de noeud aplati a été configurée à l’adresse p
élément . -
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration.
-
Dans le fichier de configuration, fournissez les détails (propriété) suivants :
table 0-row-3 1-row-3 PID Clé de propriété Valeur de la propriété com.adobe.dxml.flattening.FlatteningConfigurationService
flattening.enabled
Booléen (true/false).
Valeur par défaut:false
Désormais, lorsque vous générez la sortie Site AEM, les noeuds de la variable p
sont aplatis et stockés dans la variable p
élément lui-même. Vous trouverez les nouvelles propriétés d’aplatissement pour la variable p
dans CRXDE.
Recherche d’une chaîne dans le contenu de la sortie AEM site
Par défaut, vous pouvez rechercher une chaîne dans les titres uniquement dans la sortie AEM Site. 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 AEM Site.
Pour activer la recherche, vous devez configurer l’aplatissement de AEM structure de noeuds Site.
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 sous <p> La balise est <= 1Mo.
<flatten>
est défini sur true. Par défaut, AEM Guides a la variable <flatten>
est défini sur true pour les éléments de texte couramment utilisés tels que <p> <ul> <li>. Cependant, si vous avez créé certains éléments personnalisés, vous devez définir la variable <flatten>
sur true dans le fichier elementmapping.xml.Empêcher l’aplatissement de AEM structure de noeuds de site
Tout comme pour spécifier le noeud à aplatir dans AEM sortie Site, vous pouvez également spécifier un élément que vous souhaitez exclure de cette configuration. Par exemple, si vous souhaitez aplatir des noeuds au niveau de body
, mais vous ne souhaitez pas d’éléments table
element dans body
pour aplatir, vous pouvez ajouter la propriété exclude dans la propriété table
définition de l’élément.
Pour exclure la variable table
à partir de l’aplatissement, ajoutez la propriété suivante au table
définition de l’élément :
<preventancestorflattening>true|false</preventancestorflattening>
Configuration du contrôle de version pour les pages supprimées dans AEM sortie Site
Lorsque vous générez AEM sortie Site avec Supprimer et Créer sélectionnée pour le paramètre Pages de sortie existantes , une version est créée pour la page(s) supprimée. Vous pouvez configurer le système pour arrêter la création d’une version avant la suppression.
Effectuez les étapes suivantes pour arrêter la création d’une version de la page(s) supprimée :
-
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration.
-
Dans le fichier de configuration, fournissez les détails (propriété) suivants pour configurer la variable Ne pas créer de version pour les pages supprimées option :
table 0-row-3 1-row-3 PID Clé de propriété Valeur de la propriété com.adobe.fmdita.confi g.ConfigManager
no.version.creation.on.deletion
Booléen (true/false).
Valeur par défaut:true
note note NOTE Lorsque cette option est sélectionnée, les utilisateurs peuvent supprimer directement n’importe quelle page sans créer de version pour eux. Si cette option n’est pas sélectionnée, une version est créée avant la suppression de la ou des pages.
Configuration d’un module de réécriture personnalisé avec des guides du Experience Manager custom-rewriter
Les guides du Experience Manager ont un sling personnalisé rewriter module de gestion des liens générés en cas de croix (liens entre les rubriques de deux cartes différentes). Cette configuration de module de réécriture est installée à l’emplacement suivant :/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher
.
Si votre code base comporte un autre module de réécriture sling personnalisé, utilisez une 'order'
valeur supérieure à 50, comme l’utilise le module de réécriture sling de Guides de Experience Manager 'order'
50. Pour le remplacer, vous devez disposer d’une valeur supérieure à 50 . Pour plus d’informations, voir Pipelines de réécriture de sortie.
Utilisation de métadonnées pour publier une sortie via DITA-OT id191LF0U0TY4
AEM Guides permet de transmettre des métadonnées personnalisées lors de la publication d’une sortie à l’aide de DITA-OT. En tant qu’administrateur et éditeur, vous devez effectuer les tâches suivantes pour configurer et utiliser des métadonnées personnalisées dans la sortie publiée :
-
En tant qu’administrateur, ajoutez les métadonnées requises dans le système afin qu’elles soient disponibles sur la page Propriétés du mappage DITA.
-
En tant qu’administrateur, ajoutez les métadonnées personnalisées dans la liste des métadonnées afin qu’elles s’affichent dans la console de mappage DITA.
-
En tant qu’éditeur, configurez et ajoutez les métadonnées personnalisées avec le mappage DITA et générez la sortie requise.
Pour ajouter les métadonnées requises dans le système, procédez comme suit :
-
Connectez-vous à Adobe Experience Manager en tant qu’administrateur.
-
Cliquez sur le lien Adobe Experience Manager en haut de l’écran et choisissez Outils.
-
Sélectionner Ressources dans la liste des outils.
-
Cliquez sur le bouton Schémas de métadonnées mosaïque.
La page Forms de schéma de métadonnées s’affiche.
-
Sélectionnez la variable default formulaire de la liste.
note note NOTE Les propriétés affichées sur la page Propriétés d’un mappage DITA proviennent de ce formulaire. -
Cliquez sur Modifier.
-
Ajoutez les métadonnées personnalisées que vous souhaitez utiliser dans les sorties publiées. Par exemple, nous allons ajouter des métadonnées d’audience en procédant comme suit :
-
Dans la Créer un formulaire liste de composants, glisser-déposer Une seule ligne de texte sur le formulaire.
-
Sélectionnez le nouveau champ pour ouvrir le Paramètres du champ .
-
Dans le Libellé du champ, saisissez le nom des métadonnées : Audience.
-
Dans le Associer à la propriété , spécifiez ./jcr:content/metadata/<name of="" the="" metadata="">. Dans notre exemple, nous allons le définir sur ./jcr:content/metadata/audience
À l’aide de ces étapes, ajoutez tous les paramètres de métadonnées requis.
-
-
Cliquez sur Enregistrer.
Le nouveau paramètre s’affiche désormais sur la page Propriétés pour tous les mappages DITA.
Ensuite, vous devez rendre les métadonnées personnalisées disponibles dans la console de mappage DITA. Effectuez les étapes suivantes pour rendre les métadonnées personnalisées disponibles sur le tableau de bord de mappage DITA :
-
Utilisez le gestionnaire de modules pour accéder au fichier metadataList disponible à l’emplacement suivant dans le référentiel Git de Cloud Manager :
/libs/fmdita/config/metadataList
note note NOTE Le fichier metadataList contient une liste de propriétés qui s’affichent dans la variable Propriétés liste déroulante d’un mappage DITA dans le tableau de bord de mappage. Par défaut, quatre propriétés sont répertoriées dans ce fichier : docstate, dc:language, dc:description et dc:title. -
Ajoutez les métadonnées personnalisées que vous avez ajoutées à la page Forms du schéma de métadonnées . Dans notre exemple, ajoutez le paramètre audience à la fin de la liste par défaut.
Désormais, les métadonnées personnalisées s’affichent dans le Propriétés liste déroulante.
Enfin, en tant qu’éditeur, vous devez inclure les métadonnées personnalisées dans la sortie publiée. Pour traiter les métadonnées personnalisées lors de la génération de la sortie, procédez comme suit :
-
Dans l’interface utilisateur d’Assets, accédez au mappage DITA que vous souhaitez publier.
-
Sélectionnez le fichier de mappage DITA et ouvrez sa page de propriétés.
-
Sur la page Propriétés , spécifiez la valeur des métadonnées personnalisées. Dans notre exemple, nous avons spécifié une valeur Externe pour le paramètre d’audience .
-
Cliquez sur Enregistrer et fermer.
-
Cliquez sur le fichier de mappage DITA pour ouvrir la console de mappage DITA.
-
Dans le Paramètres prédéfinis de sortie , sélectionnez le paramètre prédéfini de sortie à utiliser pour générer la sortie.
-
Cliquez sur Modifier.
-
Dans la Propriétés , sélectionnez les propriétés à transmettre au processus de publication.
Les propriétés/métadonnées sélectionnées sont transmises au processus de publication et mises à disposition dans la sortie finale.
Validation des métadonnées transmises à DITA-OT pour traitement
Pour valider les valeurs de métadonnées transmises à DITA-OT, vous pouvez utiliser un environnement local à l’aide d’un jar prêt pour le cloud. Comme nous ne pouvons pas accéder au système de fichiers local sur le cloud, seul le fichier de métadonnées peut être validé au moyen d’un fichier JAR prêt pour le cloud.
-
Nom du fichier : metadata.xml
-
Emplacement du fichier : crx-quickstart/profiles/ditamaps/<ditamap-1234>
Pour accéder à metadata.xml :
- Connectez-vous à l’emplacement du serveur sur lequel l’instance AEM est en cours d’exécution.
- Migration vers crx-quickstart/profiles/ditamaps/<newly-created-directory-name>/metadata.xml.
-
Exemple de format de fichier :
metadata.xml
code language-xml <?xml version="1.0" encoding="UTF-8" standalone="no"?> <root> <Path id="/absolutePath/sampleMap.ditamap"> <metadata> <meta isArray="false" key="dc:description">This is a file</meta> <meta isArray="false" key="dc:title">Myfile</meta> <meta isArray="true" key="multivalueText">One;Two;Three</meta> </metadata> </Path> <Path id="/absolutePath/sampleTopic.dita"> <metadata> <meta isArray="false" key="dc:description">description for the accountability</meta> <meta isArray="false" key="dc:title">accountability title</meta> <meta isArray="true" key="multivalueText">value1</meta> </metadata> </Path> </root>
-
isArray : attribut booléen qui définit si les métadonnées sont à plusieurs valeurs (Array) ou non. Les valeurs sont délimitées par un point-virgule.
-
ID de chemin d’accès : chemin d’accès absolu au fichier stocké dans le répertoire temporaire.
Personnalisation du mappage des éléments DITA avec les composants AEM id1679J600HEL
Les éléments DITA dans les Guides AEM sont mappés à leurs composants AEM correspondants. AEM Guides utilise ce mappage dans des processus tels que la publication et la révision pour convertir un élément DITA en composant AEM correspondant. Le mappage est défini dans la variable elementmapping.xml
, accessible à l’aide du gestionnaire de modules.
libs
noeud . Vous devez créer une superposition de la variable libs
dans le noeud apps
et mettez à jour les fichiers requis dans le apps
uniquement.Vous pouvez utiliser les mappages d’éléments DITA prédéfinis ou vous pouvez mapper des éléments DITA à vos composants d’AEM personnalisés. Pour utiliser vos composants d’AEM personnalisés, vous devez comprendre la structure de la variable elementmapping.xml
fichier .
structure elementmapping.xml
Présentation générale de la variable elementmapping.xml
La structure est expliquée ci-dessous :
-
Chaque élément DITA est d’abord recherché dans un mappage de composant correspondant en fonction du nom de l’élément. Par exemple :
code language-xml <ditaelement> <name>**substeps**</name> <class>- topic/ol task/substeps</class> <componentpath>dita/components/ditaolist</componentpath> <type>COMPOSITE</type> <target>para</target> </ditaelement>
Dans l’exemple ci-dessus, toutes les
substeps
Les éléments DITA sont rendus à l’aide de la fonctiondita/components/ditaolist
composant. -
Si un élément DITA ne trouve pas de correspondance basée sur le nom, alors une correspondance basée sur la variable
class
est terminé. Par exemple :code language-xml <ditaelement> <name>topic</name> <class>**- topic/topic**</class> <componentpath>fmdita/components/dita/topic</componentpath> <type>COMPOSITE</type> <target>para</target> <attributemap> <attribute from="id" to="id" /> </attributemap> </ditaelement>
Dans l’exemple ci-dessus, si aucun mappage n’est défini pour la variable
task
, puis la variabletask
est mappé sur le composant ci-dessus, cartask
est hérité de la propriététopic
composant. -
Lorsqu’un élément possède un mappage de composant correspondant, le traitement ultérieur de ses éléments enfants est déterminé par
type
. Par exemple :code language-xml <ditaelement> <name>title</name> <class>- topic/title</class> <componentpath>foundation/components/title</componentpath> <type>**STANDALONE**</type> <target>para</target> <textprop>jcr:title</textprop> </ditaelement>
type
prend les valeurs suivantes :-
COMPOSITE : élément au composant le mappage se poursuit pour les éléments enfants ainsi que .
-
STANDALONE : les éléments enfants de l’élément actif sont n’est plus mappé.
Dans l’exemple ci-dessus, si la variable
<title>
contient des éléments enfants, ils ne seront mappés à aucun autre composant. Le composant pour<title>
est responsable du rendu de tous les éléments enfants à l’intérieur de la fonction<title>
élément . -
-
S’il existe plusieurs composants mappés à un seul élément DITA, la meilleure correspondance pour l’élément est sélectionnée. Pour sélectionner le meilleur composant de correspondance, la spécialisation du domaine et de la structure des éléments DITA est prise en compte.
S’il existe des éléments DITA avec spécialisation de domaine et qu’un composant est mappé pour la spécialisation de domaine, ce composant reçoit une priorité élevée.
De même, s’il existe des éléments DITA avec une spécialisation structurelle et qu’un composant est mappé pour la spécialisation structurelle, ce composant reçoit une priorité élevée.
-
Vous pouvez utiliser
<attributemap>
dans le mappage des éléments pour mapper les valeurs d’attribut aux propriétés de noeud correspondantes. -
textprop
peut être utilisé pour sérialiser le contenu textuel d’un élément DITA vers une propriété de noeud. En outre, il peut être utilisé plusieurs fois dans une balise d’élément pour sérialiser le contenu du texte à plusieurs emplacements dans la hiérarchie publiée. Vous pouvez également personnaliser l’emplacement et le nom de la propriété cible. Par exemple :code language-xml <ditaelement> <name>title</name> <componentpath>foundation/components/title</componentpath> <type>STANDALONE</type> <target>para</target> <textprop>**jcr:title**</textprop> </ditaelement>
Le mappage d’élément ci-dessus indique que le contenu textuel de
<title>
sera enregistré comme valeur d’une propriété nomméejcr:title
sur le noeud output. -
xmlprop
peut être utilisé pour sérialiser le XML entier d’un élément donné vers une propriété de noeud. Le composant peut ensuite lire cette propriété de noeud et effectuer un rendu personnalisé. Par exemple :code language-xml <ditaelement> <name>svg-container</name> <class>+ topic/foreign svg-d/svg-container</class> <componentpath>fmdita/components/dita/svg</componentpath> <type>STANDALONE</type> <target>para</target> <xmlprop>**data**</xmlprop> </ditaelement>
Le mappage d’élément ci-dessus indique que le balisage XML entier de l’élément
<svg-container>
sera enregistrée comme valeur d’une propriété nomméedata
sur le noeud output. -
Il existe un mappage d’attributs spécial pour gérer la résolution du chemin dans le processus de génération de sortie. Par exemple :
code language-xml <attributemap> <attribute from="href" to="fileReference" ispath="true" rel="source" /> <attribute from="height" to="height" /> <attribute from="width" to="width" /> </attributemap>
Pour ce qui concerne
attributemap
, la variablehref
dans votre élément DITA sera mappé à une propriété de noeud nomméefileReference
. Maintenant depuisispath
est défini surtrue
, le processus de génération de sortie résout ce chemin, puis le définit dansfileReference
de noeud.La manière dont cette résolution se produit est déterminée en fonction de la valeur de la variable
rel
dans le mappage des attributs.-
If
rel=source
, puis la valeur dehref
est résolu par rapport au fichier source DITA en cours de traitement. La valeur dehref
est résolu et placé dans la valeur defileReference
. -
If
rel=target
, puis la valeur dehref
est résolu par rapport à l’emplacement de publication racine. La valeur dehref
est résolu et placé dans la valeur defileReference
.
Si vous ne souhaitez pas qu’un prétraitement ou une résolution se produise sur les attributs de chemin d’accès, vous n’avez pas besoin de spécifier la variable
ispath
attribut. La valeur est copiée telle quelle et le composant peut effectuer la résolution requise. -
Schéma d’élément DITA
Voici un exemple du schéma d’élément DITA dans elementmapping.xml
fichier :
<ditaelement>
<name>element_name</name>
<class>element_class</class>
<componentpath>fmdita/components/dita/component_name</componentpath>
<type>COMPOSITE|STANDALONE</type>
<attributeprop>propname_a</attributeprop>
<textprop>propname_t</textprop>
<xmlprop>propname_x</xmlprop>
<xpath>xpath expression string</xpath>
<target>head|para</target>
<wrapelement>div</wrapelement>
<wrapclass>class_name</wrapclass>
<attributemap>
<attribute from="attrname" to="propname" ispath="true|false" rel="source|target" />
</attributemap>
<skip>true|false</skip>
</ditaelement>
Le tableau suivant décrit les éléments du schéma d’élément DITA :
<ditaelement>
<class>
Par exemple, l’attribut de classe pour la rubrique DITA est :
- topic/topic
<componentpath>
<type>
- COMPOSITE: traitez également les éléments enfants.
- AUTONOME: ignore le traitement des éléments enfants
<attributeprop>
<note type="Caution">
et que le composant mappé pour cet élément comporte <attributeprop>attr_t</ attributeprop>
, l’attribut et la valeur du noeud sont sérialisés en attr_t
propriété du noeud d’AEM correspondant ( attr_t->type="caution"
).<textprop>propname_t</textprop>
getTextContent()
sortie vers la propriété définie par propname_t.
Remarque : C’est une propriété optimisée.
<xmlprop>propname_x </xmlprop>
propname_x.<br>
Remarque : C’est une propriété optimisée.<xpath>
<target>
Valeurs possibles :
- head: sous le noeud head
- text: sous le noeud de paragraphe
<wrapelement>
<wrapclass>
wrapclass.
<attributemap>
<attribute>
noeuds.Remarques supplémentaires
-
Si vous prévoyez de remplacer le mappage d’élément par défaut, il est recommandé de ne pas apporter de modifications au mappage par défaut.
elementmapping.xml
fichier . Vous devez créer un fichier XML de mappage et le placer à un autre emplacement, de préférence dans le dossier d’applications personnalisées que vous créez. -
Dans le
elementmapping.xml
, il existe de nombreuses entrées de mappage faisant référence au composant fmdita/components/dita/wrapper . Wrapper est un composant générique qui effectue le rendu de constructions DITA relativement simples à l’aide de propriétés sur leur noeud de site pour générer un HTML pertinent. Elle utilise la variablewrapelement
pour générer des balises englobantes et déléguer le rendu enfant aux composants correspondants. Cela s’avère utile lorsque vous souhaitez uniquement un composant de conteneur. Au lieu de créer un composant qui effectue le rendu d’une balise conteneur spécifique commediv
oup
, vous pouvez utiliser le composant Wrapper avec l’événementwrapelement
etwrapclass
pour obtenir le même effet. -
Il n’est pas recommandé d’enregistrer de grandes quantités de texte dans les propriétés JCR de chaîne. Le calcul du type de propriété optimisé dans la génération de sortie garantit que le contenu texte volumineux n’est pas enregistré comme type de chaîne. Au lieu de cela, lorsque le contenu supérieur à un certain seuil doit être enregistré, le type de la propriété est remplacé par binaire. Par défaut, ce seuil est configuré à 512 octets, mais peut être modifié dans Configuration Manager (com.adobe.config.ConfigManager) en modifiant la variable Enregistrer comme seuil binaire .
-
Si vous envisagez de remplacer certains (et pas tous) des mappages d’éléments, il n’est pas nécessaire de répliquer l’intégralité de la variable
elementmapping.xml
fichier . Vous devez créer un nouveau fichier de mappage XML et définir uniquement les éléments que vous remplacez. -
Une fois le fichier XML créé à l’emplacement personnalisé, mettez à jour la variable
Override Element Mapping
dans lecom.adobe.fmdita.config.ConfigManager
du lot.
Personnalisation de la console de mappage DITA id188HC08M0CZ
AEM Guides vous offre la possibilité d’étendre les fonctionnalités de la console de mappage DITA. Si, par exemple, vous disposez d’un ensemble de rapports différent de ceux disponibles dans les AEM Guides, vous pouvez ajouter ces rapports à la console de mappage. Pour personnaliser la console de mappage, vous devez créer une AEM bibliothèque cliente (ou ClientLib) qui contiendra le code pour exécuter les fonctionnalités dont vous avez besoin.
AEM Guides fournit la variable apps.fmdita.dashboard-extn
catégorie pour personnaliser la console de mappage. Chaque fois que la console de mappage est chargée, la fonctionnalité créée sous apps.fmdita.dashboard-extn
est exécutée et chargée.
Gérer le rendu d’image lors de la génération de la sortie id177BF0G0VY4
AEM est fourni avec un ensemble de workflows et de gestionnaires de médias par défaut pour traiter les ressources. Dans AEM, il existe des workflows prédéfinis pour gérer le traitement des ressources pour les types MIME les plus courants. En règle générale, pour chaque image que vous téléchargez, AEM crée plusieurs rendus du même format binaire. Ces rendus peuvent être de taille différente, avec une résolution différente, avec un filigrane ajouté ou d’autres caractéristiques modifiées. Pour plus d’informations sur la manière dont AEM gère les ressources, voir Traitement des ressources à l’aide des workflows et des gestionnaires de médias dans la documentation AEM.
AEM Guides vous permet de configurer le rendu d’image à utiliser lors de la génération de la sortie pour vos documents. Par exemple, vous pouvez choisir parmi l’un des rendus d’image par défaut ou en créer un et l’utiliser pour publier vos documents. Le mappage de rendu d’image pour la publication de vos documents est stocké dans la variable /libs/fmdita/config/ **renditionmap.xml**
fichier . Un extrait de code de renditionmap.xml
se présente comme suit :
renditionmap.xml
dans le fichier apps
pour toutes les personnalisations.<renditionmap>
<mapelement>
<mimetype>image/png</mimetype>
<rendition output="AEMSITE">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="PDF">original</rendition>
<rendition output="HTML5">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="EPUB">cq5dam.web.1280.1280.jpeg</rendition>
<rendition output="CUSTOM">cq5dam.web.1280.1280.jpeg</rendition>
</mapelement>
...
</renditionmap>
La variable mimetype
spécifie le type MIME du format de fichier. La variable rendition output
element spécifie le type de format de sortie et le nom du rendu (par exemple, cq5dam.web.1280.1280.jpeg
) qui doit être utilisé pour publier la sortie spécifiée. Vous pouvez spécifier les rendus d’image à utiliser pour tous les formats de sortie pris en charge : AEMSITE, PDF, HTML5, EPUB et PERSONNALISÉ.
Si le rendu spécifié n’est pas présent, AEM processus de publication Guides commence par rechercher le rendu web de l’image donnée. Si même le rendu web est introuvable, le rendu d’origine de l’image est utilisé.
Configuration de la période de purge automatique pour l’historique de sortie id19AAI070V8Q
Lorsque vous générez une sortie, la sortie est créée avec les logs de sortie. Pour les mappages DITA volumineux, ces journaux peuvent prendre beaucoup d’espace dans votre référentiel. Par défaut, les journaux sont stockés à l’emplacement suivant dans le référentiel :
/var/dxml/metadata/outputHistory
Sur une certaine période, la taille collective de tous les fichiers journaux peut atteindre 1 Go. AEM Guides vous permet de configurer une période pour conserver ces fichiers journaux dans le référentiel. Après la période spécifiée, les journaux ainsi que l’historique de génération de sortie sont supprimés du référentiel.
La configuration de la fonction de purge de l’historique a un impact sur la génération de sortie pour tous les mappages DITA dans le référentiel. Dans l’onglet Sorties d’un mappage DITA, l’historique est purgé après le nombre de jours spécifié et à l’heure spécifiée dans le paramètre .
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (propriété) suivants pour définir un jour et une heure pour purger l’historique de sortie et les journaux :
com.adobe.fmdita.config.ConfigManager
output.history.purgeperiod
Valeur par défaut: 5
output.history.purgetime
Valeur par défaut: 0:00 (ou 12:00 minuit)
Modification de la limite de la liste des sorties récemment générées id1679JH0H0O2
Vous pouvez modifier le nombre maximal de sorties générées qui s’affichent dans l’onglet Sorties pour un mappage DITA.
Suivez les instructions de la section Remplacements de configuration pour créer le fichier de configuration. Dans le fichier de configuration, fournissez les détails (propriété) suivants pour modifier le nombre de sorties à afficher dans la liste :
com.adobe.fmdita.config.ConfigManager
output.historylimit
Valeur par défaut: 25