BlackBerry/Boost项目中的BoostBook文档编写指南

什么是BoostBook

BoostBook是基于DocBook扩展的一种XML文档格式，专门用于为Boost C++库编写文档。它继承了DocBook的强大功能，同时针对Boost库的特点进行了专门优化。BoostBook文档最终可以被转换为多种格式，包括HTML、PDF等。

创建BoostBook库文档的基本结构

每个Boost库的文档都包含在一个<library>XML元素中。下面是一个最基本的BoostBook文档结构示例：

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
  "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<library name="库名称" dirname="目录名" id="唯一标识符" last-revision="$Date$">
  <libraryinfo>
    <author>
      <firstname>名字</firstname>
      <surname>姓氏</surname>
    </author>
    <librarypurpose>
      库的简要描述（一句话）
    </librarypurpose>
    <librarycategory name="category:分类名称"/>
  </libraryinfo>
</library>

<library>元素的关键属性

• name: 库的完整名称（如"Any"）
• dirname: 库所在的目录路径（相对于boost/libs）
• id: 库的唯一标识符，建议使用小写字母和下划线
• last-revision: 自动更新的最后修改日期

文档内容组织

章节划分

BoostBook使用<section>元素来组织文档的章节结构：

<section id="unique.id">
  <title>章节标题</title>
  
  <para>段落内容...</para>

  <section>
    <title>子章节标题</title>
    <para>子章节内容...</para>
  </section>
</section>

每个<section>都应该有一个唯一的id属性，建议使用"库名.章节名"的格式。

常用元素转换

对于熟悉HTML的开发者，以下是将HTML元素转换为BoostBook元素的对照表：

HTML元素	BoostBook对应元素
<h1>, <h2>等	<section>和<title>组合
<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>
表格相关元素	使用DocBook表格元素

从HTML迁移到BoostBook

如果你已经有HTML格式的文档，可以按照以下步骤迁移到BoostBook：

1. 使用HTML Tidy工具将HTML转换为规范的XHTML：

   tidy -asxhtml input.html > output.xhtml
   

2. 根据上面的对照表，将XHTML中的元素替换为BoostBook对应的元素

3. 将内容嵌入到BoostBook的基本结构中

最佳实践

1. 保持简洁：<librarypurpose>应该是一句话描述，不要以句号结尾

2. 合理分类：确保为库选择了正确的分类，分类列表在项目的doc/src/boost.xml文件中

3. ID命名规范：所有ID应以库的短名称开头，后跟点号（如"any.intro"）

4. 自动生成内容：利用BoostBook自动生成目录、索引等，减少手动维护

5. 结构化思维：BoostBook比HTML更严格，需要更结构化的思维方式来组织文档

通过遵循这些指南，你可以为BlackBerry/Boost项目创建专业、一致的文档，帮助开发者更好地理解和使用你的库。