大多数库作者都习惯于编写 HTML 文档。编写 DocBook 文档(以及,作为扩展,BoostBook 文档)与编写 HTML 非常相似,只不过 BoostBook 使用与 HTML 不同的元素名称(参见 表 3.1,“将 HTML 元素转换为 BoostBook”),并且 BoostBook XML 比 HTML 格式严格得多。
将 HTML 文档转换为 BoostBook 文档的最简单方法之一是使用 HTML Tidy 将您的 HTML 转换为有效的 XHTML,这将确保所有元素都正确关闭,然后应用 表 3.1,“将 HTML 元素转换为 BoostBook” 中的转换到 XHTML 文档的主体。以下命令使用 HTML Tidy 将 HTML 转换为有效的 XHTML
tidy -asxhtml input.html > output.xhtml
当将文档从 HTML 转换为 BoostBook 时,请注意,在 HTML 中必须手动维护的一些冗余信息在 BoostBook 中是自动生成的:例如,名为“定义 BoostBook 库” 的章节中描述的库分类、用途和作者列表,既用于库的文档中,也用于构建已知库的字母顺序和分类列表;同样,目录是从 BoostBook 文档中章节的标题自动构建的。
表 3.1. 将 HTML 元素转换为 BoostBook
HTML | BoostBook |
---|---|
<h1>, <h2>, 等 |
<section>, <title>; 参见 名为“BoostBook 中的章节”的章节 |
<i>, <em> |
<emphasis> |
<b> |
<emphasis role="bold"> |
<ol> |
<orderedlist> |
<ul> |
<itemizedlist> |
<li> |
<listitem> |
<pre> |
<programlisting> |
<code> |
<computeroutput>,<code> |
<p> |
<para>, <simpara> |
<a> |
<xref>, <link>, <ulink>;, 参见 名为“BoostBook 中的链接”的章节 |
<table>, <tr>, <th>, <td> |
<table>, <informaltable>, <tgroup>, <thead>, <tfoot>, <tbody>, <row>, <entry>, <entrytbl>; BoostBook 表格等同于 DocBook 表格,这里有一个很好的 教程 |