Übertragen von AEM Assets-Metadaten in eine vom DITA-OT-Plug-in generierte Ausgabe

In diesem Artikel erfahren Sie, wie Sie Änderungen am DITA-OT-Plug-in implementieren, um die „metadata.xml“ (verfügbar in temporären Dateien) zu lesen die vom AEM Guides-Veröffentlichungs-Workflow übergebenen Eigenschaften in DITA-OT-Plug-ins zu verwenden und in der generierten Ausgabe festzulegen.

Im Folgenden finden Sie allgemeine Schritte, die Sie in diesem Artikel lernen werden:

Hintergrund

Mit AEM Guides können Sie DITA-OT-Plug-ins verwenden, um mithilfe der konfigurierten Plug-ins in Ausgabeformaten Ihrer Wahl zu veröffentlichen, und
Sie können auch Metadaten der im AEM-DAM verwalteten Assets an den DITA-OT-Prozess übergeben, um sie in der generierten Ausgabe zu verwenden. Weitere Informationen finden Sie in der Dokumentation unter Einrichten von DITA-Zuordnungen/Themen zum Übergeben von Metadaten über eine Ausgabevorgabe

Annahmen

Sie haben ein AEM-Setup mit AEM Guides Version 4.4.0/2024.6 oder höher
Sie verfügen über Vorkenntnisse zur Funktionsweise von DITA-OT und zur Verzeichnisstruktur

Schritte erklärt

Festlegen von Metadaten für das Asset

Mit dem AEM Assets-Metadatenschema können Sie benutzerdefinierte Eigenschaftsfelder für die Assets in AEM erstellen, wobei Benutzerinnen und Benutzer den Assets Metadaten zuweisen können. Nehmen Sie ein Beispiel für ein Thema-Asset, bei dem eine Metadaten mit dem Namen customprop für ein Beispiel festgelegt werden kann. Siehe Screenshot unten:

Konfigurieren der Metadaten in der DITA-Map-Ausgabevorgabe, die an DITA-OT übergeben werden sollen

Konfigurieren Sie eine Ausgabevorgabe Ihrer Wahl auf der Zuordnung, um Metadaten zu exportieren und an DITA-OT zu übergeben
Angenommen, wir generieren die HTML5-Ausgabe mit einem DITA-OT-Plug-in, z. B_„adobe.html_.
Im folgenden Screenshot erfahren Sie, wie Sie die Ausgabevorgabe für eine Zuordnung konfigurieren, um Metadaten an das DITA-OT-Plug-in zu übergeben.

Die oben beschriebenen Schritte werden im folgenden Screenshot erläutert:

Implementieren des DITA-OT-Plug-ins

Zugriff auf „metadata.xml“ im temporären Verzeichnis

Im heruntergeladenen Paket mit temporären Dateien fällt eine Datei „metadata.xml“ auf, in der die Struktur der Eigenschaften und Werte sichtbar ist (siehe Screenshot unten)

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

Zugriff auf die Metadaten der einzelnen Assets im DITA-OT-Plug-in

Damit das DITA-OT-Plug-in die metadata.xml) und darin verfügbaren Eigenschaften lesen kann, müssen wir folgende Schritte durchführen:

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

Die obigen Schritte werden im Folgenden hervorgehoben

Testen der Plug-in-Implementierung

Sie können das Plug-in testen, indem Sie den folgenden Befehl ausführen, um es mit den temporären Dateien zu testen, die von AEM heruntergeladen wurden (dort sind Map-Inhalte und die zugehörige metadata.xml vorhanden)

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

Angenommen, Sie haben die heruntergeladenen temporären Dateien in das Verzeichnis „DITA-OT/docsrc/samples/HTML5“ kopiert.
Sie können auch das Beispiel herunterladen, das im Abschnitt „Ressourcen“ unten angegeben ist.

Wenn der obige Befehl ausgeführt wird, können Sie die Ausgabe im Verzeichnis „DITA-OT/bin/out“ überprüfen, wo Sie die für das Thema „about-this-document.dita“ generierten HTML-Dateien überprüfen können. Diese enthalten die benutzerdefinierten Metadaten im head-Element

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

Bereitstellung

Sobald Sie das DITA-OT-Plug-in entwickelt haben, können Sie es mit dem Befehl dita —install unter dem DITA-OT-Verzeichnis in das DITA-OT-Plug-in integrieren und auf dem AEM-Server bereitstellen weitere Informationen finden Sie in diesem Artikel

Ressourcen