utilisation de xml documentation add-on for adobe ... · pdf filepublication avancée de...

62
août 16, 2016 Utilisation de XML Documentation Add-on for Adobe Experience Manager

Upload: lamhanh

Post on 18-Feb-2018

217 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

août 16, 2016

Utilisation de XMLDocumentation Add-on for

Adobe Experience Manager

Page 2: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

i UTILISATION DE XML DOCUMENTATION ADD-ON FOR ADOBE EXPERIENCE MANAGER

Table des matières

A propos de XML Documentation Add-on for Adobe Experience Manager . . . . . . . . . . . 1Avantages d’un seul coup d’œil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Comment fonctionne le module complémentaire XML . . . . . . . . . . . . . . . . . . . . . . 2Fonctionnalités clés du module complémentaire XML . . . . . . . . . . . . . . . . . . . . . . . 2

Téléchargement et installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Exigences techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Téléchargement et installation du module complémentaire XML . . . . . . . . . . . . . . . . . 6

Configuration et personnalisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Configuration des paramètres du module complémentaire XML . . . . . . . . . . . . . . . . . 8Configuration de FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . 9Utilisation de modules externes DITA-OT personnalisés . . . . . . . . . . . . . . . . . . . . . 10Intégration de la spécialisation DITA personnalisée . . . . . . . . . . . . . . . . . . . . . . . . 12Personnaliser les modèles de courrier électronique . . . . . . . . . . . . . . . . . . . . . . . . . 13Mappage des éléments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Structure du fichier elementmapping.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Schéma d’élément DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Modification de la limite de la liste des sorties récemment générées . . . . . . . . . . . . . . . 19

Gestion de contenu DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Concepts fondamentaux de gestion de contenu . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Création d’un projet DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Création d’un contenu DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Utilisation d’un éditeur de rubrique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Vues de l’éditeur de rubrique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Utilisation de l’éditeur de mappage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Utiliser FrameMaker en tant que client hors ligne . . . . . . . . . . . . . . . . . . . . . . . . 29

Page 3: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

UTILISATION DE XML DOCUMENTATION ADD-ON FOR ADOBE EXPERIENCE MANAGER ii

Télécharger des fichiers existants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Utilisez FrameMaker pour le téléchargement en vrac . . . . . . . . . . . . . . . . . . . . . . 30Utiliser WebDAV pour le téléchargement en vrac . . . . . . . . . . . . . . . . . . . . . . . . 30

Révision et approbation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Envoi de rubriques en révision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Création d’une tâche de révision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Envoi d’un mappage DITA en révision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Révision de rubriques ou d’un mappage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Traitement des commentaires de révision dans FrameMaker . . . . . . . . . . . . . . . . . . . 34Envoi des rubriques pour approbation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Création d’une tâche d’approbation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Approbation ou rejet des rubriques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Gestion des révisions et des approbations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Traduction d’un contenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Traduction d’un contenu pour la première fois . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Création d’une copie de langue source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Démarrage de la tâche de traduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Affichage du statut de la traduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Traduction des rubriques modifiées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Génération d’une sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Génération d’une sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Comprendre les paramètres prédéfinis de sortie . . . . . . . . . . . . . . . . . . . . . . . . . 47Génération d’une sortie de mappage DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Génération d’une sortie incrémentielle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Affichage du statut de la tâche de génération de sortie . . . . . . . . . . . . . . . . . . . . . . 51Dépannage de base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Personnalisation de la sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Personnalisation du modèle de conception du module complémentaire XML pour générer une sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Utilisation des modules externes DITA-OT personnalisés . . . . . . . . . . . . . . . . . . . 56

Rapport de mappage DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Affichage du rapport de mappage DITA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Page 4: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

A propos de XML Documentation Add-on for Adobe Experience Manager 1

1

A propos de XML Documentation Add-on for Adobe Experience Manager

XML Documentation Add-on for Adobe Experience Manager (désigné par Module complémentaire XML plus avant dans ce guide) est une solution d’entreprise de bout en bout qui permet à Adobe Experience Manager (AEM) de proposer une solution de gestion de contenu de composants (CCMS) pour la création et la publication de contenu basées sur la norme DITA. Il permet aux auteurs de créer du contenu à l’aide de tout outil de création hors ligne DITA, tel que Adobe FrameMaker (2015 release) ou un éditeur Web incorporé facile à utiliser.

Le module complémentaire XML fournit toutes les fonctionnalités CCMS de base, telles que la collaboration, la révision, l’approbation, la traduction, la recherche et la génération de rapports du contenu DITA, et permet aux auteurs de faire plus et plus vite par la réutilisation du contenu efficace et des processus performants. De plus, les utilisateurs peuvent tirer parti de sa fonctionnalité de publication d’un simple clic pour générer une sortie basée sur la norme DITA pour les deux formats les plus courants - Sites AEM et PDF.

Avec le module complémentaire XML, les entreprises peuvent fournir des expériences personnalisées et homogènes aux utilisateurs finaux et garantir la cohérence et l’uniformité du contenu de prévente et d’après-vente. Un contrôle total de l’intégrité du contenu peut être obtenu facilement. De plus, le temps et les coûts de localisation sont également réduits de manière significative.

Avantages d’un seul coup d’œil

• Une expérience de contenu homogène avant et après achat, destinée aux utilisateurs finaux

• Une expérience de publication en un clic aux formats Sites AEM et PDF

• Connaissances des outils et des systèmes Adobe existants et opportunité de les consolideravec un seul partenaire

• Un seul CMS pour le marketing de gestion et le contenu technique, de bout en bout.

• Une mise sur le marché plus rapide grâce à la réutilisation des contenus efficace

• Processus de révision, de collaboration et de traduction performants

• Réduction du temps et des coûts de localisation

• Marges de maintenance réduites

Page 5: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

A propos de XML Documentation Add-on for Adobe Experience Manager

2

Comment fonctionne le module complémentaire XML

Le diagramme suivant illustre comment fonctionne le module complémentaire XML avec AEM et n’importe quel éditeur DITA pour activer la gestion du contenu, la réutilisation, la traduction, la révision et l’approbation dans le cadre d’une entreprise.

Fonctionnalités clés du module complémentaire XML

Création et gestion de contenu DITA performantesAméliorez considérablement la productivité de la création à partir d’une source unique d’informations modulaires optimisées pour une réutilisation efficace au niveau le plus fin (modules, composants, mots, graphismes, multimédia et traductions).

L’éditeur incorporé basé sur le Web ou tout autre éditeur DITA hors ligne, tel que FrameMaker (2015 release), vous permet de créer et de gérer efficacement des rubriques, des mappages DITA, et des fichiers DITAVAL. L’éditeur incorporé possède une interface de traitement de texte simple et intuitive, qui fournit des entrées pour les SME, les contributeurs occasionnels et les réviseurs qui ne sont pas formés à l’utilisation de la norme DITA.

Page 6: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

A propos de XML Documentation Add-on for Adobe Experience Manager 1

3

Collaboration de nouvelle génération par la révision et l’approbation basées sur le WebAssurez-vous que les équipes réparties sur plusieurs auteurs et réviseurs collaborent harmonieusement grâce aux processus performants de révision et d’approbation, ce qui réduit la portée des erreurs manuelles dans le processus.

Le module complémentaire XML fournit des fonctionnalités de révision et d’approbation basées sur le Web, puissantes mais conviviales. Vous pouvez envoyer plusieurs rubriques DITA pour révision simultanément. La fonctionnalité de révision de mappage garantit que la structure de la documentation et le flux de rubriques peuvent être révisés efficacement. Les auteurs et les réviseurs peuvent facilement collaborer sur des modifications durant les révisions en cours. Les réviseurs peuvent contrôler les différences avec les versions antérieures afin d’identifier si les commentaires ont été incorporés correctement. Les administrateurs peuvent consulter l’historique des tâches de révision et d’approbation à l’aide du tableau de bord de gestion, riche en fonctionnalités.

Prise en charge de pointe de la localisation et de la gestion de la traductionProfitez d’importantes réductions du temps et des coûts de traduction et assurez-vous que le contenu publié est exempt d’erreurs de traduction.

Adobe Experience Manager est livré avec des connecteurs incorporés pour les principaux fournisseurs de traduction. Tirez parti de ces connecteurs pour gérer le contenu spécifique d’une région. Utilisez pleinement des rapports détaillés de traduction prêts à l’emploi pour identifier le contenu non traduit avant de le publier et appliquer les mesures correctives appropriées. Vous pouvez gérer le statut du contenu traduit par rapport aux mises à jour de la langue principale pour traduire uniquement les fichiers DITA mis à jour. L’identification longue et manuelle des fichiers à envoyer à la traduction n’est pas requise.

Publication multicanal de pointe du contenu DITASimplifiez la publication du contenu d’entreprise par une approche d’un seul geste, homogène, qui accélère les délais de mise sur le marché.

Avec la prise en charge de DITA native ajoutée à Experience Manager, générez une sortie aux formats Sites AEM et PDF. Vous pouvez tirer parti d’une sortie entièrement configurable pour offrir aux utilisateurs finaux des expériences hautement personnalisées, pertinentes et immersives du contenu. Vous pouvez également générer des lots de manière simple.

Recherche exhaustive et données d’utilisation de contenuRecherchez et sélectionnez le contenu pertinent plus rapidement, optimisant ainsi le retour sur investissement du contenu à chaque réutilisation. Effectuez des recherches simples et avancées à l’aide des attributs de contenu et des métadonnées de rubriques dans l’ensemble du référentiel via une interface simple au sein de l’outil de création DITA. Les résultats disposent de balises indiquant les données d’utilisation de contenu afin que vous puissiez identifier et sélectionner facilement le contenu adapté en vue d’une réutilisation optimale.

Page 7: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

A propos de XML Documentation Add-on for Adobe Experience Manager

4

Publication avancée de rapports d’inspectionDes publications sans erreurs grâce à la simplicité de vérification et de correction du contenu avant sa publication.Gardez un œil sur la santé du système en accédant facilement à divers rapports disponibles au niveau du mappage DITA. Vous pouvez contrôler la liste des références et des liens rompus, ainsi que le statut des révisions, des approbations et des traductions pour toutes les rubriques. Vous pouvez également utiliser les rapports pour effectuer des contrôles d’intégrité complets dans la phase finale avant la publication.

Prise en charge étendue de la gestion des balises pour une sortie personnaliséeSuscitez un engagement plus important et l’adoption du contenu par l’utilisateur final à travers des expériences de contenu hautement pertinentes.Avec le module complémentaire XML, profitez de la prise en charge étendue de la gestion des balises dans Experience Manager pour appliquer les balises pertinentes au contenu DITA source. Utilisez ces balises afin de fournir des expériences hautement personnalisées du contenu aux utilisateurs finaux.

Intégration native avec Adobe FrameMaker (2015 release)Profitez d’une expérience rapide et fluide lors de l’utilisation de la mise à jour 4 d’Experience Manager et de FrameMaker (2015 release).

L’intégration étroite d’Experience Manager et de FrameMaker (2015 release) via un connecteur incorporé vous aide à travailler sans problème avec le référentiel de contenu d’Experience Manager. Tirez parti du connecteur pour une prise en main rapide de la création, la révision et la recherche de contenu DITA.

Page 8: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Téléchargement et installation 2

5

Téléchargement et installation

Le module complémentaire XML est disponible via le système Adobe Licensing Warehouse System (LWS). Vous pouvez télécharger le module complémentaire XML depuis votre compte LWS et l’installer sur toutes les instances d’Adobe Experience Manager (AEM) dans votre configuration. En règle générale, les instances de création et de production d’AEM seront hébergées sur des serveurs différents. Vous devez installer le module complémentaire XML sur toutes les instances d’AEM que vous avez l’intention d’utiliser.

