使用自訂DITA-OT與DITA專業化 id181GAJ0005Z

DITA Open Toolkit (DITA-OT)是一組以Java為基礎的開放原始碼工具,可處理DITA map和主題內容。 AEM Guides可讓您輕鬆匯入及使用自訂DITA-OT外掛程式。 匯入後,AEM Guides可設定為使用自訂DITA-OT外掛程式來產生任何格式的輸出。 在產生輸出時,只要選取DITA-OT選項,AEM Guides就會使用自訂DITA-OT外掛程式來產生所需的輸出。

如果您想在發佈任何輸出時處理Ant引數,AEM Guides會為您提供簡單的方法。 您可以指定要使用哪些Ant引數,然後由發佈程式處理。

NOTE
AEM Guides隨附DITA-OT版本3.3.2。不過,AEM Guides支援DITA-OT 1.7版及更新版本。 如需DITA-OT版本的完整清單,請參閱DITA-OT版本
TIP
如需使用自訂DITA-OT外掛程式的最佳作法,請參閱最佳作法指南中的​ DITA-OT設定檔 ​和​ 使用自訂DITA-OT ​區段。

使用自訂DITA-OT外掛程式 id181NH1020L7

有兩種方式可使用自訂DITA-OT外掛程式進行發佈。 第一種方法是將自訂DITA-OT外掛程式上傳至AEM存放庫。 另一種方法是在伺服器上儲存自訂DITA-OT外掛程式、建立設定檔並在設定檔中提供自訂DITA-OT外掛程式的位置。

依預設,AEM Guides附帶預先設定的設定檔,其中包含用於編輯和發佈內容的預設範本設定。 您可以使用在編輯檔案時使用的自訂範本來建立自訂設定檔,並使用自訂DITA-OT外掛程式來發佈內容。

AEM Guides提供的預設DITA-OT套件附帶Apache FOP XSL-FO處理器,該處理器不支援轉譯MathML方程式。 如果您在內容中使用MathML方程式,請確定您已整合Apache FOP適用的MathML轉譯引擎外掛程式,或使用其他XSL-FO處理器。

IMPORTANT
如果您已將AEM Guides從2.2版升級至2.5.1或2.6版,則透過Configuration Manager進行的所有變更都會自動挑選並儲存在「預設設定檔」中。

執行以下步驟,將自訂DITA-OT外掛程式上傳至AEM存放庫:

  1. 登入AEM並開啟CRXDE Lite模式。

  2. 下載DITA-OT.ZIP檔案。

    DITA-OT.ZIP檔案的位置是/libs/fmdita/dita_resources/DITA-OT.zip

  3. 解壓縮伺服器上zip檔案的內容。

  4. 使用DITA-OT外掛程式整合器機制,將新版DITA-OT與自訂DITA-OT外掛程式整合。

    note note
    NOTE
    外掛程式ZIP檔案中的類別路徑分隔符號取決於作業系統,這表示如果您的伺服器託管於Windows上,則類別路徑分隔符號將不同於Linux上使用的類別。 如需手動整合外掛程式的詳細資訊,請參閱DITA-OT檔案中的​ 手動安裝外掛程式 ​主題。
  5. 再次建立ZIP檔案,保留相同的名稱(DITA-OT.ZIP)和資料夾結構。

  6. 將更新後的ZIP檔案上傳回AEM存放庫。

    上傳ZIP檔案之前,請先確認下列檢查:

    • 在Mac/Linux作業系統上執行整合程式\(以安裝自訂外掛程式\),以避免檔案分隔符號發生問題,因為Windows和Linux作業系統有不同的檔案分隔符號,所以在Mac/Linux作業系統上整合的外掛程式會與Windows和Linux安裝程式相容。
    • 確定DITA-OT.ZIP檔案包含名為「DITA-OT」的資料夾,其中包含所有相關的外掛程式和檔案。
    • 檢查您建立的DITA-OT.ZIP檔案是否為mimeType: "nt:file" (這與上傳至AEM時的ZIP檔案主要型別相對應)。 使用WebDAV工具或程式碼部署,將此ZIP檔案上傳至AEM中的所需路徑。 (請勿使用AEM封裝管理員來部署此ZIP檔案,因為此ZIP不是AEM內容封裝,而只是封存檔案。)
    note note
    NOTE
    建議不要覆寫預設的DITA-OT套件。 您應該將包含外掛程式的自訂DITA-OT套件上傳到apps資料夾下的其他位置。
  7. 開啟預設的DITA設定檔進行編輯並儲存\(不進行任何更新\),以使變更生效。

