1. 什么是DocBook
维基百科中关于 DocBook 的定义如下:
DocBook 是一种用于技术文件的语义标记语言。它本来是打算用于编写有关计算机硬件和软件的技术文件,但它可以用于任何其它类型的文件。 作为一个语义语言, DocBook 让用户创建文件的内容在一个表达中立的表格中,体现了逻辑结构的内容;她的内容可以发表成各种不同的格式,包括 HTML,XHTML, EPUB,PDF 格式,man 文件和 HTML 帮助,而不需要用户在源文件中做任何的更改。总之,DocBook 能让你写的东西看起来非常专业!
事实上,如果你是一位软件开发人员,那么你肯定已经或多或少的接触过 DocBook 所编写的文档了,例如 SpringFramework、Hibernate 等的开发指引文档以及本站 JOQS开发指南都是采用 DocBook 的格式来编写的原始文档。
更多 DocBook 内容请参考 DocBook网站 和 DocBook 定义(维基百科)。《DocBook 助你完成传世之作》这篇文章也不错。
2. DocBook 的编写工具
DocBook 原始文档是标准的 XML 格式的,这方便了维护和版本控制。但同时,如果没有适当的编写工具来支持,使用起来还是比较困难的。下面列出了一些编辑工具。
DocBook 的编写工具主要分两类:
第一类是文本文件编辑工具,如记事本、EditPlus 等。这些工具几乎是万能的源码编辑器,用起来虽然方便但不容易。
第二类是采用 XML 或者 DocBook 编辑工具,比较推荐一下几种:
3. DocBook 的 Maven 插件
一些可视化的 DocBook 编辑工具带有 DocBook 转换成其它格式的功能(如 XXE),但另外一些工具可能仅仅是个编辑工具,此时如果需要将 DocBook 输出成其它格式,就要借助一些处理工具,如 XSLT Processor 等。
在 maven 工程中,有一些插件可以完成这个转换功能:
Source |
|