Propagation des métadonnées AEM Assets vers la sortie générée par le module externe DITA-OT

Dans cet article, nous expliquerons comment mettre en oeuvre les modifications apportées au module externe DITA-OT pour lire le fichier metadata.xml (disponible dans les fichiers temporaires) et utiliser les propriétés, transmises par le processus de publication AEM Guides, dans les modules externes DITA-OT et les définir dans la sortie générée.

À un niveau élevé, vous trouverez ci-dessous les étapes que vous apprendrez dans cet article :

Contexte

Avec AEM Guides, vous pouvez utiliser des modules externes DITA-OT pour publier dans les formats de sortie de votre choix à l’aide des modules externes configurés, et
vous pouvez également transmettre des métadonnées des ressources gérées dans AEM DAM au processus DITA-OT pour les utiliser dans la sortie générée. consultez la documentation sur la configuration de ditamap/rubriques pour transmettre des métadonnées par le biais du paramètre prédéfini de sortie

Hypothèses

Vous disposez d’une configuration AEM avec AEM Guides version 4.4.0/2024.6 ou ultérieure.
Vous connaissez déjà le fonctionnement de DITA-OT et sa structure de répertoires.

Description des étapes

Définition des métadonnées sur la ressource

Avec le schéma de métadonnées AEM Assets, vous pouvez créer des champs de propriété personnalisés pour Assets dans AEM, et les utilisateurs peuvent affecter des métadonnées aux ressources. Prenons l’exemple d’une ressource topic où une métadonnée nommée customprop peut être définie pour un exemple. Consultez la capture d’écran ci-dessous :

Configuration des métadonnées sur le paramètre prédéfini de sortie ditamap à transmettre à DITA-OT

Configuration du paramètre prédéfini de sortie de votre choix sur la carte pour exporter des métadonnées et les transmettre à DITA-OT
Supposons que nous générions une sortie HTML5 à l’aide d’un module externe DITA-OT comme suit : adobe.html.
Voir la capture d’écran ci-dessous pour comprendre comment configurer le paramètre prédéfini de sortie pour une carte afin de transmettre des métadonnées au module externe DITA-OT.

Reportez-vous à la capture d’écran ci-dessous pour comprendre les étapes ci-dessus :

Mise en oeuvre du module externe DITA-OT

Accès au fichier metadata.xml dans un répertoire temporaire

Dans le package de fichiers temporaires téléchargé, vous remarquerez un fichier metadata.xml dans lequel vous pouvez voir la structure des propriétés et des valeurs (voir la capture d’écran ci-dessous).

Présentation de metadata.xml

        <Path id="topics\about-this-document.dita">
            <sourceProps>
                ...
            </sourceProps>
            <metadata>
                <meta isArray="false" key="dc:title">About This Document</meta>
                <meta isArray="false" key="customprop">customval</meta>
            </metadata>
        </Path>

Accès aux métadonnées de chaque ressource dans le module externe DITA-OT

Pour que le module externe DITA-OT lise le metadata.xml et les propriétés qui y sont disponibles, nous devons procéder comme suit :

<?xml version="1.0" encoding="UTF-8"?>
<plugin id="com.adobe.html">
    <require plugin="org.dita.html5"/>
    <feature extension="dita.conductor.transtype.check" value="adobe.html"/>
    <feature extension="ant.import" file="integrator.xml"/>
    <feature extension="dita.conductor.html5.param" file="params.xml"/>
    <feature extension="package.version" value="2024.1"/>
</plugin>

    <property name="adobe.html.xsl.dir" value="${dita.plugin.com.adobe.html.dir}${file.separator}xsl${file.separator}"/>
    <property name="args.xsl" location="${adobe.html.xsl.dir}adobe-html5.xsl" />
    <dirname property="input.dirname" file="${args.input}"/>
    <makeurl file="${input.dirname}/metadata.xml" property="metadata.url"/>

    <?xml version="1.0" encoding="UTF-8"?>
    <params xmlns:if="ant:if">
        <param name="metadata.url" expression="${metadata.url}" if:set="metadata.url"/>
    </params>

<xsl:import href="plugin:org.dita.html5:xsl/dita2html5.xsl"/>
    <xsl:param name="metadata.url"/>
    <xsl:template name="copyright">
        <xsl:if test="doc-available( $metadata.url )">
            <xsl:variable name="docName" select="tokenize( base-uri(), '/' )[ last() ]"/>
            <xsl:variable name="doc" select="doc( $metadata.url )"/>
            <xsl:for-each select="$doc//Path[ ends-with( @id, concat( '\', $docName ) ) ]/metadata/meta">
                <meta name="{ @key }" content="{ . }"/>
            </xsl:for-each>
        </xsl:if>
    </xsl:template>

Reportez-vous à la capture d’écran ci-dessous pour mettre en évidence les étapes ci-dessus

Test de l’implémentation du module externe

Vous pouvez tester le module externe en exécutant la commande suivante pour le tester avec les fichiers temporaires téléchargés à partir d’AEM (qui comporte le contenu map et son fichier metadata.xml).

./dita --input=docsrc/samples/HTML5/aem_forms_documentation.ditamap --format=adobe.html

En supposant que vous ayez copié les fichiers temporaires téléchargés dans le répertoire "DITA-OT/docsrc/samples/HTML5".
Vous pouvez également télécharger l’exemple donné dans la section des ressources ci-dessous.

Lorsque la commande ci-dessus est exécutée, vous pouvez vérifier la sortie dans le répertoire "DITA-OT/bin/out", où vous pouvez vérifier les fichiers HTML générés pour la rubrique "about-this-document.dita" qui contiendra les métadonnées personnalisées dans l’élément head .

<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta charset="UTF-8">
    <meta name="copyright" content="(C) Copyright 2024">
    <meta name="DC.format" content="HTML5">
    <meta name="DC.identifier" content="GUID-f193ea85-989d-4d80-99e2-2f5dea3d5310">
    <meta name="DC.language" content="en-US">
    <meta name="dc:title" content="About This Document">
    <meta name="customprop" content="customval">
    <title>About This Document</title>
</head>

Déploiement

Une fois que vous avez développé le module externe DITA-OT, vous pouvez l’intégrer dans DITA-OT à l’aide de la commande dita —install sous le répertoire DITA-OT, et le déployer sur le serveur AEM reportez-vous à cet article pour plus de détails

Ressources