文件AEM GuidesAEM Guides 文件

將AEM Assets中繼資料傳播至DITA-OT外掛程式產生的輸出

Last update: Thu Aug 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

  • 使用者

在本文中，我們將說明如何對DITA-OT外掛程式實作變更，以讀取metadata.xml （可在暫存檔案中取得），並利用AEM Guides發佈工作流程傳遞的屬性在DITA-OT外掛程式中，並在產生的輸出中設定它。

概括地說，以下是您將在本文中學習的步驟：

  • 在AEM Guides中設定ditamap輸出預設集的中繼資料
  • 在產生輸出時，存取DITA-OT暫存目錄中的此metadata.xml
  • 在DITA-OT外掛程式中實作，以讀取此​ metadata.xml，並在產生的輸出中使用可用的屬性
  • 檢查產生的輸出以檢視傳播的中繼資料

背景

透過AEM Guides，您可以使用DITA-OT外掛程式，透過已設定的外掛程式，發佈至您選擇的輸出格式，並且
您也可以將在AEM DAM中管理的資產的中繼資料傳遞至DITA-OT程式，以便在產生的輸出中使用它 — 請參閱有關如何設定ditamap/主題以透過輸出預設集傳遞中繼資料的檔案

假設

您已使用AEM Guides版本4.4.0/2024.6或更高版本進行AEM設定
您事先瞭解DITA-OT的運作方式及其目錄結構

步驟說明

在資產上設定中繼資料

使用AEM Assets中繼資料結構，您可以在AEM中為Assets建立自訂屬性欄位，使用者可以將中繼資料指派給資產。 以​ 主題 ​資產為例，其中可設定名稱為​ customprop ​的中繼資料為範例，請參考下方的熒幕擷圖：

在中繼資料編輯器中設定資產的屬性

在ditamap輸出預設集上設定中繼資料以傳遞至DITA-OT

在地圖上設定您選擇的輸出預設集，以匯出中繼資料並傳遞至DITA-OT
假設我們正在使用DITA-OT外掛程式產生HTML5輸出，例如_adobe.html_。
請參閱下方的熒幕擷圖，瞭解如何為地圖設定輸出預設集，以將中繼資料傳遞至DITA-OT外掛程式。

  1. 開啟地圖並瀏覽至此地圖的​ 輸出 ​標籤，然後開啟HTML5預設集，然後按一下​ 進階 ​標籤，在此上將轉換名稱設定為​ adobe.html （這是我們將設定並用於範例的外掛程式，您也可以定義自訂外掛程式）
  2. 設定​ 保留暫存檔案，以便能夠下載暫存檔案，並檢查metadata.xml的構成方式，您可以使用此檔案進行開發
  3. 選取您要透過metadata.xml傳遞至DITA-OT的中繼資料屬性。 在此範例中，假設我們想要傳遞​ dc：title ​和​ customprop
  4. 儲存預設集並產生輸出
  5. 使用預設集上顯示的按鈕下載暫存檔

請參閱下面的熒幕擷圖以瞭解上述步驟：
設定地圖輸出預設集以傳遞中繼資料

實作DITA-OT外掛程式

存取暫存目錄中的metadata.xml

在下載的暫存檔套件中，您會注意到metadata.xml檔案，您可以在此檢視屬性和值的結構（請參閱下面的熒幕擷圖）
metadata.xml結構和建構

瞭解metadata.xml

  • 此檔案包含所有已發佈資產的清單，每個資產具有：

    • Path專案]的DITA目錄[id屬性中的檔案路徑
    • 和​ 中繼資料 ​專案]下的中繼資料屬性值配對[清單
        <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>

存取DITA-OT外掛程式中每個資產的中繼資料

若要讓DITA-OT外掛程式讀取​ metadata.xml ​及其中可用的屬性，我們需要執行下列動作：

  • 在​ plugins.xml ​中定義自訂外掛程式設定，其中定義外掛程式初始化的引數和整合器，範例外掛程式檔案如下所示：
<?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>

  • 啟動外掛程式時：

    • 設定變數以指向metadata.xml檔案，亦即，在外掛程式下的​ integrator.xml ​中，設定屬性以定義中繼資料檔案的路徑，並且
    • 定義執行自訂xsl轉換規則的檔案，即​ args.xsl，在此案例中會指向檔案​ xsl/adobe-html5.xsl。
      請參閱下列程式碼：
    <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"/>
  • 將變數​ metadata.url ​的值傳遞至自訂XSL，以視需要加以運用，例如在現有/已建立的​ param.xml ​中，將引數傳遞至外掛程式，請參閱下方的params.xml範例檔案：
    <?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轉換檔案​ xsl/adobe-html5.xsl ​中，您可以從中繼資料檔案讀取中繼資料值，並以您想要的方式在輸出中設定它。 在此範例中，我們會新增中繼資料值至html head > meta標籤。 請參閱下列程式碼：
<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>

請參閱下方熒幕擷圖，強調上述步驟
實作dita-ot外掛程式的 步驟

測試外掛程式實作

您可以執行以下命令來測試外掛程式，使用從AEM下載的暫存檔案（具有對應內容及其metadata.xml）來測試外掛程式

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

假設您已複製目錄「DITA-OT/docsrc/samples/HTML5」下的已下載暫存檔案。
您也可以下載資源區段中提供的範例。

執行上述命令時，您可以檢查目錄「DITA-OT/bin/out」中的輸出，您可以在此處檢查針對主題「about-this-document.dita」產生的html檔案，該主題在​ 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>

部署

開發DITA-OT外掛程式之後，您就可以使用DITA-OT目錄下的​ dita —install ​命令，將此外掛程式整合到DITA-OT中，並將其部署到AEM伺服器請參閱本文章以取得更多詳細資料

資源

  1. 從範例ditamap下載的範例暫存檔 — 使用此連結下載
  2. 具有上述說明實作的DITA-OT外掛程式使用此連結下載
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178