Avant de commencer le processus de téléchargement et d’installation, vous devez vous assurer que votre système répond aux exigences techniques requises pour installer le module complémentaire XML.

Exigences techniques

Assurez-vous que votre système répond aux exigences suivantes avant d’installer le module complémentaire XML :

Adobe Experience ManagerVersion 6.1

Systèmes d’exploitation

• Microsoft Windows Server 2012 R2

• Red Hat Linux 7 et 6

• Ubuntu

Kit de développement Java

• Oracle SE 8 JRE 1.8.x

• Oracle SE 7 JRE 1.7.x

Navigateur Web

• Google Chrome

• Firefox

• Safari 9

• Microsoft Edge

Page 9: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Téléchargement et installation

6

Téléchargement et installation du module complémentaire XML

Procédez comme suit pour télécharger et installer le module complémentaire XML :

REMARQUE : Vous devez effectuer cette procédure sur toutes les instances de serveur AEM dans votre configuration.

1) Téléchargez le module complémentaire XML depuis votre compte LWS.

2) Connectez-vous à votre instance AEM et accédez au gestionnaire de packages CRX Package Manager. L’URL par défaut pour accéder au gestionnaire de packages est :

http://<nom serveur>:<port>/crx/packmgr/index.jspPackage Manager traite les packages sur votre installation CQ locale. Pour plus d’informations sur l’utilisation de Package Manager, consultez Comment utiliser les packages dans la documentation AEM.

3) Pour télécharger le module complémentaire XML, cliquez sur Télécharger le package.

4) Dans la boîte de dialogue Télécharger le package, accédez au fichier du module complémentaire XML que vous avez téléchargé à l’étape 1 et cliquez sur OK.

Le package est téléchargé sur votre instance AEM.

Page 10: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Téléchargement et installation 2

7

5) Pour installer le package, cliquez sur Installer.

6) Dans la boîte de dialogue Installer le package, cliquez sur Installer.

7) Pour démarrer avec le module complémentaire XML, cliquez sur le bouton Accueil, dans le coin supérieur gauche de CRX Package Manager.

Après l’installation du module complémentaire XML, vous pouvez apporter des modifications à sa configuration pour répondre aux besoins de votre entreprise. Pour plus d’informations sur la configuration et la personnalisation du module complémentaire XML, consultez Configuration et personnalisation.

Page 11: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

8

Configuration et personnalisation

Après avoir téléchargé et installé le module complémentaire XML sur votre instance AEM, vous pouvez configurer et personnaliser les éléments suivants :

• FrameMaker Publishing Server pour générer la sortie à l’aide de FMPS

• DITA-OT pour utiliser des modules externes DITA-OT personnalisés

• Spécialisation DITA pour utiliser votre propre création d’annotation tout en conservant les règles et les processus de DITA

• Modèles de courrier électronique pour personnaliser les messages électroniques de notification envoyés à vos utilisateurs

• Mappage d’éléments pour définir des mappages entre des éléments DITA et des composants AEM

• Modifier le nombre de résultats à afficher dans la liste de sorties récemment produite

À l’instar de tout autre pack sur AEM, les configurations de module complémentaire XML sont également accessibles et mises à jour depuis le gestionnaire de configuration d’AEM. La section suivante vous guide tout au long du processus d’accès aux propriétés configurables du module complémentaire XML dans AEM.

Configuration des paramètres du module complémentaire XML

Les réglages de configuration et la personnalisation du module complémentaire XML sont gérés via le regroupement com.adobe.fmdita.config.ConfigManager. Vous pouvez accéder aux propriétés configurables du module complémentaire XML par la page de configuration de la console Web AEM.

Effectuez les étapes suivantes pour accéder aux propriétés configurables du module complémentaire XML :

1) Connectez-vous à votre instance AEM et ouvrez la page de configuration de la console Web d’Adobe Experience Manager.

L’URL par défaut pour accéder à la page de configuration est :

http://<nom du serveur>:<port>/system/console/configMgr

Page 12: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

9

2) Recherchez et cliquez sur le groupement com.adobe.fmdita.config.ConfigManager.

3) Mettez à jour les propriétés requises comme décrit dans les sections suivantes de ce document.

4) Cliquez sur Enregistrer.

Configuration de FrameMaker Publishing Server

Vous pouvez utiliser FrameMaker Publishing Server (FMPS) pour générer une sortie pour votre contenu DITA. La configuration de FMPS vous permet de générer une sortie dans plusieurs formats pris en charge par FMPS.

REMARQUE : Pour générer une sortie avec FMPS, vous devez disposer de la configuration du serveur de FMPS. Pour plus de détails sur l’installation et la configuration, consultez le guide de l’utilisateur de FrameMaker Publishing Server.

Pour configurer votre module complémentaire XML pour utiliser FMPS, mettez à jour les propriétés suivantes du regroupement com.adobe.fmdita.config.ConfigManager dans la console Web.

REMARQUE : Pour accéder à la console Web, consultez Configuration des paramètres du module complémentaire XML.

Propriété Description

Domaine de connexion de FrameMaker Publishing Server

Spécifiez le nom du domaine ou du groupe de travail sur lequel FrameMaker Publishing Server est hébergé.

URL du serveur FrameMaker Publishing Server

Spécifiez L’URL du serveur de FrameMaker Publishing Server. Par exemple : http://<fmps_ip>:<port>/fmserver/v1/.

Nom d’utilisateur et mot de passe de FrameMaker Publishing Server

Indiquez le nom d’utilisateur et le mot de passe pour accéder à FrameMaker Publishing Server.

URL d’AEM externe URL d’AEM où FrameMaker Publishing Server placera les fichiers de sortie générés. Par exemple : http://<server-name>:4502.

Nom d’utilisateur et votre mot de passe administrateur d’AEM

Nom d’utilisateur et mot de passe de l’administrateur de votre configuration d’AEM. Ils seront utilisés par FrameMaker Publishing Server pour communiquer avec AEM.

Page 13: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

10

Utilisation de modules externes DITA-OT personnalisés

Le jeu d’outils Open Toolkit DITA (DITA OT) est un ensemble d’outils open source basés sur Java, permettant de traiter des contenus de mappages et de rubriques DITA. Le module complémentaire XML vous permet d’importer et d’exploiter facilement des modules externes DITA-OT personnalisés. Une fois importé, le module complémentaire XML utilise le module externe DITA-OT personnalisé pour générer une sortie au format PDF. Au moment de la génération de la sortie au format PDF, il vous suffit de choisir l’option DITA-OT, et le module complémentaire XML utilise le module externe DITA-OT pour générer une sortie au format PDF.

Effectuez les étapes suivantes pour importer et utiliser le module externe DITA-OT :

1) Connectez-vous à AEM et ouvrez le mode CRXDE.

2) Téléchargez le fichier DITA-OT.ZIP.

L’emplacement du fichier DITA-OT.ZIP est /etc/fmdita/dita_resources/DITA-OT.zip.

3) Extrayez le contenu du fichier zip sur votre système local.

4) Utilisez le mécanisme de l’intégrateur du module externe DITA-OT pour intégrer votre module externe DITA-OT personnalisé.

5) Créez de nouveau le fichier ZIP en conservant le même nom (DITA-OT.ZIP) et la structure du dossier.

Page 14: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

11

6) Téléchargez le fichier ZIP mis à jour de nouveau dans le référentiel AEM.

REMARQUE : Il est recommandé de ne pas écraser le module externe DITA-OT par défaut. Vous devez télécharger votre module externe DITA-OT personnalisé à un autre emplacement sous le dossier « applications ».

7) Ouvrez la page de configuration de la console Web d’Adobe Experience Manager.

REMARQUE : Pour accéder à la console Web, consultez Configuration des paramètres du module complémentaire XML.

8) Configurez les propriétés suivantes du regroupement com.adobe.fmdita.config.ConfigManager pour utiliser le module externe DITA-OT :

REMARQUE : Le programme d’installation du module complémentaire XML crée deux variables d’environnement que vous pouvez utiliser pour indiquer le chemin d’accès des fichiers du module externe DITA-OT personnalisés. Ces variables d’environnement sont : DITAOT_DIR, qui contient le chemin d’accès du répertoire DITA-OT sur le système de fichiers, et DITAMAP_DIR contenant le chemin d’accès à l’emplacement où le contenu du mappage DITA est extrait sur le système de fichiers.

Nom de la propriété Description

Délai de DITA-OT (Facultatif) Spécifiez la durée (en secondes) pendant laquelle le module complémentaire XML attend une réponse du module externe DITA-OT. Si aucune réponse n’est reçue dans le délai imparti, le module complémentaire XML interrompt la tâche de publication et la tâche est marquée comme échec. En outre, les journaux d’échec sont disponibles dans le fichier journal de la génération des sorties. Pour plus d’informations sur le fichier journal de génération des sorties, reportez-vous à la section Accès et analyse du fichier journal de génération de sortie.Valeur par défaut : 5 minutes

Arguments du PDF DITA-OT

(Facultatif) Spécifiez les arguments personnalisés de ligne de commande qui sont traités par le module externe DITA-OT pour générer la sortie PDF.

Arguments du site AEM DITA-OT

(Facultatif) Spécifiez les arguments personnalisés de ligne de commande qui sont traités par le module externe DITA-OT pour générer la sortie du site AEM.

XML version DITA-OT (Facultatif) Spécifiez le chemin d’accès du script de version et de personnalisation regroupé avec le module externe DITA-OT personnalisé. Ce chemin est relatif au répertoire DITA-OT dans votre système de fichiers.

Chemin d’accès DITA-OT

Spécifiez le chemin d’accès complet où le fichier DITA-OT.zip est stocké dans le référentiel AEM.

Page 15: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

12

Intégration de la spécialisation DITA personnalisée

La spécialisation DITA est le processus de création de nouveaux concepts à partir de concepts existants. Une spécialisation peut réutiliser des éléments de conceptions de niveau supérieur. La spécialisation DITA vous permet de créer des modèles d’informations personnalisés répondant aux besoins de votre société tout en conservant les avantages de l’architecture DITA existante.

Pour plus de détails au sujet de la personnalisation DITA à l’aide de FrameMaker, consultez Spécialisation DITA dans Adobe FrameMaker.

Effectuez les étapes suivantes pour utiliser les fichiers DTD et XSD spécialisés dans votre module complémentaire XML :

1) Créez un dossier de spécialisation sur votre ordinateur local, qui contient les fichiers DTD et XSD spécialisés.

2) Spécifiez les détails du fichier DTD dans le fichier catalog.xml qui doit être inclus dans le dossier de spécialisation.

REMARQUE : S’il s’agit de DITA 1.3, l’emplacement par défaut du fichier catalog.xml DTD dans le référentiel AEM est : /etc/fmdita/dita_resources/DITA-1.3/dtd/catalog.xml.

3) Spécifiez les détails du fichier XSD dans le fichier catalog.xml qui doit être inclus dans le dossier de spécialisation.

REMARQUE : S’il s’agit de DITA 1.3, l’emplacement par défaut du fichier catalog.xml XSD dans le référentiel AEM est : /etc/fmdita/dita_resources/DITA-1.3/xsd/catalog.xml.

4) Téléchargez le dossier à l’emplacement suivant :

/etc/fmdita/dita_resources5) Mettez à jour les propriétés suivantes du regroupement

com.adobe.fmdita.config.ConfigManager dans la console Web :

REMARQUE : Pour accéder à la console Web, consultez Configuration des paramètres du module complémentaire XML.

Propriété Description

Catalogue DTD personnalisé XML Spécifiez le chemin d’accès du fichier catalog.xml DTD dans le référentiel AEM.

Catalogue XSD personnalisé XML Spécifiez le chemin d’accès du fichier catalog.xml XSD dans le référentiel AEM.

Page 16: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

13

Personnaliser les modèles de courrier électronique

