Propagar metadatos de AEM Assets a la salida generada por el complemento DITA-OT

En este artículo explicaremos cómo implementar cambios en el complemento DITA-OT para leer el archivo metadata.xml (disponible en archivos temporales) y utilizar las propiedades, pasadas por el flujo de trabajo de publicación de AEM Guides, en los complementos DITA-OT y establecerlo en la salida generada.

En un nivel superior, a continuación se muestran los pasos que aprenderá en este artículo:

Fondo

Con AEM Guides, puede utilizar los complementos DITA-OT para publicar en los formatos de salida que desee mediante los complementos configurados.
AEM también puede pasar metadatos de los recursos administrados en DAM de la al proceso DITA-OT para usarlos en la salida generada; consulte la documentación sobre cómo configurar ditamap/topics para pasar metadatos a través del ajuste preestablecido de salida

Suposiciones

AEM Tiene una configuración de con AEM Guides versión 4.4.0/2024.6 o superior
Tiene conocimientos previos sobre el funcionamiento de DITA-OT y su estructura de directorios

Pasos explicados

Estableciendo metadatos en el recurso

Con el esquema de metadatos de AEM Assets puede crear campos de propiedad personalizados para Assets AEM en la, y los usuarios pueden asignar metadatos a los recursos. Tomando un ejemplo de un recurso topic en el que se puede establecer un metadato denominado customprop para un ejemplo, consulte la siguiente captura de pantalla:

Configuración de los metadatos en el ajuste preestablecido de salida ditamap para pasarlos a DITA-OT

Configure el ajuste preestablecido de salida que desee en el mapa para exportar metadatos y pasarlos a DITA-OT
Supongamos que estamos generando una salida de HTML5 con un complemento DITA-OT, por ejemplo adobe.html.
Consulte la captura de pantalla siguiente para comprender cómo configurar el ajuste preestablecido de salida de un mapa para pasar metadatos al complemento DITA-OT.

Consulte la siguiente captura de pantalla para comprender los pasos descritos anteriormente:

Implementación del complemento DITA-OT

Acceso al archivo metadata.xml en el directorio temporal

En el paquete de archivos temporales descargados, verá un archivo metadata.xml donde puede ver la estructura de las propiedades y los valores (véase la captura de pantalla siguiente)

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

Acceso a los metadatos de cada recurso en el complemento DITA-OT

Para que el complemento DITA-OT lea metadata.xml y las propiedades disponibles, debemos hacer lo siguiente:

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

Consulte la captura de pantalla siguiente para resaltar los pasos anteriores

Prueba de la implementación del complemento

AEM Puede probar el complemento ejecutando el siguiente comando para probarlo con los archivos temporales descargados de (que tiene contenido de mapa y sus metadatos.xml), que se descargan de la aplicación y que se descargan de la aplicación.

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

Suponiendo que ha copiado los ficheros temporales descargados en el directorio "DITA-OT/docsrc/samples/HTML 5".
También puede descargar el ejemplo que aparece en la sección de recursos a continuación.

Cuando se ejecute el comando anterior, puede comprobar el resultado en el directorio "DITA-OT/bin/out", donde puede comprobar los archivos html generados para el tema "about-this-document.dita", que tendrá los metadatos personalizados en el 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>

Implementación

AEM Una vez que haya desarrollado el complemento DITA-OT, puede integrarlo en DITA-OT mediante el comando dita —install del directorio DITA-OT e implementarlo en el servidor de la consulte este artículo para obtener más información

Recursos