Propagare i metadati di AEM Assets all’output generato dal plug-in DITA-OT

In questo articolo verrà illustrato come implementare le modifiche al plug-in DITA-OT per leggere il file metadata.xml (disponibile nei file temporanei) e utilizzare le proprietà passate dal flusso di lavoro di pubblicazione di AEM Guides nei plug-in DITA-OT e impostarle nell'output generato.

Ad alto livello, di seguito sono riportati i passaggi che imparerai in questo articolo:

Informazioni di base

Con AEM Guides, puoi utilizzare i plug-in DITA-OT per pubblicare nei formati di output scelti utilizzando i plug-in configurati e
è inoltre possibile passare i metadati delle risorse gestite in AEM DAM al processo DITA-OT per utilizzarli nell'output generato. Vedere la documentazione in configurazione di ditamap/topic per la trasmissione dei metadati tramite il predefinito di output

Presupposti

Hai una configurazione AEM con AEM Guides versione 4.4.0/2024.6 o superiore
Conoscere in precedenza il funzionamento di DITA-OT e la relativa struttura di directory

Passaggi spiegati

Impostazione dei metadati sulla risorsa

Con lo schema metadati di AEM Assets puoi creare campi di proprietà personalizzati per Assets nell’AEM e gli utenti possono assegnare metadati alle risorse. Prendi un esempio di una risorsa topic in cui è possibile impostare un metadati denominato customprop per un esempio. Fai riferimento alla schermata seguente:

Configurazione dei metadati nel predefinito di output ditamap da passare a DITA-OT

Configurate il predefinito di output desiderato sulla mappa per esportare i metadati e passare a DITA-OT
Supponiamo di generare l'output di HTML5 utilizzando un plug-in DITA-OT, ad esempio adobe.html.
Vedi la schermata seguente per capire come configurare il predefinito di output per una mappa per passare metadati al plug-in DITA-OT.

Fai riferimento alla schermata seguente per comprendere i passaggi riportati sopra:

Implementazione del plug-in DITA-OT

Accesso a metadata.xml nella directory temporanea

Nel pacchetto dei file temporanei scaricati, noterai un file metadata.xml in cui puoi visualizzare la struttura delle proprietà e dei valori (vedi la schermata seguente).

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

Accesso ai metadati per ogni risorsa nel plug-in DITA-OT

Affinché il plug-in DITA-OT possa leggere il file metadata.xml e le proprietà disponibili in esso, è necessario effettuare le seguenti operazioni:

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

La schermata seguente evidenzia i passaggi precedenti

Verifica dell’implementazione del plug-in

Puoi testare il plug-in eseguendo il seguente comando per testarlo con i file temporanei scaricati da AEM (che hanno il contenuto della mappa e i relativi metadati.xml)

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

Supponendo di aver copiato i file temporanei scaricati nella directory "DITA-OT/docsrc/samples/HTML5".
Puoi anche scaricare l’esempio fornito nella sezione risorse di seguito.

Quando il comando precedente viene eseguito, è possibile controllare l'output nella directory "DITA-OT/bin/out", dove è possibile controllare i file html generati per l'argomento "about-this-document.dita" che presenterà i metadati personalizzati nell'elemento 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>

Distribuzione

Dopo aver sviluppato il plug-in DITA-OT, è possibile integrarlo in DITA-OT utilizzando il comando dita —install nella directory DITA-OT e distribuirlo al server AEM fare riferimento a questo articolo per ulteriori dettagli

Riferimenti