Un certain nombre de processus du module complémentaire XML utilisent des notifications par courrier électronique. Par exemple, si vous lancez une tâche de révision, une notification par courrier électronique est envoyée aux réviseurs. Toutefois, pour que la notification par courrier électronique soit envoyée, vous devez activer cette fonctionnalité dans AEM. Pour activer la notification par courrier électronique dans AEM, reportez-vous à l’article Configuration de la notification par courrier électronique dans la documentation AEM.

Le module complémentaire XML contient un ensemble de modèles de courrier électronique que vous pouvez personnaliser. Effectuez les étapes suivantes pour personnaliser ces modèles :

1) Connectez-vous à AEM et ouvrez le mode CRXDE.

2) Dans l’onglet Navigateur, accédez à l’emplacement suivant :

/apps/fmdita/mail3) Le dossier contient les modèles personnalisables suivants :

Mappage des éléments

Des éléments DITA dans le module complémentaire XML sont associés à leurs composants AEM correspondants. Le module complémentaire XML utilise cette correspondance dans des processus tels que la publication, la révision et l’approbation pour convertir un élément DITA en composant AEM correspondant. Le mappage est défini dans le fichier elementmapping.xml, accessible depuis la console CRXDE Lite. Accédez à L’URL suivante dans la console CRXDE Lite :

/apps/fmdita/config/elementmapping.xml

Vous pouvez utiliser des mappages d’éléments DITA prédéfinis, ou vous pouvez mapper des éléments DITA sur vos composants AEM personnalisés. Pour utiliser vos composants AEM personnalisés, vous devez comprendre la structure du fichier elementmapping.xml.

Nom de modèle Description

closeapproval.html Ce modèle de courrier électronique est utilisé lorsqu’une tâche d’approbation est fermée.

closereview.html Ce modèle de courrier électronique est utilisé lorsqu’une tâche de révision est fermée.

createapproval.html Ce modèle de courrier électronique est utilisé lorsqu’une tâche d’approbation est créée.

createreview.html Ce modèle de courrier électronique est utilisé lorsqu’une tâche de révision est créée.

reviewapproval.css Ce fichier CSS contient la mise en page des modèles de courrier électronique.

topicapproval.html Ce modèle de courrier électronique est utilisé lorsque le statut d’approbation/rejet d’une rubrique est mis à jour.

Page 17: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

14

Structure du fichier elementmapping.xml

Une présentation de grande qualité de la structure elementmapping.xml est décrite ci-dessous :

1) Chaque élément DITA est d’abord recherché pour trouver un mappage de composant correspondant en fonction du nom de l’élément. Par exemple :

<élément dita><nom>sous-étapes</nom><classe>- rubrique/ol tâche/sous-étapes</classe><chemin composant>dita/composants/liste ditao</chemin composant> <type>COMPOSITE</type><cible>para</cible></élément dita>

Dans l’exemple ci-dessus, tous les éléments DITA sous-étapes sont rendus à l’aide du composant dita/composants/liste dita.

2) Si un élément DITA ne trouve pas de correspondance basée sur le nom, une correspondance sur la base de la classe est recherchée. Par exemple :

<élément dita><nom>rubrique</nom><classe>- rubrique/rubrique</classe><chemin composant>fmdita/composants/dita/rubrique</chemin composant><type>COMPOSITE</type><cible>para</cible><mappage attribut><attribut de="id" à="id" />< /mappage attribut ></élément dita>

Dans l’exemple ci-dessus, s’il n’existe aucune correspondance définie pour l’élément tâche, l’élément tâche est mappé sur le composant ci-dessus, car tâche est hérité du composant rubrique.

3) Lorsqu’un élément possède un mappage de composant correspondant, le traitement supplémentaire de ses éléments enfants est déterminée par type. Par exemple :

<élément dita><nom>titre</nom><classe>- rubrique/titre</classe><chemin composant>fondement/composants/titre</chemin composant><type>AUTONOME</type>

Page 18: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

15

<cible>para</cible><prop texte>jcr:titre</prop texte></élément dita>

type prend les valeurs suivantes :

• COMPOSITE : le mappage élément à composantcontinue aussi pour les éléments enfant.

• AUTONOME : les éléments enfants de l’élément en cours ne sont plus mappés.

Dans l’exemple ci-dessus, si l’élément <titre> contient des éléments enfant, ils ne seront mappés à aucun autre composant. Le composant pour l’élément <titre> est chargé de rendre tous les éléments enfants au sein de l’élément <titre>.

4) S’il existe plusieurs composants mappés à un seul élément DITA, la meilleure correspondance pour l’élément est sélectionnée. Afin de sélectionner le meilleur composant de correspondance, la spécialisation de domaine et de structure des éléments DITA est prise en compte.

S’il existe des éléments DITA avec une spécialisation de domaine et qu’un composant est mappé pour la spécialisation de domaine, ce composant bénéficie d’une haute priorité.

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 bénéficie d’une haute priorité.

5) Vous pouvez utiliser <mappage attribut> dans le mappage de l’élément pour mapper des valeurs d’attribut aux propriétés de nœud correspondantes.

6) prop texte peut être utilisé pour sérialiser le contenu textuel d’un élément DITA à une propriété de nœud. Par exemple :

<élément dita><nom>titre</nom><classe>- rubrique/titre</classe><chemin composant>fondement/composants/titre</chemin composant><type>AUTONOME</type><cible>para</cible><proptexte>jcr:titre</prop texte></élément dita>

Le mappage d’élément ci-dessus indique que le contenu textuel de l’élément <titre> sera enregistré comme valeur d’une propriété nommée jcr:titre sur le nœud de sortie.

Page 19: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

16

7) xmlprop peut être utilisé pour sérialiser le XML entier pour un élément donné à une propriété de nœud. Le composant peut ensuite lire cette propriété de nœud et effectuer le rendu personnalisé. Par exemple :

<élément dita><nom>svg-conteneur</nom><classe>+ rubrique/foreign svg-d/svg-conteneur</classe><chemin composant>fmdita/composants/dita/svg</chemin composant><type>AUTONOME</type><cible>para</cible><prop xml>données</prop xml></élément dita>

Le mappage d’élément ci-dessus indique que l’annotation XML entière pour l’élément < svg-conteneur > sera enregistrée comme valeur d’une donnée de propriété nommée données sur le nœud de sortie.

8) Il existe un mappage d’attribut spécial pour gérer la résolution de chemin d’accès lors du processus de génération de sortie. Par exemple :

<mappage attribut><attribut de="href" à="référence fichier" est chemin="vrai" rel="source" /><attribut de="hauteur" à="hauteur" /><attribut de="largeur" à="largeur" />< /mappage attribut >

Pour le mappage attribut ci-dessus, l’attribut href dans votre élément DITA sera mappé à une propriété de nœud nommée référence fichier. Puisque est chemin est défini sur vrai, le processus de génération de sortie résout ce chemin d’accès puis le définit dans la propriété de nœud référence fichier.

Comment cette résolution se produit est déterminé sur la base de la valeur de l’attribut rel dans le mappage d’attribut.

• Si rel = source, la valeur de href est résolue par rapport au fichier source DITA qui est en cours de traitement. La valeur de href est résolue et placée dans la valeur de la propriété référence fichier.

• Si rel = cible, la valeur de href est résolue par rapport à l’emplacement de publication de la racine. La valeur de href est résolue et placée dans la valeur de la propriété référence fichier.

Si vous ne voulez pas de prétraitement ou de résolution sur des attributs de chemin d’accès, vous n’avez pas besoin de définir l’attribut est chemin. La valeur est copiée telle quelle et le composant peut faire la résolution requise.

Page 20: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

17

Schéma d’élément DITA

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

<élément dita><nom>element_name</nom><classe>element_class</classe><chemin composant>fmdita/composants/dita/component_name</chemin composant><type>COMPOSITE|AUTONOME</type> <prop attribut>propname_a</propattribute> <prop texte>propname_t</prop texte><prop xml>propname_x</prop xml> <chemin x>chaîne expression chemin x</chemin x> <cible>tête|para< /cible> <élément enveloppé>div</élément enveloppé> <classe enveloppée>class_name</classe enveloppée> <mappage attribut> <attribut de="nom attr" à="nom prop" est chemin="vrai|faux" rel="source|cible" />< /mappage attribut ><sauter>vrai|faux</sauter> </élément dita>

Le tableau suivant décrit les éléments dans le schéma des éléments DITA :

Elément Description

<élément dita> Nœud de niveau supérieur pour chaque élément de mappage.

<classe> Attribut de classe de l’élément DITA cible pour lequel vous rédigez du composant.Par exemple, l’attribut de classe de la rubrique DITA est :

- rubrique/rubrique

<chemin composant> Chemin d’accès CRXDE du composant AEM mappé.

<type> Valeurs possibles :• COMPOSITE: Traiter également les éléments enfants• AUTONOME: Sauter le traitement des éléments enfants

Page 21: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation

18

<prop attribut> Utilisé pour mapper les attributs et les valeurs sérialisés DITA aux nœuds AEM en tant que propriété. Par exemple, si vous avez l’élément <type de note ="Attention"> et que le composant qui est mappé pour cet élément est <prop attribut>attr_t</ prop attribut>, l’attribut et la valeur du nœud sont alors sérialisés à la propriété attr_t du nœud AEM correspondant (attr_t->type="attention").

<prop texte>propname_t </prop texte>

Enregistrez la sortie Contenu texte () à la propriété définie par propname_t.

<prop xml>propname_x </prop xml>

Enregistrez le XML sérialisé de ce nœud à la propriété définie par propname_x.

<chemin x> Si l’élément Chemin X est fourni dans le mappage de l’élément, puis avec le nom et la classe de l’élément, la condition Chemin X doit également être satisfaite pour le mappage du composant à utiliser.

<cible> Place de l’élément DITA dans le référentiel crx, à l’emplacement spécifié.Valeurs possibles :• tête: Sous le nœud de tête• texte: Sous le nœud de paragraphe

<élément enveloppé> Élément HTML qui doit envelopper les contenus.

<classe enveloppée> Valeur de l’élément à la propriété classe enveloppée.

<mappage attribut> Nœud de conteneur contenant un ou plusieurs nœuds <attribut>.

<attribut de="nom attr" à="nom prop" est chemin="vrai|faux" rel="source|cible" />

Mappe les attributs DITA aux propriétés AEM :• de: Nom d’attribut DITA• à: Nom de propriété de composant AEM• est chemin: Si l’attribut est une valeur de chemin d’accès

(par exemple : image)• rel: Si le chemin d’accès est la source ou la cible

REMARQUE : Si nom attr commence par %, mappez alors nom attr moins '%' à la propriété 'nom prop'.

Elément Description

Page 22: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Configuration et personnalisation 3

19

Notes supplémentaires sur le mappage des éléments

• Si vous envisagez de remplacer le mappage d’élément par défaut pour le module complémentaire, il est recommandé de ne pas faire les modifications dans le fichier par défaut elementmapping.xml. Vous devez créer un nouveau fichier XML de mappage et placer le fichier à un autre emplacement, de préférence à l’intérieur du dossier personnalisé des applications que vous avez créé.

• Si vous envisagez de remplacer certains (mais pas tous) des mappages de l’élément, vous ne devez pas reproduire le fichier elementmapping.xml en entier. Vous devez créer un fichier de mappage XML et définir uniquement les éléments que vous remplacez.

• Après avoir créé le fichier XML à l’emplacement personnalisé, mettez à jour la définition Remplacement du mappage d’élément dans le regroupement com.adobe.fmdita.config.ConfigManager (voir Configuration des paramètres du module complémentaire XML).

Modification de la limite de la liste des sorties récemment générées

Vous pouvez modifier le nombre maximum de sorties générées affichées dans l’onglet Sorties d’un mappage DITA.

La valeur par défaut est 25.

