【问题标题】:TOC for DITA submapDITA 子图的 TOC
【发布时间】:2023-03-25 07:03:01
【问题描述】:

我最近遇到了 DITA,并且一直在玩弄它以评估它是否适用于我们的内部文档需求。我正在尝试理解(并学习)如何正确构建文档。我的初始设置是这样的:

MainMap.ditamap:

<map>
  <mapref href="submap-1.ditamap"/>
</map>

SubMap-1.ditamap:

<map>
  <topichead navtitle="Topic Title 1">
    <topicref href="topic1.dita"/>
    <topicref href="topic2.dita"/>
  </topichead>
</map>

当我将其转换为 HTML 时,我会得到以下 html 的列表:

  • toc.html
  • mainmap.html
  • topic1.html
  • topic2.html

toc.html 看起来像这样:

目录

  • 主题标题 1
    • 主题1
    • 主题2

所以,我在这里不明白的一件事是,“主题标题 1”也是一个链接,它链接到只包含标题的 mainmap.html,使其完全无用。我希望(或希望 :))“主题标题 1”不是链接,或者,如果是,它将链接到带有子图 TOC 的页面。

  • 子图的 TOC 是否可行?
  • 我是否应该以不同的方式构建子图以使主题标题更有用?不是使用 topichead,而是使用 topicref 到 topictitle.dita 的摘要内容和类似 TOC 的列表?
    • 维护该列表会有点麻烦。有没有办法自动执行此操作?
  • 将主地图转换为多 html 页面,而将子地图转换为单 html 页面?这可能吗?

顺便说一句,我正在试用评估版 XMLMind XML Editor - Professional Edition。编辑器中关于更好的功能/可用性/负担能力的建议也是受欢迎的。 :)

感谢您的帮助!

【问题讨论】:

    标签: documentation documentation-generation xmldocument dita


    【解决方案1】:

    可以生成子图的 TOC,这取决于处理器; XMLMind XML Editor 使用 XMLmind DITA Converter 来处理 DITA。

    从语义上讲,元素应该只生成一个带有标题的新层次结构。 XMLMind DITA Converter 似乎处理这个好像是一个只有标题的主题。例如,DITA Open Toolkit (DITA-OT) 只会在 TOC 中生成标题,而不是自动生成的“概述”主题。

    同样,对于 DITA-OT,如果您使用概览主题,则会自动生成指向嵌套主题的子链接,因此您不必手动维护它们。看看 XMLMind DITA Converter 是否也是这种情况。

    WRT。 DITA 的编辑,我个人的偏好是oXygen XML Editor。它可供开发人员和技术作家使用,它正在积极开发中,而且价格实惠。

    【讨论】:

    • 谢谢!我实际上正在评估 oXygen XML Editor。正如您所提到的,我认为我也更喜欢 oXygen XML Editor,但我想我必须做一些工作来设置文档的样式。是否输出默认的 DITA-OT 样式?我将如何配置概述主题?而且,我可以应用任何模板样式吗? (我对这个领域很陌生,所以如果我没有用正确的术语或上下文说话,我深表歉意。)谢谢!
    【解决方案2】:

    要将 submap-1 的内容作为 HTML 文件查看,请将其从 ditamap 转换为主题。

    【讨论】:

      猜你喜欢
      • 2018-11-16
      • 1970-01-01
      • 2018-05-12
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-04-16
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多