執行以下步驟來建立新的設定檔,並將其設定為使用儲存在伺服器上的自訂DITA-OT外掛程式:

  1. 將自訂DITA-OT外掛程式儲存在伺服器上。

    note note
    NOTE
    儲存自訂DITA-OT外掛程式的資料夾結構應為: \*<parent-folder\>*\DITA-OT
  2. 按一下頂端的Adobe Experience Manager連結,然後選擇​ 工具

  3. 從工具清單中選取​ 指南

  4. 按一下​ DITA設定檔 ​圖磚。

    note note
    NOTE
    預設設定檔資訊會顯示在「設定檔」頁面上。 如果您已將AEM Guides從2.2版升級至2.5.1或2.6版,則透過Configuration Manager進行的所有變更都會自動挑選並儲存在「預設設定檔」中。
  5. 您可以選擇編輯「預設設定檔」、建立新設定檔,或從「預設設定檔」複製設定以建立新設定檔。

    note note
    NOTE
    您可以更新預設設定檔,但無法刪除它。 但是,您可以編輯和刪除您建立的所有新設定檔。
  6. 設定下列屬性以使用自訂DITA-OT外掛程式:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 18-row-2 19-row-2
    屬性名稱 說明
    設定檔屬性
    設定檔名稱 為此設定檔提供唯一名稱。
    重複使用輸出 \(選擇性\) ​如果您的設定檔是以現有的設定檔為基礎,請選取此選項。 選取此選項可確保AEM Guides不會再次擷取DITA-OT套件的內容,並重複使用現有的DITA-OT套件。
    設定檔擷取路徑 (Optional) ​指定DITA-OT保留在磁碟上的路徑。 依預設,AEM Guides會將DITA-OT套件組合在其存放庫中,並透過此路徑擷取到磁碟上。
    注意 ​您可以使用任何現有的系統變數或屬性來定義此路徑。 如需詳細資訊,請參閱DITA-OT環境變數屬性的描述。
    指派的路徑 \(選擇性\)指定此設定檔適用的內容存放庫路徑。 您可以指定多個位置。
    DITA-OT屬性
    DITA-OT逾時 \(選擇性\)指定AEM Guides等待DITA-OT外掛程式回應的時間\(以秒為單位)。 如果在指定時間內未收到任何回應,AEM Guides會終止發佈工作,且工作會標籤為失敗。 此外,輸出產生記錄檔中也有失敗記錄檔。
    預設值: 300秒\(5分鐘\)
    dita-OTPDF引數 指定由自訂DITA-OT外掛程式處理以產生PDF輸出的命令列引數。 對於所有自訂DITA-OT設定檔,請指定下列命令列引數: -lib plugins/org.dita.pdf2.fop/lib/
    DITA-OT AEM引數 \(選擇性\)指定自訂DITA-OT外掛程式處理用來產生AEM Site輸出的自訂命令列引數。
    DITA-OT程式庫路徑 \(選擇性\)指定DITA-OT外掛程式的其他程式庫路徑。
    DITA-OT建置XML \(選擇性\)指定自訂DITA-OT外掛程式隨附的自訂Ant建置指令碼路徑。 此路徑相對於檔案系統上的DITA-OT目錄。
    DITA-OT Ant指令碼資料夾 \(可選\)指定DITA-OT Ant指令碼資料夾的路徑。 此路徑相對於檔案系統上的DITA-OT目錄。
    dita-OT環境變數 \(選擇性\) ​指定要傳遞至DITA-OT處理程式的環境變數。 依預設,AEM Guides新增四個變數 — ANT_OPTSANT_HOMEPATHCLASSPATH
    您可以重複使用任何現有的系統環境變數或屬性來建置新的環境變數。 例如,如果您在系統中定義了JAVA_HOME系統變數,並且想要定義名為JAVA_BIN的新環境變數(使用JAVA_HOME建置)。 然後,您可以將JAVA_BIN的定義新增為:
    JAVA_BIN= ${JAVA_HOME}/bin
    注意 ​您也可以使用Java系統屬性來建置環境變數。 例如,如果AEM啟動指令碼將Java系統屬性java.io.tmpdir定義為暫存目錄,您可以使用此屬性將新變數定義為: ${java.io.tmpdir}/fmdita/dita_ot
    重要 ​若要重複使用任何現有的系統變數或屬性,必須將其括在${}內。
    覆寫DITA-OT輸出 (Optional) ​如果選取此選項,您可以指定本機系統上可用的DITA-OT套件,以使用DITA-OT產生輸出。 此設定是在ConfigManager啟動時設定。
    如果要指定儲存在AEM伺服器上的DITA-OT封裝路徑,請取消選取此選項。
    AEM DITA-OT Zip路徑/本機DITA-OT目錄路徑 根據您在「覆寫DITA-OT輸出」中所做的選擇,指定儲存自訂DITA-OT.zip檔案的完整路徑。 這可能是您的AEM存放庫或本機系統中的路徑。
    DITA-OT外掛程式路徑 自訂外掛程式的路徑。 此外掛程式會自動與主要DITA-OT套件整合。
    整合目錄 (Optional) AEM儲存庫中自訂DTD和XSD catalog.xml檔案的路徑。 只有在DITA-OT套件中遺失目錄時,才應提供此專案。 這些目錄會作為外掛程式自動與主要DITA-OT整合。
    新增系統ID目錄 \(選擇性\)只有在目錄中有遺失的公用ID專案,或DITA檔案僅使用相對於其上傳來源伺服器路徑的系統ID時,才選取此選項。
    DITA-OT暫時路徑 (Optional) ​指定複製DITA檔案以供處理的暫存位置。 在DITA-OT處理檔案之前,會先在此暫存位置複製檔案。 預設的暫存位置為:
    注意 ​您可以使用任何現有的系統變數或屬性來定義此路徑。 如需詳細資訊,請參閱DITA-OT環境變數屬性的描述。
    note note
    NOTE
    AEM Guides安裝程式會建立兩個環境變數,可用來指定自訂DITA-OT外掛程式檔案的路徑。 這些環境變數為:DITAOT_DIR,包含檔案系統上DITA-OT目錄的路徑;以及DITAMAP_DIR,包含檔案系統擷取DITA map內容的路徑。
  7. 按一下​ 完成 ​以儲存設定檔。