Pour modifier le nombre de sorties à afficher, mettez à jour la définition Limite de la liste des sorties dans le regroupement com.adobe.fmdita.config.ConfigManager (voir Configuration des paramètres du module complémentaire XML).

Page 23: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

20

Gestion de contenu DITA

La documentation technique des grandes entreprises est souvent un travail de collaboration entre les auteurs, les SME et les réviseurs. Cependant, dans la plupart des environnements de création, cette collaboration n’est pas simple en raison des différents outils de création disponibles pour les différents types d’utilisateurs. Les auteurs peuvent utiliser une application d’édition DITA performante, telle que FrameMaker, et les SME et les réviseurs peuvent utiliser un traitement de texte simple. Avec le module complémentaire XML, vous pouvez créer un environnement de collaboration fluide dans lequel les SME peuvent créer facilement du contenu DITA dans un éditeur de rubrique et de mappages DITA basé sur un navigateur. L’éditeur de rubrique prend en charge les normes DITA 1.2 et 1.3 et également les normes DITA spécialisées.

Avant de commencer la création de contenu réel, vous devez maîtriser quelques concepts de base de gestion de contenu dans le module complémentaire XML.

Concepts fondamentaux de gestion de contenu

Gestion des ressources numériquesLe module complémentaire XML utilise la gestion des actifs numériques AEM (DAM) pour gérer vos fichiers DITA (contenus ou mappages). Les fichiers DITA que vous téléchargez ou sélectionnez dans le DAM sont stockés sous la forme de ressources numériques.

Conservation de la structure des fichiers DITALes rubriques ou les mappages sont conservés dans le format dans lequel un auteur les archive ou les télécharge. Cela signifie que le module complémentaire XML n’effectue aucune conversion ou transformation de ces fichiers.

Gestion des versionsLe module complémentaire XML fournit la gestion des versions de vos ressources numériques. Vous pouvez facilement activer cette fonctionnalité d’une application de création DITA de votre choix. Cela permet aux auteurs d’utiliser les fonctions de contrôle de la version standard telles que l’archivage, l’extraction et l’annulation de l’extraction.

Pour plus d’informations, consultez Création de versions de ressources dans la documentation AEM.

Gestion native DITABien que le module complémentaire XML conserve la structure des fichiers DITA, il permet également à AEM de gérer de façon native l’utilisation de DITA à l’aide de la fonction Mappage des éléments pour associer les éléments DITA à des composants AEM. La gestion native DITA est utilisée dans les fonctionnalités telles que l’aperçu de la rubrique, la publication sur les sites AEM et les flux de révision et d’approbation.

Page 24: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA 4

21

Téléchargements de fichiers DITA existantsLa procédure de téléchargement en vrac permet de télécharger rapidement un grand nombre de fichiers DITA vers le projet DITA dans votre référentiel AEM. Cela s’avère pratique si vous avez précédemment créé du contenu DITA que vous souhaitez déplacer vers le DAM AEM. Une fois que vous avez terminé le téléchargement, les auteurs peuvent alors continuer de créer des documents dans l’application de leur choix et les archiver et les extraire des fichiers selon leurs besoins.

Création d’un projet DITA

Un projet dans AEM vous permet de grouper différentes ressources dans une seule entité unique. Les types de ressources que vous pouvez associer à un projet sont désignés sous le nom de Mosaïques dans AEM. Les mosaïques peuvent inclure des informations de projet et d’équipe, des ressources, des processus et d’autres types d’informations, comme décrit en détail dans Mosaïques de projet l’article de la documentation AEM.

Avec chaque projet, vous pouvez associer différents types d’informations tels que ressources numériques, expériences, membres de l’équipe, pages d’accueil, etc. Pour plus d’informations sur les projets dans AEM, consultez Projets.

Le module complémentaire XML ajoute un modèle de projet DITA, que vous pouvez utiliser pour créer et gérer les tâches de votre projet. Vous pouvez ajouter des membres de l’équipe à ce projet susceptibles ensuite de remplir des rôles d’auteur, de réviseur ou d’approbateur. Chaque fois que vous, en tant qu’auteur, lancez un processus (tel que la révision ou l’approbation), les membres sélectionnés du projet reçoivent une notification par courrier électronique. Pour configurer des notifications par courrier électronique, consultez Personnaliser les modèles de courrier électronique.

Pour créer un projet DITA, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Projets. Vous pouvez également accéder à la console Projets à l’aide de l’URL suivante :

http://<nom de serveur>:<port>/projects.html

Page 25: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

22

3) Dans la barre d’outils, cliquez sur Créer.

La page de création de projet s’affiche.

4) Sur la page de création de projet, sélectionnez Projet DITA et cliquez sur Suivant.

Page 26: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA 4

23

5) Dans la page Propriétés du projet, saisissez les détails suivants :

Informations dans l’onglet Réglages de base :

• Saisissez le titre de votre projet, une description et la date d’échéance.

• Vous pouvez, le cas échéant, sélectionnez une image miniature pour le projet.

• Par défaut, l’administrateur est défini en tant qu’utilisateur (propriétaire) du projet. Pour ajouter d’autres utilisateurs à ce projet :

a) Saisissez ou sélectionnez un utilisateur dans la liste déroulante Utilisateur.

b) Sélectionnez un type d’utilisateur - Propriétaire, Observateur ou Editeur.

c) Cliquez sur Ajouter.

Informations dans l’onglet Avancé :

• Entrez un nom pour le projet. Ce nom est utilisé pour créer l’URL de ce projet.

6) Cliquez sur Créer.

La boîte de dialogue Projet créé s’affiche.

7) Cliquez sur Ouvrir un projet pour ouvrir la page de projet.

Création d’un contenu DITA

FrameMaker est l’éditeur DITA le plus puissant et le plus utilisé. Vous pouvez utiliser FrameMaker ou un autre éditeur DITA pour la création de contenu structuré. Le module complémentaire XML

Page 27: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

24

fournit également un éditeur DITA convivial pour les auteurs amateurs tels que les SME pour modifier des rubriques et créer ou modifier des mappages.

Cette section décrit l’éditeur Web en ligne du module complémentaire XML et FrameMaker en tant que client hors ligne que vous pouvez utiliser pour créer et modifier du contenu structuré.

Utilisation d’un éditeur de rubrique

Le module complémentaire XML est fourni avec un éditeur de rubrique facile à utiliser pour les auteurs inexpérimentés, tel que SME pour apporter de petites modifications à votre rubrique. L’éditeur masque toutes les subtilités de la structure DITA de l’auteur. L’éditeur propose une liste de base des éléments DITA que l’utilisateur doit généralement utiliser pour une rubrique DITA.

En outre, l’éditeur de rubrique est conforme DITA. Cela signifie qu’il ne vous permet pas de placer des éléments à des emplacements non conformes à la définition DITA.

L’éditeur de rubrique vous permet de traiter les éléments de paragraphe et de caractère suivants :

Pour modifier une rubrique, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.

3) Accédez à la rubrique que vous souhaitez modifier.

REMARQUE : Vérifiez que vous n’avez pas activé le mode de sélection des ressources.

4) Cliquez sur la rubrique que vous souhaitez modifier.

La rubrique s’affiche dans la console Ressources.

REMARQUE : Le module complémentaire XML analyse le contenu DITA et l’affiche dans AEM. Cet affichage est effectué en mappant des éléments DITA sur des composants AEM. Pour plus d’informations sur le mappage des éléments DITA sur des composants AEM, consultez Mappage des éléments.

Éléments de paragraphe Éléments de caractère

Liste numérotée Gras

Liste à puces Souligné

Référence croisée Italique

Tableau

Paragraphe

Page 28: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA 4

25

5) Cliquez sur Modifier pour ouvrir la rubrique dans l’éditeur du module complémentaire XML.

6) Pour apporter des modifications à votre rubrique, cliquez dans la limite de texte de l’élément requis et commencez les modifications souhaitées.

7) Pour insérer un élément spécifique, cliquez à la fin de l’élément après lequel vous souhaitez insérer le nouvel élément et cliquez sur l’icône d’élément requis dans la barre d’outils.

8) Une fois que vous avez terminé la modification de votre document, cliquez sur Enregistrer.

REMARQUE : Si vous ne souhaitez pas valider les modifications dans le référentiel AEM, cliquez sur Fermer, puis cliquez sur OK dans la boîte de dialogue de confirmation.

Page 29: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

26

Vues de l’éditeur de rubrique

L’éditeur de rubrique est fourni avec trois vues :

AuteurIl s’agit d’une vue typique WYSISYG (What You See is What You Get) de l’éditeur de rubrique. Vous pouvez modifier la rubrique comme vous le feriez dans n’importe quel éditeur de texte normal.

SourceLa vue Source affiche le document XML sous-jacent qui formate la rubrique. Si l’auteur possède une bonne connaissance du XML, il trouvera cette vue facile à manipuler. Outre l’apport de modifications de texte normales dans cette vue, un auteur peut également ajouter des éléments et des attributs en utilisant le Catalogue dynamique.Pour appeler le Catalogue dynamique, placez le curseur à l’extrémité de n’importe quelle balise d’élément et entrez « < ». L’éditeur affiche une liste de tous les éléments XML valides que vous pouvez insérer à cet emplacement.

Page 30: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA 4

27

Si vous souhaitez ajouter un attribut à un élément, placez le point d’insertion à l’intérieur de la balise d’élément et appuyez sur la barre d’espace. La liste des attributs valides de cet élément s’affichent dans le Catalogue dynamique.

AperçuL’ouverture d’une rubrique dans la vue Aperçu montre comment votre rubrique s’affichera lorsqu’elle sera lue par un client dans son propre navigateur Web.

Utilisation de l’éditeur de mappage

À l’aide de l’éditeur de mappage du module complémentaire XML, vous pouvez créer et modifier des mappages DITA. L’éditeur de mappage utilise la fonctionnalité de glisser/déplacer afin d’ajouter des rubriques à partir de votre référentiel AEM. Vous pouvez imbriquer des rubriques, ajouter des attributs et des informations de métadonnées, et également valider le mappage comme étant correct.

Pour utiliser l’éditeur de mappage, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.

3) Accédez à l’emplacement où vous souhaitez créer le mappage DITA.

4) Pour créer un mappage, sélectionnez Créer > Créer un mappage DITA dans la barre d’outils.

Page 31: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

28

5) Dans la page Créer un mappage DITA, saisissez un titre et un nom pour le mappage, puis cliquez sur Créer.

Le fichier de mappage s’ouvre dans l’éditeur de mappage DITA.

6) Vous créez un mappage à l’aide des rubriques disponibles actuellement affichées dans la section Références, à gauche de la console Ressources.

7) Naviguez jusqu’au dossier contenant les rubriques que vous souhaitez ajouter à votre mappage.

REMARQUE : Vous pouvez ajouter des rubriques à partir de n’importe quel dossier de la section Références.

8) Pour ajouter la première rubrique au mappage, faites glisser la rubrique et déposez-la dans la console de mappage.

9) Pour ajouter les rubriques suivantes au mappage, faites glisser la rubrique vers l’emplacement souhaité sur le mappage.

10) Vous pouvez effectuer les tâches suivantes sur les rubriques du mappage :

Diminuer et Augmenter le retraitPlacez le pointeur de la souris sur la rubrique et utilisez les flèches vers la gauche ou vers la droite pour diminuer ou augmenter le retrait d’une rubrique par rapport à son parent.

PropriétésPlacez le pointeur de la souris sur la rubrique et cliquez sur Propriétés pour ouvrir la boîte de dialogue des propriétés de référence de la rubrique (Topicref). Cette boîte de dialogue permet de définir les attributs et les informations de métadonnées de la rubrique. Pour plus d’informations sur les attributs et les métadonnées standard d’une rubrique DITA, consultez la documentation topicref dans Spécifications du langage OASIS DITA.

Page 32: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA 4

29

