Configuration des paramètres de génération de sortie id181AI0B0E30

AEM Guides propose de nombreuses options de configuration pour 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 :

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, le noeud 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 :

Effectuez les étapes suivantes pour configurer les propriétés de modèle de votre site existant :

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 les propriétés topicContentNode et topicHeadNode.

Personnalisation de la sortie AEM site id166TG0B30WR

AEM Guides prend en charge la création de sorties dans les formats suivants :

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 Open Toolkit DITA personnalisés (DITA-OT) avec 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 AEM sortie Site. Vous pouvez personnaliser les modèles de conception AEM Guides 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 le sous-système de publication AEM Guides lors de la génération de la sortie AEM Site et ils contrôlent la structure, 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, tous les fichiers JavaScript et CSS du modèle par défaut sont stockés dans le dossier /etc/designs/fmdita/clientlibs/siteoutput/default. 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 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 :

Pour plus d’informations, voir 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 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 de sortie d’AEM 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 :

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 :

Par exemple, si le @navtitle dans <topichead> comporte 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, le nom de la première rubrique enfant s’affiche.

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 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, 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 seront toujours remplacés 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 :

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 :

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 élément p et ses sous-éléments suivants, et qu’une structure similaire est créée pour chaque autre élément utilisé dans la rubrique.

AEM Guides vous permet de configurer la création en interne de la structure de noeud de AEM sortie de site. 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 l’élément p, tout élément apparaissant dans l’élément p sera fusionné avec l’élément principal p. Une note distincte ne serait créée pour aucun sous-élément dans l’élément p. L’instantané suivant affiche la structure de noeud aplatie à l’élément p :

Pour aplatir AEM structure de noeuds de site, procédez comme suit :

Désormais, lorsque vous générez la sortie Site AEM, les noeuds 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.

Recherchez 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 la balise <p> est <= 1Mo.

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 à l’élément body, mais que vous ne souhaitez pas qu’un élément table dans body s’aplatisse, 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>

Configuration du contrôle de version pour les pages supprimées dans AEM sortie Site

Lorsque vous générez AEM sortie Site avec l’option Supprimer et Créer ​ ​sélectionnée 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.

Effectuez les étapes suivantes pour arrêter la création d’une version de la page(s) supprimée :

Configuration d’un module de réécriture personnalisé avec Experience Manager Guides custom-rewriter

Experience Manager Guides dispose d’un module de rewriter personnalisé pour gérer les liens générés en cas de mappage croisé (liens entre les rubriques de deux cartes différentes). Cette configuration 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 valeur 'order' supérieure à 50, car Experience Manager Guides sling rewriter utilise '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 :

Pour ajouter les métadonnées requises dans le système, procédez comme suit :

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 :

Désormais, les métadonnées personnalisées s’affichent dans la liste déroulante Propriétés de la console de mappage DITA.

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 :

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.

Personnalisation du mappage des éléments DITA avec les composants AEM id1679J600HEL

Les éléments DITA dans AEM Guides sont mappés à leurs composants AEM correspondants. AEM Guides utilise ce mappage dans les workflows tels que la publication et la révision pour convertir l’élément DITA en composant AEM correspondant. Le mappage est défini dans le fichier elementmapping.xml, accessible à l’aide du gestionnaire de packages.

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 du fichier elementmapping.xml.

structure elementmapping.xml

Un aperçu général de la structure elementmapping.xml est expliqué ci-dessous :

Schéma d’élément DITA

Voici un exemple du schéma d’élément DITA dans le fichier elementmapping.xml :

<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 :

Remarques supplémentaires

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 celui disponible dans 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 catégorie apps.fmdita.dashboard-extn pour personnaliser la console de mappage. Chaque fois que la console de mappage est chargée, la fonctionnalité créée sous la catégorie 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 d’Assets à l’aide de gestionnaires et de workflows de médias dans AEM documentation.

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 le fichier /libs/fmdita/config/ **renditionmap.xml**. Voici un extrait de fichier renditionmap.xml :

<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>

L’élément mimetype spécifie le type MIME du format de fichier. L’élément rendition output 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, le processus de publication AEM 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 :

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 :