我最近开始使用 DocBook XML 来编写我的文档。
从好的方面来说,它是纯文本格式。您可以将一个大文档分成多个文件,并使用节点将它们全部合并到一本书中。目录和索引是自动生成的。文档内链接(在任意文本内,指向章节或部分)非常容易。只需按一下按钮,我就可以创建单个 html 文件版本、分块 html 版本(每章一个文件)和 PDF 版本。
经过一些调整和定制后,我对输出非常满意。文件看起来great!!
DocBook 被真正的出版商(最著名的是 O'Reilly)广泛使用,并且它已经存在超过十五年了,所以它已经达到了一定的成熟度。
另一方面,所有处理都是通过 XSLT 使用临时工具集完成的。 (我自己的 docbook 管道包括 Python、Java、Xerces、Xalan、Apache FOP 和 PDF-SAM。加上官方 XSLT 样式表分发以及我自己的 XSLT 自定义。)
DocBook 不是交钥匙解决方案。如果不阅读手册,您将无法快速上手。如果您对 XSLT 一无所知,您就必须学习。
另一方面,您真正需要知道的只有一打或两个 XML 标记。write文件。 (真正的专业知识在从 XML 源生成文档的过程中发挥作用。)如果团队中的一个人愿意负责编写文档构建脚本,那么团队中的其他人都可以学习 DTD 并完成一份体面的工作贡献。
无论如何... DocBook 肯定有一些缺陷。对于技术作者来说,这并不是最简单的系统。但它是我所知道的最好的开源工具。
《Subversion Book》是用 DocBook 编写的。这是一个包含不同书籍版本(single-html、chunked-html 和 PDF)链接的页面:
http://svnbook.red-bean.com/ http://svnbook.red-bean.com/
这里是第一章的 DocBook XML 源代码的链接,以便您可以了解它是如何工作的:
http://sourceforge.net/p/svnbook/source/HEAD/tree/branches/1.7/en/book/ch01-fundamental-concepts.xml http://sourceforge.net/p/svnbook/source/HEAD/tree/branches/1.7/en/book/ch01-fundamental-concepts.xml