Ajouter une nouvelle référencePlacez le pointeur de la souris sur une rubrique et cliquez sur l’icône Ajouter une nouvelle référence pour ajouter une nouvelle référence en tant qu’enfant de la rubrique actuelle.

GrouperCliquez sur la case à cocher située à gauche des rubriques, puis cliquez sur Grouper dans la barre d’outils pour grouper les rubriques sélectionnées. Pour plus d’informations sur le regroupement de rubriques DITA, consultez la documentation topicgroup dans Spécifications du langage OASIS DITA.

SupprimerCochez la case à gauche d’une rubrique et cliquez sur Supprimer dans la barre d’outils pour supprimer les rubriques sélectionnées du mappage.

11) Vous pouvez également utiliser les options suivantes dans la barre d’outils pour effectuer des tâches supplémentaires sur le mappage :

Afficher les nombres et Masquer les nombresAffichez (ou masquez) la numérotation des rubriques dans le mappage.

ValiderVérifiez si le mappage est valide ou contient des erreurs.

12) Cliquez sur Enregistrer.

Utiliser FrameMaker en tant que client hors ligne

La mise à jour 4 de FrameMaker (2015 release) est fournie avec un connecteur AEM mis à jour. Ce connecteur permet d’effectuer des opérations telles que la synchronisation des commentaires de révision sur une rubrique partagée pour la révision. Vous pouvez publier de nouveaux commentaires ou répondre aux commentaires de révision existants dans FrameMaker. Pour plus d’informations, consultez la section Révision du guide de l’utilisateur FrameMaker.

À l’aide du connecteur de FrameMaker-AEM, vous pouvez archiver et extraire des fichiers sur le référentiel AEM. Pour plus d’informations, consultez la section Utilisation de fichiers dans le guide de l’utilisateur FrameMaker.

Le connecteur fournit également une fonction de recherche qui vous permet de rechercher facilement du contenu DITA dans votre référentiel AEM. Vous pouvez également utiliser la recherche d’attribut pour rechercher du contenu DITA en fonction de l’attribut des éléments. Pour plus d’informations, consultez la section Recherche dans le référentiel AEM dans le guide de l’utilisateur FrameMaker.

Page 33: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Gestion de contenu DITA

30

Télécharger des fichiers existants

Vous disposez probablement d’un référentiel de contenu DITA existant que vous souhaitez utiliser avec le module complémentaire XML. Pour un tel contenu existant, vous pouvez utiliser l’une des deux approches suivantes pour télécharger en vrac votre contenu dans le référentiel AEM :

Utilisez FrameMaker pour le téléchargement en vrac

La mise à jour 4 d’Adobe Framemaker (2015 release) est fournie avec un connecteur AEM puissant qui vous permet de télécharger rapidement votre contenu DITA existant dans AEM. Vous pouvez utiliser différentes fonctions de transfert d’un fichier telles que télécharger un fichier unique, télécharger un dossier complet avec ou sans dépendances (comme les références contextuelles, les références croisées et les graphiques).

Pour plus de détails sur l’utilisation de la fonction de téléchargement en vrac dans FrameMaker, consultez la section Créer un dossier CRX et télécharger des fichiers dans le guide de l’utilisateur FrameMaker.

Utiliser WebDAV pour le téléchargement en vrac

Si vous créez vos rubriques et mappages dans un autre éditeur DITA, vous pouvez utiliser WebDAV pour vérifier vos fichiers dans votre projet.

Pour plus d’informations sur la manière de vérifier vos fichiers dans votre projet, consultez Accès à WebDAV dans la documentation AEM.

Page 34: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation 5

31

Révision et approbation

Tout document technique que vous créez doit presque toujours passer par des phases de révision successives. Dans la plupart des cas, le cycle de révision implique plus d’un réviseur. Traiter et répondre aux commentaires de plusieurs réviseurs est toujours difficile. En outre, dans un scénario de réviseurs multiples, il est utile qu’un réviseur puisse voir les commentaires apportés par d’autres réviseurs. Le module complémentaire XML répond à ce besoin en fournissant un processus de révision collaboratif.

FrameMaker 2015 comporte désormais un module de commentaires de révision qui est intégré avec le module complémentaire XML.

Envoi de rubriques en révision

Le processus de révision facilite la mise en place d’un environnement de réviseurs multiples où l’initiateur spécifie la liste des réviseurs et la chronologie de la révision lorsqu’une révision est lancée ou même pour une révision en cours. Une version en ligne de la rubrique est rendue disponible pour révision. Le volet Révision du module complémentaire XML permet aux auteurs et aux réviseurs de commenter ou d’annoter une rubrique en temps réel. Le volet permet également à toute personne impliquée d’afficher les commentaires ou les annotations et d’y répondre. Dans un processus de révision multiphase, les réviseurs peuvent facilement voir les différences dans le contenu en cours de mise à jour, depuis la première version jusqu’à la plus récente.

Enfin, le tableau de bord de gestion de révision fournit aux administrateurs une vue globale du statut de la révision des différentes rubriques.

Avec le module complémentaire XML, vous pouvez créer des tâches de révision afin que plusieurs rubriques ou qu’un mappage soient révisés.

Création d’une tâche de révision

Pour créer une tâche de révision et envoyer des rubriques en révision, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM. Accédez au dossier requis dans la console Ressources.

REMARQUE : Assurez-vous que la vue de la console est définie sur une vue Carte ou Liste.

2) Cliquez sur le bouton Sélectionner de la barre d’outils. La console est maintenant prête pour une sélection des rubriques requises.

Page 35: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation

32

3) Cliquez pour sélectionner les rubriques que vous voulez envoyer en révision.

4) Cliquez sur Plus dans la barre d’outils, puis cliquez sur Créer une tâche de révision. La page de création de la tâche de révision est affichée.

5) Saisissez un titre pour la tâche et sélectionnez le projet dans la liste déroulante.

6) Dans le champ Assigner à, sélectionnez dans la liste déroulante les réviseurs auxquels vous voulez envoyer les rubriques à réviser. Vous pouvez sélectionner un réviseur unique ou plusieurs réviseurs.

REMARQUE : Le processus de révision est une fonction spécifique d’un projet. Lorsque vous créez des projets, vous définissez l’équipe du projet et lui assignez des rôles. Ainsi, lorsque vous sélectionnez le projet ici, vous choisissez les personnes désignées qui font partie de ce projet. Pour plus d’informations sur les projets, consultez Création d’un projet DITA.

7) Entrez la description de la tâche. Cette description est utilisée comme corps du courrier électronique de notification envoyé aux réviseurs.

Sélectionnez la date et l’heure de l’échéance pour marquer la date limite de la révision.REMARQUE : Une fois la date limite atteinte, un courrier électronique est envoyé à l’initiateur, l’informant que la tâche de révision est terminée.

Page 36: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation 5

33

8) Cliquez sur Créer pour lancer la révision.

Un message de confirmation s’affiche lorsque la tâche de révision a été créée avec succès.

REMARQUE : Vous pouvez également cliquer sur le volet Notifications en haut à droite de l’interface et vérifier que la tâche a été créée avec succès.

Un message électronique est envoyé à tous les réviseurs, les informant qu’une ou plusieurs rubriques leur ont été assignées pour révision. Ce courrier électronique contient un lien direct sur lequel ils pourront cliquer pour accéder à la rubrique dans une fenêtre de navigateur.

Au cas où plusieurs rubriques sont assignées, les réviseurs peuvent les visualiser et les sélectionner dans une liste déroulante des rubriques, dans le navigateur web.

Envoi d’un mappage DITA en révision

Un mappage DITA est une liste organisée de rubriques. Il représente la table des matières du projet. Lors de la publication, les rubriques d’un projet sont alignées en fonction de la séquence définie dans le mappage.

Vous pouvez envoyer un mappage en révision si vous souhaitez que la séquence de rubriques soit validée.

Pour envoyer un mappage en révision, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM. Accédez au dossier requis dans la console Ressources.

REMARQUE : Assurez-vous que la vue de la console est définie sur une vue Carte ou Liste.

2) Effectuez l’une des opérations suivantes :

• Cliquez sur le mappage à envoyer en révision. Cliquez sur Créer une tâche de révision dans la barre d’outils.

• Cliquez sur le bouton Sélectionner de la barre d’outils. Sélectionnez le mappage à envoyer en révision. Cliquez sur Créer une tâche de révision dans la liste déroulante Plus.

3) Saisissez un titre pour la tâche et sélectionnez le projet dans la liste déroulante.

4) Dans le champ Assigner à, sélectionnez dans la liste déroulante les réviseurs auxquels vous voulez envoyer le mappage à réviser. Vous pouvez sélectionner un réviseur unique ou plusieurs réviseurs.

REMARQUE : Le processus de révision est une fonction spécifique d’un projet. Lorsque vous créez des projets, vous définissez l’équipe du projet et lui assignez des rôles. Ainsi, lorsque vous sélectionnez le projet ici, vous choisissez les personnes désignées qui font partie de ce projet. Pour plus d’informations sur les projets, consultez Création d’un projet DITA.

Page 37: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation

34

5) Entrez la description de la tâche. Cette description est utilisée comme corps du courrier électronique de notification envoyé aux réviseurs.

Sélectionnez la date et l’heure de l’échéance pour marquer la date limite de la révision.REMARQUE : Une fois la date limite atteinte, un courrier électronique est envoyé à l’initiateur, l’informant que la tâche de révision est terminée.

6) Cliquez sur Créer pour lancer la révision.

Un message de confirmation s’affiche lorsque la tâche de révision a été créée avec succès.

Un message électronique est envoyé à tous les réviseurs, les informant qu’un mappage leur a été assigné pour révision. Ce courrier électronique contient un lien direct sur lequel ils pourront cliquer pour accéder au mappage dans une fenêtre de navigateur.

Révision de rubriques ou d’un mappage

Si vous êtes inclus en tant que réviseur dans une révision de rubrique ou de mappage, vous recevez une demande de révision par courrier électronique.

Effectuez les étapes suivantes pour procéder à la révision :

1) Cliquez sur le lien direct fourni dans le courrier électronique de demande de révision.

La rubrique ou le mappage est accessible dans un navigateur.

2) Saisissez les commentaires de révision dans le volet Commentaires et appuyez sur Entrée pour envoyer les commentaires.

Vous pouvez voir les commentaires répertoriés dans le volet Commentaires. Ce volet répertorie également les commentaires d’autres réviseurs si la rubrique est envoyée pour une révision partagée.

Vous pouvez également ajouter des réponses aux commentaires dans le volet Commentaires.

Traitement des commentaires de révision dans FrameMaker

Le connecteur FrameMaker 2015 - AEM s’accompagne d’un module de commentaires de révision que vous pouvez utiliser pour afficher les commentaires, les filtrer et y répondre.

Une fois installée la connexion d’AEM, vous pouvez afficher le contenu du référentiel. Vous pouvez accéder directement à la rubrique qui a été révisée et utiliser le module Commentaires de révision.

Consultez la rubrique Révision au chapitre Systèmes de gestion de contenu du guide de l’utilisateur FrameMaker (2015 release) pour comprendre comment traiter les commentaires de révision dans FrameMaker.

Page 38: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation 5

35

Envoi des rubriques pour approbation

Une fois la révision des rubriques terminée, vous pouvez envoyer les rubriques pour approbation. Une version en ligne d’une rubrique est rendue disponible pour approbation. Le volet Révision affiche l’ensemble des commentaires, réponses et annotations du cycle de révision. L’approbateur peut alors utiliser ces derniers pour déterminer si la rubrique doit être approuvée ou rejetée. Les processus de révision et d’approbation du module complémentaire XML sont seulement couplés d’une manière souple. Cela signifie que si une rubrique est envoyée pour approbation, il n’est pas obligatoire qu’elle passe par le processus de révision.

Création d’une tâche d’approbation

