DITA 子图的目录

发布于 2024-11-16 03:15:11 字数 1111 浏览 11 评论 0原文

我最近遇到了 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”不会是链接,或者,如果是的话,它将链接到包含子图目录的页面。

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

顺便说一句,我正在尝试评估版 XMLMind XML Editor - 专业版。也欢迎编辑提出更好的功能/可用性/经济性方面的建议。 :)

谢谢您的帮助!

I've came across DITA recently and have been fooling around with it to evaluate if it would be applicable for our internal documentation needs. I'm trying to understand(and learn) how to properly structure the document. My initial setup is something like this:

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>

When I convert this to HTML, I get list of following html:

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

toc.html looks like this:

Table of Contents

  • Topic Title 1
    • topic1
    • topic2

So, one thing I don't understand here is that, "Topic Title 1" is also a link and it is linked to mainmap.html which just contains the title, making it totally useless. I would expect(or want :)) that "Topic Title 1" would not be a link, or, if it is, it would link to a page with TOC for the submap.

  • Is TOC for submaps possible?
  • Should I structure the submaps differently so that the topic title would be more useful? Instead of using topichead, use topicref to a topictitle.dita with summary content and TOC-like list?
    • It would be a bit cumbersome to maintain that list. Is there a way to do this automatically?
  • Convert main map as multi-html page but submap as single-html page? Is that possible?

BTW, I'm trying out evaluation version XMLMind XML Editor - Professional Edition. Suggestion in editor in terms of better functionality/usability/afford-ability is also welcome. :)

Thank you for you assistance!

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

初雪 2024-11-23 03:15:11

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

从语义上讲,该元素应该只生成一个带有标题的新层次结构级别。 XMLMind DITA Converter 似乎对此进行处理,就好像它是一个仅包含标题的主题一样。例如,DITA Open Toolkit (DITA-OT) 只会在目录中生成标题,而不是自动生成的“概述”主题。

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

警告。作为 DITA 的编辑器,我个人更喜欢 oXygen XML 编辑器。它可供开发人员和技术作家使用,它正在积极开发中并且价格相当实惠。

TOCs for submaps can be generated, it's up to the processor; XMLMind XML Editor uses XMLmind DITA Converter to process DITA.

Semantically, the element should just generate a new hierarchical level with the title. XMLMind DITA Converter seems to process this as if the was a with a title-only topic. For example the DITA Open Toolkit (DITA-OT) would only generate a title in the TOC, not an autogenerated "overview" topic.

Again, for DITA-OT, if you use instead with a overview topic, child links to nested topics will be generated automatically, so you don't have to maintain them manually. See if this is the case for XMLMind DITA Converter too.

WRT. editors for DITA, my personal preference is for oXygen XML Editor. It can be used by developers as well as technical writers, it's under active development and quite affordable.

东风软 2024-11-23 03:15:11

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

To view the content of submap-1 as an HTML file, convert it from a ditamap to a topic.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文