NOTE
您可以將自訂DITA設定檔匯出為套件,並上傳至其他AEM Guides執行個體以節省時間。 如需詳細資訊,請參閱附錄

整合DITA專業化 id211MB0E00XA

DITA專業化是透過新增元素或移除現有元素來建立新DITA結構的程式。 若要建立新的DITA元素,您可以以現有DITA元素為基底,並根據編寫需求對其進行修改。 本質上,DITA專業化可讓您建立符合業務需求的自訂資訊模型,同時保留現有DITA架構的優點。

您可以使用設定檔功能來儲存自訂DITA專業化設定。 接著,您就可以在編寫及發佈自訂DITA內容時,使用這些設定。 AEM Guides可讓您在自訂DTD/XSD中使用公用ID和系統ID。

NOTE
AEM Guides Web Editor不支援XSD。

執行以下步驟來建立新的設定檔,並將其設定為使用專門的DTD和XSD AEM Guides:

  1. 在本機電腦上建立包含專用DTD和XSD的專用資料夾。

  2. catalog.xml檔案中指定DTD詳細資料,這些詳細資料也必須包含在專業化資料夾中。

    note note
    NOTE
    若是DITA 1.3,AEM存放庫中DTD catalog.xml檔案的預設位置為: /libs/fmdita/dita_resources/DITA-1.3/dtd/catalog.xml
  3. catalog.xml檔案中指定XSD詳細資料,這些詳細資料也必須包含在特殊化資料夾中。

    note note
    NOTE
    若是DITA 1.3,AEM存放庫中XSD catalog.xml檔案的預設位置為: /libs/fmdita/dita_resources/DITA-1.3/xsd/catalog.xml
  4. 上傳資料夾至下列位置:

    /apps/fmdita/dita_resources

  5. 按一下頂端的Adobe Experience Manager連結,然後選擇​ 工具

  6. 從工具清單中選取​ 指南

  7. 按一下​ DITA設定檔 ​圖磚。

    note note
    NOTE
    預設設定檔資訊會顯示在「設定檔」頁面上。 如果您已將AEM Guides從2.2版升級至2.5.1或2.6版,則透過Configuration Manager進行的所有變更都會自動挑選並儲存在「預設設定檔」中。
  8. 您可以選擇編輯「預設設定檔」、建立新設定檔,或從「預設設定檔」複製設定以建立新設定檔。

    note note
    NOTE
    您無法刪除預設設定檔。 但是,您可以編輯和刪除您建立的所有新設定檔。
  9. 在​ 結構描述 > 目錄 ​設定中,指定您AEM存放庫中自訂DTD和XSD catalog.xml檔案的路徑。

    note note
    NOTE
    如果您使用自訂結構描述,則必須在​ 整合目錄 ​選項中定義AEM儲存庫中自訂DTD和XSD catalog.xml檔案的路徑。
  10. 選取​ 新增系統識別碼目錄 ​選項。

    note note
    NOTE
    僅當目錄中有遺失的公用ID專案,或DITA檔案僅使用相對於其上傳來源本機檔案路徑的系統ID時,才選取此選項。

    如需「設定檔」頁面上其他屬性的詳細資訊,請參閱使用自訂DITA-OT外掛程式區段的步驟6中的屬性表格。

  11. 按一下​ 完成 ​以儲存設定檔。

NOTE
您可以將自訂DITA設定檔匯出為套件,並上傳至其他AEM Guides執行個體以節省時間。 如需詳細資訊,請參閱Appendix.md
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178