Pour créer une tâche d’approbation et envoyer des rubriques pour approbation, procédez comme suit :

1) Vérifiez que vous êtes bien connecté à AEM et accédez au dossier requis dans la console Ressources.

2) Cliquez sur le bouton Sélectionner de la barre d’outils. La console est maintenant prête pour la sélection de la ou des rubriques requises.

3) Cliquez pour sélectionner la ou les rubriques que vous voulez envoyer pour approbation.

Page 39: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation

36

4) Cliquez sur Plus dans la barre d’outils, puis cliquez sur Créer une tâche d’approbation. La page de création de la tâche d’approbation est affichée.

5) Saisissez un titre pour la tâche et sélectionnez le projet dans la liste déroulante.

6) Dans le champ Assigner à, sélectionnez dans la liste déroulante les approbateurs auxquels vous voulez envoyer la ou les rubriques à approuver. Vous pouvez sélectionner un approbateur unique ou plusieurs approbateurs.

REMARQUE : Le processus d’approbation est une fonction spécifique d’un projet. Lorsque vous créez des projets, vous définissez l’équipe du projet et lui assignez des rôles. Ainsi, lorsque vous sélectionnez le projet ici, vous choisissez les personnes désignées qui font partie de ce projet. Pour plus d’informations sur les projets, consultez Création d’un projet DITA.

7) Entrez la description de la tâche. Cette description est utilisée comme corps du courrier électronique de notification envoyé aux approbateurs.

Sélectionnez la date et l’heure de l’échéance pour marquer la date limite de l’approbation.

8) Cliquez sur Créer pour lancer l’approbation.

Un message de confirmation s’affiche lorsque la tâche d’approbation a été créée avec succès.

REMARQUE : Vous pouvez également cliquer sur le volet Notifications en haut à droite de l’interface et vérifier que la tâche a été créée avec succès.

Page 40: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation 5

37

Approbation ou rejet des rubriques

Pour approuver ou rejeter des rubriques, procédez comme suit :

1) Cliquez sur le lien direct fourni dans le courrier électronique de demande d’approbation.

La rubrique est accessible dans un navigateur.

Au cas où plusieurs rubriques sont assignées, les approbateurs peuvent les visualiser et les sélectionner dans une liste déroulante des rubriques, dans le navigateur web.

2) Le volet droit affiche la liste des commentaires existants ainsi que des informations telles que le statut et les réponses aux commentaires, le cas échéant.

Vous pouvez revoir les commentaires et les réponses sur la rubrique pour décider si vous devez approuver ou rejeter la rubrique.

REMARQUE : Activez ou désactivez l’historique pour afficher ou masquer les modifications qui ont été apportées à la rubrique.

3) Cliquez sur Approuver ou sur Rejeter.

Vous êtes invité à saisir un commentaire.

4) Saisissez un commentaire (ou une raison du rejet de la rubrique) et cliquez sur Approuver ou sur Rejeter.

Une notification d’approbation ou de rejet (y compris la raison) est envoyée à l’initiateur.

Page 41: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation

38

Gestion des révisions et des approbations

Le processus de gestion des révisions et des approbations peut inclure diverses tâches. Par exemple, vous pouvez souhaiter ajouter ou supprimer des réviseurs ou des approbateurs pour une rubrique particulière ou étendre la date limite d’une révision. Vous pouvez également souhaiter marquer la tâche de révision ou d’approbation comme terminée si vous pensez que toutes les parties prenantes ont terminé leur contribution. Ces tâches peuvent être gérées à l’aide de la fonctionnalité Gestion des révisions et des approbations.

Effectuez les étapes suivantes pour connaître les tâches que vous pouvez effectuer à l’aide de Gestion des révisions et des approbations :

1) Sur la console Projets, cliquez sur le projet sur lequel vous travaillez.

Le volet Projet contenant les mosaïques de tâche s’affiche.

2) Cliquez sur la mosaïque Tâches pour accéder au volet.

REMARQUE : Cliquez sur le signe + dans la mosaïque Tâches pour ajouter une nouvelle tâche.

Une page présentant les tâches, les dates d’échéance, la personne désignée et le statut de la tâche s’affiche.

Page 42: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Révision et approbation 5

39

3) Dans la liste des tâches, cliquez sur le titre de la tâche que vous souhaitez modifier.

a) Effectuez les opérations suivantes sous l’onglet TÂCHE :

• Modifiez le titre de la tâche dans la zone de texte Titre.

• Ajoutez des personnes désignées dans la liste déroulante Assigné à.

• Mettez à jour la description de la tâche dans la zone de texte Description.

• Définissez la priorité de la tâche dans la liste déroulante Priorité de la tâche.

• Modifiez la date d’échéance. Vous pouvez avancer ou différer la date limite de fin de tâche.

• Cliquez sur Mettre à jour pour mettre à jour les détails modifiés.

• Cliquez sur Terminer, si vous souhaitez marquer la tâche comme étant terminée avant la date d’échéance.

b) Effectuez les opérations suivantes sous l’onglet CONTENU :

• Ajoutez d’autres rubriques à la tâche existante. Cliquez sur Ajouter des ressources et accédez à la rubrique requise.

Page 43: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu

40

Traduction d’un contenu

Le module complémentaire XML s’accompagne de fonctionnalités performantes qui vous permettent de faire traduire votre contenu dans plusieurs langues. Les deux flux de travaux de traduction, humaine et automatique, sont pris en charge par le module complémentaire XML.

• Traduction humaine - Des ressources sont envoyées à votre fournisseur de traduction et traduites par des traducteurs professionnels. Une fois l’opération terminée, les ressources traduites sont renvoyées et importées dans AEM.

• Traduction automatique – Le service de traduction automatique traduit instantanément votre contenu. Par défaut, AEM permet de se connecter à Microsoft Translator.

REMARQUE : Microsoft Translator n’est disponible que sous forme de licence d’évaluation.

Traduction d’un contenu pour la première fois

Vous pouvez faire traduire un mappage DITA, une rubrique ou un dossier entier. Toutefois, pour une organisation et une gestion aisées des copies de langue, effectuez la traduction initiale au niveau du dossier plutôt qu’au niveau de la rubrique.

Créez une copie de langue source pour le dossier du projet, de sorte que le système puisse identifier votre langue source. Par exemple : Si votre projet est en anglais, vous devez simplement avoir une copie de langue appelée <nom_du_projet>-en, de sorte que le système identifie l’anglais comme langue source. Vous devez utiliser cette copie de langue pour tous les processus et modifications, comme la traduction initiale et les suivantes.

REMARQUE : Le dossier ORIGINAL de la copie de langue dans la fenêtre Références > Copies de langue représente le dossier du projet d’origine. Il ne doit pas être utilisé pour la traduction.

Vous pouvez également vérifier s’il existe déjà une copie de langue source pour votre projet. Exécutez les étapes suivantes :

1) A l’aide de l’option Sélectionner de la barre d’outils, sélectionnez le dossier de votre projet, dans la console Ressources.

Page 44: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu 6

41

2) Cliquez sur Références dans la barre d’outils. Un volet Références s’affiche à gauche de l’interface.

Pour le dossier de projets sélectionné, il existe un dossier d’origine et une copie de langue source nommée Projets-en. Tous les flux de travaux de traduction et les modifications doivent être effectués sur la copie de langue source.

Pour créer une copie de langue source, suivez la procédure ci-dessous.

Création d’une copie de langue source

Pour créer une copie de langue source, procédez comme suit.

1) Vérifiez que vous êtes bien connecté dans AEM. Accédez à la console Ressources.

2) Cliquez sur le bouton Sélectionner de la barre d’outils. La console est maintenant prête pour la sélection du dossier requis.

3) Sélectionnez le dossier et dans la barre d’outils, cliquez sur Références. Un volet Références s’affiche à gauche de l’interface.

4) Cliquez sur Copies de langue. La copie de langue ORIGINAL s’affiche. En outre, si vous avez fait traduire le contenu sélectionné précédemment, les copies de langue pour chaque langue traduite s’affichent après l’original.

5) Cliquez sur Créer dans la partie inférieure du volet Références.

6) Dans le volet Créer, sélectionnez DAM Créer une copie de langue dans la liste déroulante des processus de traduction.

7) Sélectionnez la langue de votre contenu source dans la liste déroulante des langues cibles.

8) Entrez le titre du processus et cliquez sur Démarrer pour lancer le processus.

Une copie de langue source avec <nom projet>-<langue racine> est créé dans la console Ressources

REMARQUE : Ce processus ne déclenche pas la tâche de traduction. Vous pouvez commencer la tâche de traduction d’une copie de langue source en suivant la procédure ci-dessous.

Page 45: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu

42

Démarrage de la tâche de traduction

Pour démarrer la tâche de translation sur la copie de langue source, procédez comme suit :

1) Vérifiez que vous êtes bien connecté dans AEM. Accédez à la console Ressources.

2) Cliquez sur le bouton Sélectionner de la barre d’outils. La console est maintenant prête pour la sélection du dossier requis.

3) Sélectionnez la copie de langue source et dans la barre d’outils, cliquez sur Références. Un volet Références s’affiche à gauche de l’interface.

4) Cliquez sur Copies de langue.

5) Cliquez sur Créer dans la partie inférieure du volet Références.

6) Sélectionnez DAM Créer et traduire la copie de langue dans la liste déroulante des processus de traduction.

Référez-vous au processus DAM Créer et traduire la copie de langue pour effectuer ces étapes.

Une copie de langue cible du dossier sélectionné est créée avec la langue cible racine comme nom de dossier, dans la console Ressources. Par exemple, si vous avez défini un processus de traduction en italien pour votre dossier source appelé en contenant des ressources avec des métadonnées en anglais, la copie de langue est appelée it. Cette copie de langue apparaît alors sous la section Copies de langue dans le volet Références.

Un projet de traduction du même nom est également créé dans la console Projets, et le contenu des dossiers est automatiquement ajouté à la tâche de traduction.

Une fois la traduction terminée, le statut de la tâche de traduction devient Prêt pour révision. Accédez au dossier de langue cible dans la console Ressources pour afficher les rubriques traduites.

Affichage du statut de la traduction

Vous pouvez afficher le statut de la traduction et les copies de langue traduites de chaque rubrique dans un dossier.

1) Recherchez et sélectionnez le dossier de la copie de langue source dans la console Ressources.

2) Cliquez sur Références. Un volet Références s’affiche à gauche.

Page 46: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu 6

43

3) Cliquez sur Copies de langue. La liste des langues dans lesquelles les rubriques ont été traduites s’affiche.

Par exemple, le dossier hiérarchie-en de la copie de langue source (anglais) est traduite en hiérarchie-ar (arabe) et hiérarchie-br (bulgare).

Vous pouvez également accéder au fichier de mappage DITA de la copie de langue source. Cliquez sur l’onglet Traduction, puis cliquez sur la flèche déroulante pour vérifier les copies traduites pour chaque rubrique.

Utilisez les filtres Statut et Langues dans la partie supérieure droite pour voir les copies modifiées de la langue correspondante.

Vous pouvez lancer la traduction des rubriques modifiées depuis cette fenêtre.

Traduction des rubriques modifiées

Si vous apportez des modifications dans certaines rubriques, ces rubriques nécessitent d’être retraduites. Vous pouvez suivre les rubriques modifiées depuis le mappage DITA. Dans le dossier de la copie de langue source, cliquez sur le fichier de mappage DITA, puis cliquez sur l’onglet Traduction. Vous pouvez voir le statut de chaque rubrique, si elle est traduite ou requiert une retraduction.

Page 47: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu

44

Effectuez les étapes suivantes pour envoyer une rubrique modifiée à la retraduction :

1) Cliquez sur le fichier de mappage DITA dans le dossier de la copie de langue source.

2) Cliquez sur l’onglet Traduction. Vous pouvez voir le statut de traduction de chaque rubrique. Les rubriques qui ont été modifiées affichent le statut « Contient des copies désynchronisées ».

