Propagar metadados do AEM Assets para saída gerada pelo plug-in DITA-OT

Neste artigo, explicaremos como implementar alterações no plug-in DITA-OT para ler o arquivo metadata.xml (disponível em arquivos temporários) e utilizar as propriedades, transmitidas pelo fluxo de trabalho de publicação do AEM Guides, em plug-ins DITA-OT e configurá-las na saída gerada.

Em um nível superior, abaixo estão as etapas que você aprenderá neste artigo:

Fundo

Com o AEM Guides, você pode usar plug-ins DITA-OT para publicar em formatos de saída de sua escolha usando os plug-ins configurados e
você também pode passar metadados dos ativos gerenciados no DAM AEM para o processo DITA-OT para usá-los na saída gerada. consulte a documentação sobre como configurar ditamap/tópicos para passar metadados pela predefinição de saída

Suposições

Você tem uma configuração do AEM com a versão do AEM Guides 4.4.0/2024.6 ou superior
Você tem conhecimento prévio sobre como o DITA-OT funciona e sua estrutura de diretórios

Etapas explicadas

Configuração de metadados no ativo

Com o Esquema de metadados do AEM Assets, é possível criar campos de propriedade personalizados para o Assets no AEM, e os usuários podem atribuir metadados aos ativos. Tomando um exemplo de um ativo tópico onde um metadado chamado customprop pode ser definido para um exemplo - consulte a captura de tela abaixo:

Configuração dos metadados na predefinição de saída ditamap a serem transmitidos para o DITA-OT

Configure a predefinição de saída de sua escolha no mapa para exportar metadados e passar para o DITA-OT
Digamos que estamos gerando saída de HTML5 usando um plug-in DITA-OT, diga adobe.html.
Consulte a captura de tela abaixo para entender como configurar a predefinição de saída de um mapa para transmitir metadados ao plug-in DITA-OT.

Consulte a captura de tela abaixo para entender as etapas fornecidas acima:

Implementação do plugin DITA-OT

Acessando o arquivo metadata.xml no diretório temporário

No pacote de arquivos temporários baixados, você notará um arquivo metadata.xml onde é possível ver a estrutura das propriedades e dos valores (veja a captura de tela abaixo)

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

Acesso aos metadados de cada ativo no plug-in DITA-OT

Para que o plug-in DITA-OT leia o metadata.xml e as propriedades disponíveis nele, é necessário fazer o seguinte:

<?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 a captura de tela abaixo destacando as etapas acima

Teste da implementação do plug-in

Você pode testar o plug-in executando o seguinte comando para testá-lo com os arquivos temporários baixados do AEM (que tem conteúdo de mapa e seu metadata.xml)

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

Supondo que você tenha copiado os arquivos temporários baixados no diretório "DITA-OT/docsrc/samples/HTML5".
Você também pode baixar a amostra fornecida na seção de recursos abaixo.

Quando o comando acima for executado, você poderá verificar a saída no diretório "DITA-OT/bin/out", onde poderá verificar os arquivos html gerados para o tópico "about-this-document.dita" que terá os metadados personalizados no 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>

Implantação

Depois de desenvolver o plug-in DITA-OT, você pode integrá-lo ao DITA-OT usando o comando dita —install no diretório DITA-OT e implantá-lo no servidor AEM consulte este artigo para obter mais detalhes

Recursos