文档AEM GuidesAEM Guides 文档

使用自定义DITA-OT和DITA专业化 id181GAJ0005Z

Last update: Fri Jul 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 有经验的
  • 管理员

DITA Open Toolkit (DITA-OT)是一组基于Java的开源工具，用于处理DITA映射和主题内容。 通过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插件上载到AEM存储库，可以使用自定义DITA-OT插件进行发布。 默认情况下，AEM Guides附带预配置的配置文件，其中包含用于编辑和发布内容的默认模板的配置。 您可以使用编辑文档时使用的自定义模板以及自定义DITA-OT插件创建自定义配置文件以发布内容。

AEM Guides提供的默认DITA-OT包附带了Apache FOP XSL-FO处理器，该处理器不支持渲染MathML方程组。 如果在内容中使用MathML公式，请确保已集成适用于Apache FOP的MathML渲染引擎插件，或使用不同的XSL-FO处理器。

执行以下步骤以将自定义DITA-OT插件上载到AEM存储库：

  1. 从欢迎电子邮件中共享的链接下载DITA-OT.zip文件。

  2. 解压缩系统上zip文件的内容。

  3. 使用DITA-OT插件集成器机制将DITA-OT的新版本与您的自定义DITA-OT插件集成。

  4. 再次创建ZIP文件，保留相同的名称(DITA-OT.ZIP)和文件夹结构。

  5. 将更新后的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包。 您应该上载包含插件/var/dxml/dita_resources/dita-ot文件夹的自定义DITA-OT包。 您也可以使用Cloud Manager管道来执行此操作。有关更多详细信息，请参阅AEM文档中的部署到AEM as a Cloud Service。

  6. 您可以选择编辑默认配置文件，创建新配置文件，或者从默认配置文件中复制设置以创建新配置文件。

    note note
    NOTE
    您可以更新默认配置文件，但无法删除它。 但是，您可以编辑和删除您创建的所有新配置文件。

  7. 配置以下属性以使用自定义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包。
    配置文件提取路径 \（可选\） ​指定在磁盘上保留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_OPTS、ANT_HOME、PATH和CLASSPATH。
    您可以重复使用任何现有系统环境变量或属性来生成新的环境变量。 例如，如果您在系统中定义了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输出 选择是否应覆盖DITA-OT输出。 保持选中此选项。
    AEM DITA-OT Zip路径 指定自定义DITA-OT.zip文件存储在AEM存储库中的完整路径。
    DITA-OT插件路径 自定义插件的路径。 此插件自动与主DITA-OT包集成。
    集成目录 \（可选\）AEM存储库中自定义DTD和XSD catalog.xml文件的路径。 仅当DITA-OT包中缺少目录时才应提供此项。 这些目录作为插件自动与主DITA-OT集成。
    添加系统ID目录 \（可选\）仅当目录中有缺少的公共ID条目，或者DITA文件仅使用相对于从中上载它们的服务器路径的系统ID时，才选择此选项。
    DITA-OT临时路径 复制DITA文件以进行处理的临时位置。 在DITA-OT处理文件之前，这些文件将复制到此临时位置。 默认情况下，临时存储位置为：
    <*AEM-Install*>/crx-quickstart/profiles/ditamaps
    重要信息： ​不能更改默认路径。
    note note
    NOTE
    AEM Guides安装程序会创建两个环境变量，您可以使用这两个环境变量指定自定义DITA-OT插件文件的路径。 这些环境变量为： DITAOT\_DIR，其中包含文件系统上DITA-OT目录的路径；以及DITAMAP\_DIR，其中包含文件系统中提取DITA映射内容的路径。

  8. 单击​ 完成 ​以保存配置文件。

集成DITA专业化 id211MB0E00XA

DITA专业化是通过添加新元素或删除现有元素来创建新DITA结构的过程。 要创建新的DITA元素，可将现有DITA元素作为基础，并根据创作要求对其进行修改。 实质上，DITA专业化允许您创建符合业务要求的自定义信息模型，同时保留现有DITA体系结构的好处。

您可以使用配置文件功能存储自定义DITA专业化设置。 然后，您可以在创作和发布自定义DITA内容时使用这些设置。 AEM Guides允许您在自定义DTD/XSD中使用公共ID和系统ID。

NOTE
AEM Guides Web Editor不支持XSD。

执行以下步骤可创建新配置文件并将其配置为在AEM Guides中使用专门的DTD和XSD：

  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. 将文件夹上传到以下位置：

    /var/dxml/dita_resources

  5. 单击顶部的Adobe Experience Manager链接，然后选择​ 工具。

  6. 从工具列表中选择​ 参考线。

  7. 单击​ DITA配置文件 ​磁贴。

  8. 您可以选择编辑默认配置文件，创建新配置文件，或者从默认配置文件中复制设置以创建新配置文件。

    note note
    NOTE
    您无法删除默认配置文件。 但是，您可以编辑和删除您创建的所有新配置文件。

  9. 在​ 架构 > 目录 ​设置中，指定AEM存储库中自定义DTD和XSD catalog.xml文件的路径。

  10. 选择​ 添加系统ID目录 ​选项。

    note note
    NOTE
    仅当目录中缺少公共ID条目，或者DITA文件仅使用与从中上载它们的本地文件路径相关的系统ID时，才选择此选项。

    有关“配置文件”页面上其他属性的更多信息，请参阅使用自定义DITA-OT插件部分的步骤6中的属性表。

  11. 单击​ 完成 ​以保存配置文件。

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178