Si vous cliquez sur la flèche pour afficher plus de détails, vous pouvez voir la copie particulière de langue qui n’est pas synchronisée.

3) Cliquez sur la case à cocher pour sélectionner les rubriques que vous souhaitez envoyer pour retraduction.

4) Cliquez sur Envoyer pour traduction de la barre d’outils.

La fenêtre Synchroniser et traduire s’affiche.

5) Sélectionnez votre projet de traduction. Vous pouvez choisir d’inclure également le mappage DITA. Cliquez sur Synchroniser et traduire.

Un message de confirmation s’affiche et indique que la rubrique a été envoyée pour traduction.

Page 48: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Traduction d’un contenu 6

45

6) Accédez au projet de traduction dans la console Projets. Une nouvelle carte de tâche de traduction est créée dans le dossier. Cliquez sur l’ellipse pour afficher les ressources du dossier.

7) Pour lancer la traduction, cliquez sur la flèche dans la carte de tâche de traduction puis sélectionnez Démarrer dans la liste. Un message indique que la tâche a démarré.

Vous pouvez également afficher le statut de la rubrique en cours de traduction lorsque vous cliquez sur l’ellipse en bas de la carte de tâche de traduction.

8) Une fois la traduction terminée, le statut devient Prêt pour révision. Cliquez sur l’ellipse pour afficher les détails de la rubrique et effectuez l’une des opérations suivantes à partir de la barre d’outils :

• Cliquez sur Faire apparaître dans les ressources pour afficher et vérifier la traduction.

• Cliquez sur Accepter la traduction, si vous pensez que les modifications ont été traduites correctement. Un message de confirmation s’affiche.

• Cliquez sur Rejeter la traduction si vous pensez que cette tâche doit être recommencée. Un message de rejet est affiché.

9) Revenez au fichier de mappage DITA dans le dossier de langue source dans la console Ressources. Les rubriques retraduites sont désormais synchronisées.

Page 49: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

46

Génération d’une sortie

Le module complémentaire XML possède des capacités de publication incorporées pour générer des sorties dans divers formats standard. La version actuelle du module complémentaire XML vous permet de générer une sortie dans les deux formats les plus courants - Site AEM et PDF.

En tant qu’auteur, vous cliquez simplement sur quelques liens et la sortie est générée. Vous pouvez générer la sortie pour un mappage DITA en entier ou vous pouvez seulement modifier certaines rubriques que vous avez mis à jour. Une fois que la sortie est générée sur votre instance de création AEM, vous pouvez facilement faire de même sur votre serveur de production grâce aux nouveaux processus de publication AEM.

En tant que spécialiste en production, vous pouvez créer et associer vos modèles de conception personnalisée pour générer des sorties dans une présentation particulière. En outre, le module complémentaire XML vous permet d’utiliser des modules externes DITA-OT personnalisés pour réutiliser votre processus existant de génération de PDF.

Les informations présentées dans les sections suivantes sont destinées aux auteurs qui utilisent des flux de génération de sortie et effectuent certains dépannages de base :

• Comprendre les paramètres prédéfinis de sortie

• Génération d’une sortie de mappage DITA

• Génération d’une sortie incrémentielle

• Affichage du statut de la tâche de génération de sortie

• Dépannage de base

Si vous êtes un spécialiste en production, les informations des sections suivantes vous aideront à comprendre le processus consistant à personnaliser les sorties PDF et sites AEM :

• Personnalisation du modèle de conception du module complémentaire XML pour générer une sortie

• Utilisation des modules externes DITA-OT personnalisés

Génération d’une sortie

Cette section vous guide tout au long du processus de génération de sortie par le module complémentaire de XML. Avant de générer une sortie, vous devez vous familiariser avec les différentes options disponibles pour générer la sortie.

Page 50: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie 7

47

Comprendre les paramètres prédéfinis de sortie

Le module complémentaire XML prend en charge la génération d’une sortie dans deux formats - Site AEM et PDF. L’utilisation de ces deux formats de sortie vous permet de configurer différents paramètres prédéfinis de sortie. Un paramètre de sortie prédéfini représente un format de sortie personnalisé dans lequel vous souhaitez que ce contenu soit publié.

Les sections suivantes présentent les options disponibles pour ces deux formats de sortie.

Sortie au format Site AEM

Les options suivantes sont disponibles pour la sortie au format Site AEM :

REMARQUE : Pour ouvrir les paramètres prédéfinis de sortie au format Site AEM, cliquez sur un fichier de mappage DITA, puis cliquez sur les paramètres prédéfinis de sortie, puis cliquez sur l’option Sortie au format Site AEM.

Option Sortie au format Site AEM Description

Type de sortie Type de la sortie que vous voulez générer. Pour générer une sortie au format Site AEM, sélectionnez l’option Site AEM.

Définition du nom Donnez un nom descriptif pour les paramètres de site AEM que vous créez. Par exemple, vous pouvez spécifier Sortie de clients internes ou Sortie d’utilisateurs finaux.

Nom du site Nom du site dans lequel est stockée la sortie dans le référentiel AEM.Un nœud dans le référentiel AEM est créé avec le nom spécifié ici. Si vous ne spécifiez pas le nom du site, le nœud de site est créé avec le nom de fichier du mappage DITA.Le nom du site que vous spécifiez ici est également utilisé comme titre dans l’onglet de navigateur.

Conception Sélectionnez le modèle de conception que vous souhaitez utiliser pour générer la sortie.Pour plus d’informations sur la manière d’utiliser les modèles de conception pour générer la sortie, reportez-vous à la section Personnalisation du modèle de conception du module complémentaire XML pour générer une sortie.

Chemin de destination Chemin d’accès dans le référentiel AEM dans lequel est stockée la sortie. Lors de la génération de la sortie finale, le nom du site et le chemin de destination sont combinés. Par exemple, si vous indiquez le nom du site comme guide de l’utilisateur et le chemin de destination comme /content/output/framemaker, la sortie finale est générée sous le nœud /content/output/framemaker/user-guide.

Fichier DITAVAL Sélectionnez un fichier DITAVAL pour générer du contenu personnalisé.

Remplacer les fichiers existants

Si cette option est sélectionnée, les fichiers existants disponibles dans le chemin de destination sont remplacés.

Générer un PDF distinct pour chaque rubrique

Si cette option est sélectionnée, un fichier PDF est également créé pour chaque rubrique dans le mappage DITA.

Page 51: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

48

Sortie au format PDF

Les options suivantes sont disponibles pour la sortie au format PDF :

REMARQUE : Pour ouvrir les paramètres prédéfinis de sortie pour le format PDF, cliquez sur un fichier de mappage DITA, puis cliquez sur les paramètres prédéfinis de sortie, puis cliquez sur l’option Sortie au format PDF.

Option Sortie au format PDF Description

Type de sortie Type de la sortie que vous voulez générer. Pour générer une sortie au format PDF, sélectionnez l’option PDF.

Définition du nom Donnez un nom descriptif pour les paramètres de sortie au format PDF que vous créez. Par exemple, vous pouvez spécifier Sortie de clients internes ou Sortie d’utilisateurs finaux.

Générer un fichier PDF à l’aide de

Sélectionnez une méthode que vous souhaitez utiliser pour créer le fichier PDF. Sélectionnez l’une de ces méthodes :• DITA-OT

Pour plus d’informations sur l’utilisation des modules externes DITA-OT personnalisés, consultez

Utilisation de modules externes DITA-OT personnalisés.• Serveur FrameMaker Publishing Server

Pour plus d’informations sur la configuration de FrameMaker Publishing Server avec le module complémentaire XML, consultez Configuration de FrameMaker Publishing Server.

Fichier DITAVAL Sélectionnez un fichier DITAVAL pour générer du contenu personnalisé.

REMARQUE : L’option Fichier DITAVAL n’est pas prise en charge pour la sortie générée par FMPS.

Nom du fichier Spécifiez le nom du fichier sous lequel vous souhaitez enregistrer le fichier PDF.

REMARQUE : L’option de nom de fichier n’est pas prise en charge pour la sortie générée par FMPS.

Chemin de destination Chemin d’accès dans le référentiel AEM dans lequel est stockée le fichier PDF.

Page 52: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie 7

49

Génération d’une sortie de mappage DITA

Suivez les étapes ci-après pour générer une sortie pour un mappage DITA :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.

3) Dans la console Ressources, accédez à, puis cliquez sur le fichier de mappage DITA que vous souhaitez publier.

La console de mappage DITA apparaît et affiche la liste des paramètres prédéfinis de sortie disponibles pour générer la sortie.

4) Sélectionnez un ou plusieurs paramètres prédéfinis de sortie que vous souhaitez utiliser pour générer la sortie.

5) Cliquez sur l’icône Générer pour lancer le processus de génération de sortie du mappage DITA.

REMARQUE : Vous pouvez afficher le statut actuel de la requête de génération de la sortie en cliquant sur Sorties. Pour plus d’informations, consultez Affichage du statut de la tâche de génération de sortie.

Génération d’une sortie incrémentielle

REMARQUE : La génération de la sortie incrémentielle s’applique uniquement à la sortie Site AEM.

Il peut y avoir un nombre d’instances pour lesquelles vous souhaitez effectuer une mise à jour de seulement quelques rubriques sélectionnées dans le mappage DITA et envoyer uniquement les rubriques sélectionnées. Pour gérer ces situations, le module complémentaire XML vous permet de créer des sorties incrémentielles.

Page 53: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

50

Si vous avez mis à jour quelques rubriques sélectionnées, vous n’avez pas besoin de régénérer tout le mappage DITA. Vous pouvez sélectionner uniquement les rubriques mises à jour et les régénérer.

Effectuez les étapes suivantes pour régénérer la sortie d’une rubrique spécifique ou d’un groupe de rubriques :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.

3) Dans la console Ressources, accédez à, puis cliquez sur le fichier de mappage DITA.

La console de mappage DITA apparaît et affiche la liste des paramètres prédéfinis de sortie disponibles pour générer la sortie.

4) Cliquez sur Rubriques.

Une liste des rubriques disponibles dans le mappage DITA s’affiche.

5) Sélectionnez les rubriques que vous souhaitez régénérer.

6) Cliquez sur l’icône Régénérer

La page de régénération de rubriques sélectionnées s’affiche.

7) Sélectionnez le paramètre de sortie prédéfini que vous souhaitez utiliser pour actualiser les rubriques sélectionnées.

8) Cliquez sur l’icône Régénérer pour lancer le processus de génération de sortie.

IMPORTANT: Si vous renommez un titre de rubrique et régénérez la rubrique, le titre de la rubrique mis à jour ne se reflète pas dans la table des matières du mappage DITA. Pour mettre à jour le titre de la rubrique dans la table des matières, vous devez régénérer le mappage DITA en entier.

Vous pouvez afficher le statut actuel de la requête de génération de la sortie en cliquant sur Sorties. Pour plus d’informations, consultez Affichage du statut de la tâche de génération de sortie.

Page 54: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie 7

51

Affichage du statut de la tâche de génération de sortie

Une fois que vous lancez la tâche de génération de sortie pour un mappage ou des rubriques sélectionnées actualisées, le module complémentaire XML envoie cette tâche à la file d’attente de la génération de sortie. Cette file d’attente est mise à jour en temps réel, indiquant le statut de chaque tâche de génération de sortie de la file d’attente.

Effectuez les étapes suivantes pour afficher la file d’attente de génération de sortie :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.

3) Dans la console Ressources, accédez à, puis cliquez sur le fichier de mappage pour lequel vous souhaitez vérifier le statut de la génération de la sortie.

4) Cliquez sur Sorties.

La page Sorties est divisée en deux parties :

• Sorties placées en file d’attente

