Configurer les paramètres de génération de sortie id181AI0B0E30

AEM Guides s’accompagne 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 aideraient à configurer votre processus de génération de sortie.

Configurer l'onglet Ligne de base dans le tableau de bord du plan DITA id223MD0D0YRM

Pour masquer l'onglet Ligne de base dans le tableau de bord du plan DITA, procédez comme suit :

Configuration de la publication mixte dans un site AEM existant id1691I0V0MGR

Si vous disposez d'un site AEM contenant du contenu DITA, vous pouvez configurer la sortie de votre site AEM pour publier du contenu DITA vers un emplacement prédéfini de votre site. Par exemple, dans la capture d'écran ci-dessous d'une page de site AEM, le nœud ditacontent est réservé au stockage du contenu DITA :

Les nœuds restants dans 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 à un emplacement prédéfini garantit qu'aucun de vos contenus non DITA existants ne sera modifié par le processus de publication AEM Guides.

Vous devez effectuer les configurations suivantes sur votre site existant pour autoriser la publication de contenu DITA sur un nœud prédéfini :

Pour configurer les propriétés de modèle de votre site existant, procédez comme suit :

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 nœuds spécifiés dans les propriétés topicContentNode et topicHeadNode.

Personnaliser la sortie du site AEM id166TG0B30WR

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

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.

Effectuez les étapes suivantes pour spécifier votre propre modèle de conception à utiliser pour la génération de sortie du site AEM :

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

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 :

Configurez l’URL de sortie du site AEM pour utiliser le titre du document

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 ces caractères 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 :

Par exemple, si le caractère @navtitle 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 (-).

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 :

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 :

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 :

Pour aplatir la structure du nœud du site AEM, procédez comme suit :

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.

Rechercher une chaîne dans le contenu dans la sortie du site AEM

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.

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.

Effectuez les étapes suivantes pour arrêter la création d’une version pour la ou les pages en cours de suppression :

Configuration d’une réécriture personnalisée avec Experience Manager Guides 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.

Utilisation des métadonnées dans la publication d’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 apparaît désormais dans la page Propriétés de tous les mappages DITA.

Vous devez ensuite rendre les métadonnées personnalisées disponibles dans la console de plan DITA. Effectuez les étapes suivantes pour rendre les métadonnées personnalisées disponibles sur le tableau de bord du plan DITA :

Désormais, les métadonnées personnalisées s'affichent dans la liste déroulante Propriétés de la console Plan 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 sont mises à disposition dans la sortie finale.

Validation des métadonnées transmises au 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 fichier jar prêt pour le cloud. Comme nous ne pouvons pas accéder au système de fichiers local sur le cloud, la seule façon de valider le fichier de métadonnées est via le fichier jar prêt pour le cloud.

Configurez le champ d'argument de ligne de commande DITA-OT pour accepter les métadonnées de carte racine

Pour utiliser le champ d'argument de ligne de commande DITA-OT afin de transmettre des métadonnées de carte racine, procédez comme suit :

Personnaliser le mappage d'éléments DITA avec des composants AEM id1679J600HEL

Les éléments DITA dans AEM Guides sont mappés à leurs composants AEM correspondants. AEM Guides utilise ce mappage dans des workflows tels que la publication et la révision pour convertir un é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 mapper des éléments DITA à vos composants AEM personnalisés. Pour utiliser vos composants AEM personnalisés, vous devez connaître la structure du fichier elementmapping.xml.

structure elementmapping.xml

Vous trouverez ci-dessous un aperçu général de la structure elementmapping.xml :

Schéma de l'é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 :

Remarques complémentaires

Personnaliser la console de plan DITA id188HC08M0CZ

AEM Guides vous offre la possibilité d'étendre les fonctionnalités de la console de plan DITA. Par exemple, si vous disposez d’un ensemble de rapports différent de celui disponible dans AEM Guides, vous pouvez ajouter ces rapports à la console Carte. Pour personnaliser la console de mappage, vous devez créer une bibliothèque cliente AEM (ou ClientLib) qui contiendra le code permettant d’exécuter les fonctionnalités dont vous avez besoin.

AEM Guides fournit la catégorie apps.fmdita.dashboard-extn pour la personnalisation de Map Console. 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 des images pendant la génération de la sortie id177BF0G0VY4

AEM s’accompagne d’un ensemble de workflows et de descripteurs de médias par défaut destinés au traitement des 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 chargée, AEM crée plusieurs rendus de la même image au format binaire. Ces rendus peuvent être de tailles différentes, avec une résolution différente, avec un filigrane ajouté ou une autre caractéristique modifiée. Pour plus d’informations sur la façon dont AEM gère les ressources, voir Traitement d’Assets à l’aide de gestionnaires de médias et de workflows dans la documentation d’AEM.

AEM Guides vous permet de configurer le rendu d’image à utiliser au moment de la génération de la sortie de vos documents. Par exemple, vous pouvez choisir 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**. Un extrait de fichier renditionmap.xml est le suivant :

<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 CUSTOM).

Si le rendu spécifié n’est pas présent, le processus de publication AEM Guides recherche d’abord le rendu web de l’image donnée. Si le rendu web est introuvable, le rendu original de l’image est utilisé.

Configurer la période de purge automatique pour l’historique de sortie id19AAI070V8Q

Lorsque vous générez une sortie, celle-ci est créée avec les journaux de sortie. Pour les plans DITA volumineux, ces journaux peuvent occuper une grande quantité 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 période de temps, la taille collective de tous les fichiers journaux pouvait atteindre Go. AEM Guides vous permet de configurer une période pour conserver ces fichiers journaux dans le référentiel. Au bout de 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 plans DITA du référentiel. Dans l'onglet Sorties d'un plan 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 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 définir le jour et l’heure de la purge de l’historique et des journaux de sortie :

Modifier la limite de la liste de sorties récemment générée id1679JH0H0O2

Vous pouvez modifier le nombre maximal de sorties générées affichées dans l'onglet Sorties d'un plan DITA.

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 modifier le nombre de sorties à afficher dans la liste :