Répertorie les sorties en attente d’être générées ou en cours de processus de génération. Vous pouvez également trouver le réglage ou le paramètre prédéfini de génération de sortie utilisé pour la tâche mise en file d’attente, le type, l’utilisateur à l’origine de la tâche, le temps écoulé depuis que la tâche est en file d’attente, ainsi que le statut actuel.

• Sorties générées

Répertorie les tâches de sortie qui ont été remplies. De nouveau, les informations affichées dans cette liste sont similaires à la section Sorties placées en file d’attente, à l’exception de l’heure de la génération de la sortie.

Dans cette liste, vous pouvez avoir des tâches ayant été exécutées avec succès ou des tâches qui ont échoué. Pour les tâches qui ont échoué, vous pouvez vérifier l’erreur dans le fichier journal qui est expliqué dans la section Dépannage de base.

Page 55: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

52

Dépannage de base

Lorsque vous travaillez avec le module complémentaire XML, vous risquez de subir des erreurs lors de la publication ou de l’ouverture d’un document. De telles erreurs peuvent être dans le mappage DITA ou dans un fichier de rubrique, ou dans le processus du module complémentaire XML proprement dit. Cette section fournit des informations sur la façon d’accéder et d’analyser les informations du fichier journal de génération de sortie. En outre, si votre rubrique DITA est trop volumineuse, vous pourriez subir une erreur de compilation JSP. Cette section fournit également des informations sur la façon de résoudre l’erreur de compilation JSP.

Accès et analyse du fichier journal de génération de sortie

Effectuez les étapes suivantes pour accéder au fichier journal de génération de sortie :

1) Une fois que vous avez lancé le processus de génération de sortie, cliquez sur Sorties dans la console du mappage DITA.

2) Si le processus de génération de sortie échoue pour une tâche, la tâche est indiquée en couleur rouge avec un lien vers le fichier journal de la génération de sortie.

3) Cliquez sur le lien du fichier journal de génération.

Vous êtes invité à ouvrir ou enregistrer le fichier journal.

4) Sélectionnez l’option Enregistrer le fichier, puis enregistrez le fichier journal.

5) Extrayez le contenu du fichier ZIP.

REMARQUE : Le fichier ZIP contient uniquement un seul fichier logs.txt.

Page 56: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie 7

53

6) Ouvrez le fichier logs.txt dans un éditeur de texte.

Les informations suivantes vous aideront à déterminer s’il existe une erreur dans le fichier DITA ou le processus du module complémentaire XML :

• Erreur de fichier de mappage DITA: Au cas où une erreur serait trouvée dans le fichier de mappage DITA ou n’importe quel autre fichier contenu dans le mappage DITA, le fichier journal contiendra une chaîne, « LA GÉNÉRATION A ÉCHOUÉ ». Vous pouvez vérifier les informations fournies dans le fichier journal pour localiser le fichier incorrect et pour résoudre le problème.

Dans l’extrait de fichier journal suivant, vous pouvez voir le message LA GÉNÉRATION A ÉCHOUÉ avec la raison de l’erreur.

• Erreur du module complémentaire XML: L’autre type d’erreur que vous pouvez identifier dans le fichier journal est lié au processus du module complémentaire XML proprement dit. Dans ce cas, le fichier de mappage DITA est analysé correctement, mais le processus de génération de sortie échoue en raison d’une erreur interne dans le module complémentaire XML. Pour ce type d’erreurs, vous devez demander l’aide de l’équipe d’assistance technique.

Dans l’extrait de fichier journal suivant, vous pouvez voir le message LA GÉNÉRATION A RÉUSSI, suivi de l’autre erreur technique.

Page 57: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

54

Résolution de l’erreur de compilation JSP

Si votre rubrique DITA est trop grande, vous pouvez voir l’erreur de compilation JSP (org.apache.sling.api.request.TooManyCallsException) dans votre navigateur. Cette erreur peut s’afficher lorsque vous ouvrez une rubrique pour modification, revue ou publication.

Suivez la procédure suivante afin de résoudre ce problème :

1) Vérifiez que vous êtes bien connecté dans AEM.

2) Dans la section de gauche, cliquez sur Outils > Console Web.

La page de configuration de la console Web d’Adobe Experience Manager s’affiche.

3) Recherchez et cliquez sur le composant Apache Sling Main Servlet.

Les options configurables du Apache Sling Main Servlet s’affichent.

4) Augmentez la valeur pour le paramètre Nombre d’appels par requête en fonction de vos besoins.

Personnalisation de la sortie

Le module complémentaire XML prend en charge la génération d’une sortie dans deux formats :

• Site AEM

• PDF

Pour la sortie Site AEM, vous pouvez attribuer différents modèles de conception avec différentes tâches de sortie. Ces modèles de conception peuvent rendre le contenu DITA en différentes dispositions. Par exemple, vous pouvez spécifier différents modèles de conception pour le public interne et externe.

Vous pouvez également utiliser les modules externes du jeu d’outils open source DITA (DITA-OT) personnalisés avec le module complémentaire XML. Vous pouvez télécharger ces modules externes DITA-OT personnalisés pour générer une sortie au format PDF d’une manière spécifique.

Page 58: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie 7

55

Personnalisation du modèle de conception du module complémentaire XML pour générer une sortie

Le module complémentaire XML utilise un ensemble de modèles de conception prédéfinis pour générer la sortie au format Site AEM. Vous pouvez personnaliser les modèles de conception du module complémentaire XML pour générer une sortie conforme à la marque de votre entreprise.

Le modèle de conception par défaut livré avec le module complémentaire XML vous permet de personnaliser les composants de la page d’accueil, de rubrique et de recherche. Vous pouvez faire une copie du modèle de conception par défaut et définir différents composants pour générer la sortie souhaitée.

Effectuez les étapes suivantes pour définir votre propre modèle de conception à utiliser pour la génération de la sortie au format Site AEM :

1) Connectez-vous à AEM et ouvrez le mode CRXDE.

2) Accédez au nœud de modèle de conception par défaut. L’emplacement du nœud de modèle de conception par défaut est :

/apps/fmdita/config/templates/

REMARQUE : Vous pouvez faire une copie du nœud de modèles de conception par défaut et effectuer des modifications dans le nouveau nœud pour utiliser vos modèles de conception personnalisés.

Page 59: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Génération d’une sortie

56

3) Cliquez sur le composant par défaut dans le nœud de modèles pour accéder à ses propriétés.

Les propriétés du modèle de conception du module complémentaire XML sont décrites dans le tableau suivant.

REMARQUE : Après avoir créé un nœud de modèle de conception, vous devez mettre à jour l’option Conception dans les paramètres prédéfinis de la sortie au format Site AEM pour utiliser le nœud de modèle de conception.

Utilisation des modules externes DITA-OT personnalisés

Si votre société utilise le module externe DITA-OT personnalisé pour générer une sortie au format PDF, vous pouvez l’utiliser aussi avec le module complémentaire XML. Le processus d’importation du module externe DITA-OT est expliqué dans la section Utilisation de modules externes DITA-OT personnalisés.

Propriété Description

cqTemplate Spécifiez l’emplacement du modèle de page AEM, qui est défini en tant que valeur de la propriété cq:template sur le nœud jcr:content de la page publiée. Ce modèle de page AEM ne pilote pas la hiérarchie de nœud enfant de la page publiée.

landingPage (Facultatif) Spécifiez l’emplacement du composant qui effectue le rendu de la page d’accueil de la sortie. Cette page est créée à partir du mappage DITA.Si elle n’est pas spécifiée, la page d’accueil n’est pas générée.

searchPage (Facultatif) Spécifiez l’emplacement du composant qui effectue le rendu de la page de recherche de la sortie.Si elle n’est pas spécifiée, la page de recherche n’est pas générée.

title Nom descriptif de votre modèle de conception.

topicPage Spécifiez l’emplacement du composant qui effectue le rendu de la page de rubrique pour la sortie.

Page 60: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Rapport de mappage DITA 8

57

Rapport de mappage DITA

Dans une configuration d’entreprise, vous souhaitez vérifier l’intégrité globale de votre documentation technique avant de publier les documents. Cette exigence devient encore plus essentielle dans les environnements dynamiques multiutilisateur et de publication à grande échelle.

Le module complémentaire XML fournit à vos administrateurs des fonctionnalités de génération de rapports permettant de vérifier l’intégrité globale de la documentation avant sa publication ou sa mise à la disposition des utilisateurs finaux. Le rapport de mappage DITA dans le module complémentaire XML fournit des informations importantes telles que les éléments manquants d’une rubrique, et le statut de révision et d’approbation de chaque rubrique. Un rapport individuel détaillé au niveau de la rubrique fournit également des informations relatives au contenu DITA, telles que des références de contenu et des images ou des références croisées manquantes.

Affichage du rapport de mappage DITA

Effectuez les étapes suivantes pour afficher le rapport de mappage DITA :

1) Vérifiez que vous êtes bien connecté dans AEM.2) Dans la section de gauche, cliquez sur Ressources.

La liste des ressources dans votre référentiel AEM est affichée dans la console Ressources.3) Dans la console Ressources, accédez à, puis cliquez sur le fichier de mappage DITA pour

lequel vous souhaitez afficher le rapport.4) Cliquez sur Rapports.

Page 61: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Rapport de mappage DITA

58

La page Rapports est divisée en deux parties :

• Résumé :

Répertorie le résumé global du fichier de mappage sélectionné. Lors de l’affichage du résumé, vous pouvez connaître rapidement le nombre total de rubriques dans le mappage, le nombre de rubriques qui ont des éléments manquants, les rubriques qui n’ont pas été révisées ou approuvées.

• Détails :

Lorsque vous cliquez sur une rubrique, un rapport détaillé de la rubrique sélectionnée s’affiche.

Les éléments signalés sous A et B sont décrits ci-dessous :

RubriqueTitre de la rubrique spécifiée dans le mappage DITA.

AuteurUtilisateur qui a travaillé en dernier sur cette rubrique.

RéviséIndique si la rubrique a été révisée ou non.

ApprouvéIndique si la rubrique a été approuvée ou non.

Éléments manquantsIndique le nombre d’images manquantes ou de références croisées rompues, le cas échéant.

Page 62: Utilisation de XML Documentation Add-on for Adobe ... · PDF filePublication avancée de rapports d’inspection ... Kit de développement Java • Oracle SE 8 JRE 1.8.x • Oracle

Rapport de mappage DITA 8

59

Ouvrir dans FrameMakerCliquer sur cette icône ouvre la rubrique dans FrameMaker.

REMARQUE : Cette fonctionnalité fonctionne uniquement si vous utilisez la mise à jour 4 de FrameMaker (2015 release).

Les éléments signalés sous C sont décrits ci-dessous :

ImagesChemin d’accès aux images utilisées dans la rubrique. Les liens d’image rompus sont répertoriés de couleur rouge.

Références du contenuChemin d’accès au contenu référencé dans la rubrique.

Références croiséesChemin d’accès au contenu avec référence croisée. Les références croisées rompues sont répertoriées de couleur rouge.

Révision et approbationAffiche le statut de la tâche de révision ou d’approbation de la rubrique. Dans le cas d’une tâche de révision, vous pouvez voir le statut (ouvert ou fermé), la date d’échéance et la personne désignée. Dans le cas d’une tâche d’approbation, vous pouvez voir le statut, la résolution (approuvée ou rejetée) et la personne désignée. Dans les deux cas, si vous cliquez sur le lien de la rubrique, vous ouvrez la rubrique en mode de révision ou d’approbation.

Utilisé dansAffiche une liste d’autres rubriques ou mappages où la rubrique est utilisée.

Outre le rapport pour chaque rubrique individuelle, les administrateurs ont également accès à des informations telles que l’historique de publication d’un mappage DITA. Pour plus d’informations sur l’historique des sorties générées, consultez Affichage du statut de la tâche de génération de sortie.