[boost-doc-zh] r423 committed - 翻译 tools/boostbook 的 qbk/xml 文件
- From: boost-doc-zh@xxxxxxxxxxxxxx
- To: boost-doc-zh-notify@xxxxxxxxxxxxx
- Date: Tue, 17 Aug 2010 06:45:41 +0000
Revision: 423
Author: alai04
Date: Mon Aug 16 23:44:54 2010
Log: 翻译 tools/boostbook 的 qbk/xml 文件
http://code.google.com/p/boost-doc-zh/source/detail?r=423
Modified:
/trunk/tools/boostbook/doc/boostbook.xml
/trunk/tools/boostbook/doc/documenting.xml
/trunk/tools/boostbook/doc/reference.xml
/trunk/tools/boostbook/doc/together.xml
=======================================
--- /trunk/tools/boostbook/doc/boostbook.xml Mon Dec 28 23:05:14 2009
+++ /trunk/tools/boostbook/doc/boostbook.xml Mon Aug 16 23:44:54 2010
@@ -34,7 +34,7 @@
<title>The BoostBook Documentation Format</title>
<chapter id="boostbook.introduction">
- <title>Introduction</title>
+ <title>Introduction 简介</title>
<para>The BoostBook documentation format is an extension of <ulink
url="http://www.docbook.org";>DocBook</ulink>, an SGML- or
@@ -44,7 +44,12 @@
url="http://www.boost.org";>Boost C++ libraries</ulink>, by
providing the ability to express and refer to C++ constructs such
as namespaces, classes, overloaded functions, templates, and
- specializations.</para>
+ specializations.<sbr/>
+ BoostBook 文档格式是 <ulink
url="http://www.docbook.org";>DocBook</ulink>
+ 的一种扩展，后者是一种用于描述性文档的基于 SGML 或 XML 的格式。
+ BoostBook 比 DocBook 增加了语义标记，有助于编写 C++ 库的文档，尤其是
+ <ulink url="http://www.boost.org";>Boost C++ 库</ulink>，它提供了表示和
引用象名字空间、
+ 类、函数重载、模板和特化等 C++ 结构的能力。</para>
<para>
BoostBook offers additional features more specific to its use for
@@ -52,7 +57,9 @@
libraries</ulink>. These features are intended to eliminate or
reduce the need for duplication of information and to aid in
documenting portions of Boost that might otherwise not be
- documented. Examples of Boost-centric features include:
+ documented. Examples of Boost-centric features include:<sbr/>
+ BoostBook 提供了额外的特性，更加专注于 <ulink
url="http://www.boost.org";>Boost C++ 库</ulink>的文档编写。
+ 这些特性的目的是消除或减少重复的信息，并有助于将未文档化的 Boost 部分进
行文档化。Boost-专用的特性包括有：
<itemizedlist>
<listitem>
<para><emphasis role="bold">Testsuites</emphasis>:
@@ -69,7 +76,14 @@
purposes: the BoostBook stylesheets can generate
documentation for the testcases and also generate an
appropriate Jamfile to integrate the testcases with the
- regression testing system.</para>
+ regression testing system.<sbr/>
+ <emphasis role="bold">测试套件</emphasis>：Boost 中的测试套件是通
过编写一个合适的
+ Jamfile 并将该 Jamfile 包含在
<filename>status/Jamfile</filename> 中来创建的。
+ 如果测试套件已经文档化(<ulink
url="http://www.boost.org/libs/multi_array/doc/test_cases.html";>
+ 象在 MultiArray 库中</ulink>)，则这些文档的维护是独立于测试案例
Jamfile 的，
+ 这导致了信息的重复，还可能使得文档与 Jamfile 不同步。BoostBook 包
含了描述一个测试套的各种元素，
+ 有两种目的：BoostBook stylesheets 可以为测试案例生成文档，也可以
生成一个适合的
+ Jamfile 来将测试案例与回归测试系统相集成。</para>
</listitem>
<listitem>
<para><emphasis role="bold">Example programs</emphasis>:
@@ -77,7 +91,10 @@
testcases to ensure that the examples compile and execute
correctly. Keeping the two copies in sync is a tedious and
error-prone task. For instance, the following code snippet
- persisted for six months:</para>
+ persisted for six months:<sbr/>
+ <para><emphasis role="bold">示例程序</emphasis>：在文档中的示例程
序需要在测试案例中重复，
+ 以确保这些例子被正确地编译和执行。保持两份拷贝的同步是一件乏味而
易错的工作。
+ 例如，以下代码片断被保留了六个月：</para>
<programlisting>
std::cout << f(5, 3) >> std::endl;
</programlisting>
@@ -85,34 +102,46 @@
by weaving together program fragments from example programs
in the documentation. This capability is integrated with
testsuite generation so that example programs are normal
- tests in BoostBook.</para>
+ tests in BoostBook.<sbr/>
+ BoostBook 格式可以通过组合多个程序片断，从文档中的示例程序生成测
试案例。
+ 这一能力被集成到测试套件的生成当中，这样在 BoostBook 中的示例程序
就可以进行正常的测试。</para>
</listitem>
</itemizedlist>
</para>
</chapter>
<chapter id="boostbook.getting.started">
- <title>Getting Started</title>
-
- <para>To use the Boost documentation tools, you will need several
tools:</para>
+ <title>Getting Started 入门</title>
+
+ <para>To use the Boost documentation tools, you will need several
tools:<sbr/>
+ 要使用 Boost 文档工具，你需要以下几个工具：</para>
<itemizedlist>
<listitem><simpara><command>xsltproc</command>:</simpara>
<itemizedlist>
<listitem>Windows with <ulink
- url="http://www.cygwin.com/";>Cygwin</ulink>: select
the libxml2 and libxslt packages.</listitem>
+ url="http://www.cygwin.com/";>Cygwin</ulink>: select
the libxml2 and libxslt packages.<sbr/>
+ 带 <ulink
+ url="http://www.cygwin.com/";>Cygwin</ulink> 的
Windows ：选择 libxml2 和 libxslt 包。</listitem>
<listitem>Windows without Cygwin: Download the <ulink
url="http://www.zlatkovic.com/pub/libxml/";>binary packages</ulink>
- from Igor Zlatkovic. At the very least, you'll need iconv,
zlib, libxml2 and libxslt.</listitem>
- <listitem>Mac OS X with Fink: Get the <code>libxslt</code>
package.</listitem>
- <listitem>Mac OS X without Fink: <ulink
url="http://www.zveno.com/open_source/libxml2xslt.html";>Download the
libxslt binaries</ulink></listitem>
+ from Igor Zlatkovic. At the very least, you'll need iconv,
zlib, libxml2 and libxslt.<sbr/>
+ 不带 Cygwin 的 Windows：从 lgor Zlakovic 下载 <ulink
url="http://www.zlatkovic.com/pub/libxml/";>二进制包</ulink>。
+ 主要的一点，你需要 iconv, zlib, libxml2 和 libxslt.</listitem>
+ <listitem>Mac OS X with Fink: Get the <code>libxslt</code>
package.<sbr/>
+ 带 Fink 的 Mac OS X：获取 <code>libxslt</code> 包。</listitem>
+ <listitem>Mac OS X without Fink: <ulink
url="http://www.zveno.com/open_source/libxml2xslt.html";>Download the
libxslt binaries</ulink><sbr/>
+ 不带 Fink 的 Mac OS X：<ulink
url="http://www.zveno.com/open_source/libxml2xslt.html";>下载 libxslt 的二进
制文件</ulink></listitem>
<listitem>Any platform: <ulink
-
url="http://xmlsoft.org/XSLT/";>libxslt source</ulink>.</listitem>
+
url="http://xmlsoft.org/XSLT/";>libxslt source</ulink>.<sbr/>
+ 任意平台：<ulink
+
url="http://xmlsoft.org/XSLT/";>libxslt 源文件</ulink>。 </listitem>
</itemizedlist>
</listitem>
- <listitem><simpara><command>doxygen</command>:</simpara> Available
from <ulink
url="http://www.doxygen.org";>http://www.doxygen.org</ulink></listitem>
+ <listitem><simpara><command>doxygen</command>:</simpara> Available
from <ulink
url="http://www.doxygen.org";>http://www.doxygen.org</ulink><sbr/>
+ 从 <ulink
url="http://www.doxygen.org";>http://www.doxygen.org</ulink> 获得</listitem>
</itemizedlist>
<section id="boostbook.setup.autounix">
- <title>Automatic setup for Unix-like systems</title>
+ <title>Automatic setup for Unix-like systems 类Unix系统上的自动设置
</title>
<para>BoostBook provides a nearly-automatic setup script. Once
you have downloaded and
@@ -121,18 +150,25 @@
download the required DocBook stylesheets, DocBook DTD, and
(when Java is enabled) Apache FOP for PDF output. It will then
configure Boost.Build version 2 to build BoostBook
- documentation.</para>
+ documentation.<sbr/>
+ BoostBook 提供了几乎是自动化的设置脚本。在你下载并安装完成
<command>xsltproc</command>,
+ <command>doxygen</command>, 还有(可选的) <command>java</command>
后，设置脚本就可以下载所需的
+ DocBook stylesheets, DocBook DTD, 和(如果 Java 是可用的)用于 PDF 输出
的 Apache FOP。
+ 然后它将配置 Boost.Build V2 以构建 BoostBook 文档。</para>
<para>The script requires: <command>sh</command>,
<command>curl</command> and <command>gunzip</command>.
To perform the installation, execute the
script <command>tools/boostbook/setup_boostbook.sh</command>
from a directory where you would like the resulting XSL, DTD,
- and Apache FOP installations to occur. </para>
+ and Apache FOP installations to occur. <sbr/>
+ 该脚本需要：<command>sh</command>, <command>curl</command> 和
<command>gunzip</command>。
+ 要进行这个安装，请从一个你想要存放最终的 XSL, DTD 和 Apache FOP 安装
的目录下执行脚本
+ <command>tools/boostbook/setup_boostbook.sh</command>。</para>
</section>
<section id="boostbook.setup.manual">
- <title>Manual setup for all systems</title>
+ <title>Manual setup for all systems 所有系统上的手动设置</title>
<para>This section describes how to manually configure Boost
Boost version 2 (BBv@) for BoostBook. If you can use the
@@ -143,35 +179,45 @@
that resides in <code>tools/build/v2</code> to your home
directory. Alternatively, you can edit
<filename>tools/build/v2/user-config.jam</filename> directly or
- a site-wide <filename>site-config.jam</filename> file.</para>
+ a site-wide <filename>site-config.jam</filename> file.<sbr/>
+ 本节描述了如何为 BoostBook 手工配置 Boost Boost version 2 (BBv@)。如
果你可以使用自动脚本，你就应该用它。
+ 所有配置都出现在 BBv2 的用户配置文件
<filename>user-config.jam</filename> 中。
+ 如果在你的主目录中没有这个文件的拷贝，你可以从
<code>tools/build/v2</code> 目录中复制一份到你的主目录。
+ 或者，你也可以直接编辑
<filename>tools/build/v2/user-config.jam</filename> 或是一个
<filename>site-config.jam</filename> 文件。</para>
<section id="boostbook.setup.xsltproc">
- <title>Configuring <command>xsltproc</command></title>
+ <title>Configuring <command>xsltproc</command> 配置
<command>xsltproc</command> </title>
<para>To configure <command>xsltproc</command> manually, you
will need to add a directive to
<filename>user-config.jam</filename> telling it where to find
<command>xsltproc</command>. If the program is in your path,
just add the following line to
- <filename>user-config.jam</filename>:</para>
+ <filename>user-config.jam</filename>:<sbr/>
+ 要手工配置 <command>xsltproc</command>，你需要增加一个指示符到
<filename>user-config.jam</filename> 中，
+ 告诉它在哪里可以找到 <command>xsltproc</command>。如果该程序在你的
执行目录中，则只需要增加以下一行到
+ <filename>user-config.jam</filename> 中：</para>
<programlisting>using xsltproc ;</programlisting>
<para>If <command>xsltproc</command> is somewhere else, use
this directive, where <code>XSLTPROC</code> is the full
pathname to <command>xsltproc</command> (including
- <command>xsltproc</command>):</para>
+ <command>xsltproc</command>):<sbr/>
+ 如果 <command>xsltproc</command> 在其它的地方，请使用以下指示符，其
中 <code>XSLTPROC</code> 为
+ <command>xsltproc</command> (包括 <command>xsltproc</command>) 的全
路径名：</para>
<programlisting>using xsltproc : XSLTPROC ;</programlisting>
</section>
<section id="boostbook.setup.docbook">
- <title>Configuring local DocBook XSL and DTD distributions</title>
+ <title>Configuring local DocBook XSL and DTD distributions 配置本地
的 DocBook XSL 和 DTD 分发包</title>
<para>This section describes how to configure Boost.Build to
use local copies of the DocBook DTD and XSL stylesheets to
improve processing time. You will first need to download two
- packages:
+ packages:<sbr/>
+ 这一节描述如何配置 Boost.Build 来使用本地的 DocBook DTD 和 XSL
stylesheets 来提高处理速度。首先你要下载两个包：
<itemizedlist>
<listitem><para>Norman Walsh's DocBook XSL stylesheets,
@@ -179,7 +225,10 @@
url="http://docbook.sourceforge.net";>DocBook sourceforge
site</ulink>. Extract the DocBook XSL stylesheets to a
directory on your hard disk (which we'll refer to as the
- <code>DOCBOOK_XSL_DIR</code>).</para>
+ <code>DOCBOOK_XSL_DIR</code>).<sbr/>
+ Norman Walsh 的 DocBook XSL stylesheets，在 <ulink
url="http://docbook.sourceforge.net";>
+ DocBook sourceforge site</ulink> 站点。将该 DocBook XSL
stylesheets 解压到你硬盘上的某个目录
+ (我们将称之为 <code>DOCBOOK_XSL_DIR</code>)。</para>
</listitem>
<listitem><para>The DocBook DTD, available as a ZIP archive
@@ -189,12 +238,18 @@
4.2". Extract the DocBook DTD to a directory on your hard
disk (which we'll refer to as the
<code>DOCBOOK_DTD_DIR</code>). You will want to extract this
- archive in a subdirectory!</para></listitem>
+ archive in a subdirectory!<sbr/>
+ DocBook DTD, 它是一个 ZIP 存档，在 <ulink
+ url="http://www.oasis-open.org/docbook/xml/4.2/";>OASIS DocBook 站
点</ulink>。
+ 该包称为 "DocBook XML 4.2"。将该 DocBook DTD 解压到你硬盘上的某个
目录(我们将称之为
+ <code>DOCBOOK_DTD_DIR</code>)。你应该将该存档解压到一个子目录下！
+</para></listitem>
</itemizedlist>
</para>
<para>Add the following directive telling BBv2 where to find
- the DocBook DTD and XSL stylesheets:</para>
+ the DocBook DTD and XSL stylesheets:<sbr/>
+ 增加以下指示符，告诉 BBv2 在哪里可以找到 DocBook DTD 和 XSL
stylesheets：</para>
<programlisting># BoostBook configuration
using boostbook
@@ -204,7 +259,9 @@
<para>Whenever you change this directive, you will need to
remove the <code>bin.v2</code> directory that BBv2 generates.
- This is due to longstanding bug we are trying to fix.</para>
+ This is due to longstanding bug we are trying to fix.<sbr/>
+ 如果你修改了这个指示符，你就需要删除由 BBv2 生成的
<code>bin.v2</code> 目录。
+ 这是一个已经存在很长时间的 bug，我们正在努力修复它。</para>
<para>At this point, you should be able to build HTML
documentation for libraries that do not require Doxygen. To
@@ -212,18 +269,23 @@
class="directory">$BOOST_ROOT/libs/function/doc</filename> and
run the command <code>bjam --v2</code>: it should produce HTML
documentation for the Boost.Function library in the
- <code>html</code> subdirectory.</para>
+ <code>html</code> subdirectory.<sbr/>
+ 到此为止，你应该可以为各个不需要 Doxygen 的库构建 HTML 文档了。要测
试一下它，请转至 <filename
+ class="directory">$BOOST_ROOT/libs/function/doc</filename> 目录，运
行命令 <code>bjam --v2</code>:
+ 它会为 Boost.Function 库生成 HTML 文档并保存在 <code>html</code> 子
目录下。</para>
</section>
<section id="boostbook.setup.doxygen">
- <title>Configuring Doxygen for Documentation Extraction</title>
+ <title>Configuring Doxygen for Documentation Extraction 为文档提取
配置 Doxygen</title>
<para>Doxygen is required to build the documentation for
several Boost libraries. You will need a recent version of
<ulink url="http://www.doxygen.org";>Doxygen</ulink> (most of
the 1.3.x and 1.4.x versions will suffice). BBv2 by adding the
following directive to
- <filename>user-config.jam</filename>:</para>
+ <filename>user-config.jam</filename>:<sbr/>
+ 有几个 Boost 库的文档要用 Doxygen 构建。你需要较新版本的 <ulink
url="http://www.doxygen.org";>Doxygen</ulink>
+ (多数 1.3.x 和 1.4.x 版本都可以)。增加以下指示符到 BBv2 的
<filename>user-config.jam</filename>:</para>
<programlisting>using doxygen : DOXYGEN ;</programlisting>
@@ -231,7 +293,9 @@
name of the <command>doxygen</command> executable (with full
path name). If the right <command>doxygen</command> executable
can be found via the path, this parameter can be
- omitted, e.g.</para>
+ omitted, e.g.<sbr/>
+ <filename>DOXYGEN</filename> 应被替换为 <command>doxygen</command>
可执行文件的名字(带全路径名)。
+ 如果可以在执行路径中找到正确的 <command>doxygen</command> 可执行文
件，该参数可以忽略，如：</para>
<programlisting>using doxygen ;</programlisting>
@@ -242,13 +306,16 @@
significant. In particular, the <literal>using
doxygen</literal> line should come
<emphasis>after</emphasis> the <literal>using
- boostbook</literal> declaration.
+ boostbook</literal> declaration.<sbr/>
+ 在 <filename>user-config.jam</filename> /
+ <filename>site-config.jam</filename> 文件中的声明的相对顺序是很重
要的。
+ 特别是，<literal>using doxygen</literal> 行应在 <literal>using
boostbook</literal> 声明之后。
</para>
</important>
</section>
<section id="boostbook.setup.fop">
- <title>Configuring Apache FOP</title>
+ <title>Configuring Apache FOP 配置 Apache FOP</title>
<para>In order to generate PDF and PostScript output using
Apache FOP, you will need a <ulink
@@ -261,7 +328,14 @@
the location of that script and Java location to
Boost.Build. Add the following to your
<filename>user-config.jam</filename> or
- <filename>site-config.jam</filename>:
+ <filename>site-config.jam</filename>:<sbr/>
+ 为了使用 Apache FOP 生成 PDF 和 PostScript 输出，你需要一个 <ulink
+ url="http://java.sun.com";>Java 解释器</ulink> 和 <ulink
+ url="http://xml.apache.org/fop/download.html";>Apache FOP</ulink> (最
好是版本 0.20.5)。
+ 将 Apache FOP 解包到某个目录。FOP 工具的顶层目录应包含一个主脚本，在
Unix 中名为
+ <filename>fop.sh</filename>，在 Windows 中则名为
<filename>fop.bat</filename>。
+ 你需要对 Boost.Build 指明该脚本的位置和 Java 的位置。增加以下行到你的
+ <filename>user-config.jam</filename> 或
<filename>site-config.jam</filename>:
<programlisting>
using fop : FOP_COMMAND
: JAVA_HOME
@@ -270,7 +344,9 @@
<code>FOP_COMMAND</code> with the full path to the FOP main script,
and
replacing <code>JAVA_HOME</code> with the directory where Java is
installed. If the <envar>JAVA_HOME</envar> environment variable is
- already set, you don't need to specify it above.
+ already set, you don't need to specify it above.<sbr/>
+ 将 <code>FOP_COMMAND</code> 替换为 FOP 主脚本的全路径，再将
<code>JAVA_HOME</code> 替换为安装 Java 的目录。
+ 如果已经设置了 <envar>JAVA_HOME</envar> 环境变量，你就不需要再指定它
了。
</para>
<para>
@@ -282,19 +358,27 @@
<filename>jimi-1.0.jar</filename>, or if on *nix, to
<filename>JimiProClasses.jar</filename>―and place it in the
<filename>lib/</filename> subdirectory of your FOP
- installation.
+ installation.<sbr/>
+ PDF 中的图象的正确生成要依靠 <ulink
+ url="http://java.sun.com/products/jimi/#";>Jimi 图象库</ulink>。
+ 要让 FOP 使用 Jimi，请从 Jimi SDK 中解压
<filename>JimiProClasses.zip</filename>
+ 文件并改名―对于 Windows 改为 <filename>jimi-1.0.jar</filename>，对
于 *nix 则改为
+ <filename>JimiProClasses.jar</filename>―并将它放在你的 FOP 安装下
的 <filename>lib/</filename> 子目录。
</para>
<para>To test PDF generation, switch to the directory <filename
class="directory">$BOOST_ROOT/libs/function/doc</filename> and
execute the command <command>bjam --v2 pdf</command>. In the
absence of any errors, Apache FOP will be executed to transform
- the XSL:FO output of DocBook into a PDF file.</para>
+ the XSL:FO output of DocBook into a PDF file.<sbr/>
+ 要测试 PDF 的生成，请转至 <filename
+ class="directory">$BOOST_ROOT/libs/function/doc</filename> 目录并执行
命令 <command>bjam --v2 pdf</command>。
+ 如果一切正常，Apache FOP 将会执行并将 DocBook 的 XSL:FO 输出转换为
PDF 文件。</para>
</section>
</section>
<section id="boostbook.setup.running">
- <title>Running BoostBook</title>
+ <title>Running BoostBook 运行 BoostBook</title>
<para>Once BoostBook has been configured, we can build some
documentation. First, change to the directory
@@ -303,7 +387,10 @@
<code>$BOOST_ROOT/doc/html</code>. Then, run <code>bjam
--v2</code> to build HTML documentation. You should see several
warnings like these while DocBook documentation is being built
- from BoostBook documentation:</para>
+ from BoostBook documentation:<sbr/>
+ 一旦完成 BoostBook 的配置，我们就可以来构建一些文档了。首先，转至
<code>$BOOST_ROOT/doc</code>
+ 目录并删除(或使之可写)在 <code>$BOOST_ROOT/doc/html</code> 中的
<code>.html</code> 文件。
+ 然后，运行 <code>bjam --v2</code> 来构建 HTML 文档。在从 BoostBook 文档
构建 DocBook 文档过程中，你会看到如下一些警告：</para>
<programlisting>Cannot find function named 'checked_delete'
Cannot find function named 'checked_array_delete'
@@ -322,34 +409,45 @@
linkend="boostbook.output.formats"/>. Several output formats can
be passed to a single invocation of <code>bjam</code>, e.g.,
<code>bjam --v2 html man docbook</code> would generate HTML
- (multiple files), man pages, and DocBook documentation.</para>
+ (multiple files), man pages, and DocBook documentation.<sbr/>
+ 这些警告是在 Boost 文档工具找不到源文件中某些函数、方法或类的文档时产生
的，它们没有什么危害。
+ 当 Boost.Jam 完成执行后，Boost 的 HTML 文档将被放在
<code>$BOOST_ROOT/doc/html</code> 目录中。
+ 你也可以用命令行 <code>bjam --v2 onehtml</code> 来生成单个(巨大的!)
HTML 文件，或者用命令行
+ <code>bjam --v2 man</code> 来生成 Unix man 页。完成的输出格式列表请见
<xref
+ linkend="boostbook.output.formats"/>。可以在对 <code>bjam</code> 的一次
调用中生成多种输出格式，如
+ <code>bjam --v2 html man docbook</code> 将同时生成 HTML (多文件), man
页和 DocBook 文档。</para>
<table id="boostbook.output.formats">
<title>BoostBook Output Formats</title>
<tgroup cols="2">
<thead>
- <row><entry>Format</entry><entry>Description</entry></row>
+ <row><entry>Format 格式</entry><entry>Description 说明
</entry></row>
</thead>
<tbody>
<row>
<entry>html</entry>
- <entry><simpara>HTML output (multiple files). This is the
default</simpara></entry>
+ <entry><simpara>HTML output (multiple files). This is the
default<sbr/>
+ HTML 输出(多文件)。这是缺省值。</simpara></entry>
</row>
<row>
<entry>onehtml</entry>
- <entry><simpara>HTML output in a single HTML
file.</simpara></entry>
+ <entry><simpara>HTML output in a single HTML file.<sbr/>
+ 单个 HTML 文件的 HTML 输出。</simpara></entry>
</row>
<row>
<entry>man</entry>
- <entry><simpara>Unix man pages.</simpara></entry>
+ <entry><simpara>Unix man pages.<sbr/>
+ Unix man 页。</simpara></entry>
</row>
<row>
<entry>pdf</entry>
- <entry><simpara>PDF. Requires <ulink
url="http://xml.apache.org/fop/index.html";>Apache
FOP</ulink>.</simpara></entry>
+ <entry><simpara>PDF. Requires <ulink
url="http://xml.apache.org/fop/index.html";>Apache FOP</ulink>.<sbr/>
+ PDF. 需要 <ulink
url="http://xml.apache.org/fop/index.html";>Apache
FOP</ulink>.</simpara></entry>
</row>
<row>
<entry>ps</entry>
- <entry><simpara>Postscript. Requires <ulink
url="http://xml.apache.org/fop/index.html";>Apache
FOP</ulink>.</simpara></entry>
+ <entry><simpara>Postscript. Requires <ulink
url="http://xml.apache.org/fop/index.html";>Apache FOP</ulink>.<sbr/>
+ Postscript. 需要 <ulink
url="http://xml.apache.org/fop/index.html";>Apache
FOP</ulink>.</simpara></entry>
</row>
<row>
<entry>docbook</entry>
@@ -365,7 +463,7 @@
</section>
<section id="boostbook.setup.troubleshooting">
- <title>Troubleshooting</title>
+ <title>Troubleshooting 疑难解答</title>
<para>The Boost documentation tools are still in their early phase of
development, and some things don't work as seamlessly as we would
like
@@ -373,7 +471,10 @@
uninformative at times. If you find yourself in the situation when
you have double checked everything, and yet things still don't work
as
expected, consider helping the tools by deleting
- <literal>bin.v2</literal> build directory.
+ <literal>bin.v2</literal> build directory.<sbr/>
+ Boost 文档工具仍然只是处于开发的早期阶段，有些事情还不是象我们希望的
那样无缝工作。
+ 特别是，有时的错误信息毫无意义。如果你发现这种情况，并经过反复检查后
依然无法正常使用，
+ 可以考虑通过删除 <literal>bin.v2</literal> 构建目录来帮这些工具一把。
</para>
</section>
=======================================
--- /trunk/tools/boostbook/doc/documenting.xml Mon Dec 28 23:05:14 2009
+++ /trunk/tools/boostbook/doc/documenting.xml Mon Aug 16 23:44:54 2010
@@ -10,7 +10,7 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd";>
<chapter xmlns:xi="http://www.w3.org/2001/XInclude";
id="boostbook.documenting"
last-revision="$Date: 2008-07-12 15:30:45 -0400 (Sat, 12 Jul
2008) $">
- <title>Documenting libraries</title>
+ <title>Documenting libraries 库的文档化</title>
<para>BoostBook is an extension to <ulink
url="http://www.docbook.org";>DocBook</ulink>, an XML format for
@@ -19,10 +19,13 @@
redocumented here. When writing BoostBook documentation, please
refer also to <ulink
url="http://docbook.org/tdg/en/index.html";>DocBook: The Definitive
- Guide</ulink>.</para>
+ Guide</ulink>.<sbr/>
+ BoostBook 是 <ulink url="http://www.docbook.org";>DocBook</ulink> 的一种扩
展，它是描述文档的一种 XML 格式。
+ BoostBook 从 DocBook 继承了许多功能和元素，在此不再重复。在编写
BoostBook 文档时，请一并参考 <ulink
+ url="http://docbook.org/tdg/en/index.html";>DocBook: The Definitive
Guide</ulink>。</para>
<section id="boostbook.defining">
- <title>Defining a BoostBook library</title>
+ <title>Defining a BoostBook library 定义一个 BoostBook 库</title>
<para>BoostBook library documentation is contained entirely within
a <library> XML element. To create a skeletal library, we
@@ -31,10 +34,14 @@
<link linkend="boostbook.documenting.skeletal">BoostBook XML
example</link> describes basic information about the <ulink
url="http://www.boost.org/libs/any/index.html";>Boost.Any</ulink>
- library:</para>
+ library:<sbr/>
+ BoostBook 的库文档被包含在一个 <library> XML 元素中。要创建一个框
架库，我们需要创建一个新的
+ XML 文档(称之为 <code>any.xml</code>)来包含该库的基本信息。以下
+ <link linkend="boostbook.documenting.skeletal">BoostBook XML 示例
</link> 描述了关于 <ulink
+ url="http://www.boost.org/libs/any/index.html";>Boost.Any</ulink> 库的基
本信息：</para>
<example id="boostbook.documenting.skeletal">
- <title>A Skeletal BoostBook Library</title>
+ <title>A Skeletal BoostBook Library 一个 BoostBook 框架库</title>
<programlisting>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
@@ -59,18 +66,22 @@
<ulink url="http://www.w3.org/XML/";>XML</ulink> document. The
DOCTYPE line states that the document conforms to the BoostBook
DTD, and that the top-level element is a BoostBook
- <library>.</para>
+ <library>.\n
+ 头三行表示这个文档是一个 BoostBook <ulink
url="http://www.w3.org/XML/";>XML</ulink> 文档。
+ DOCTYPE 行表示该文档符合 BoostBook DTD，并且顶层元素为 BoostBook
<library>。</para>
<para>The <library> element actually describes the aspects
of BoostBook library documentation. The attributes for the
- <library> element are:</para>
+ <library> element are:<sbr/>
+ <library> 元素实际描述 BoostBook 库文档的外表。<library> 元
素的属性有：</para>
<variablelist>
- <title>Attributes for the <library> element</title>
+ <title>Attributes for the <library> element <library>元
素的属性</title>
<varlistentry>
<term><code>name</code></term>
<listitem>
- <simpara>The full name of the library, e.g., "Any"</simpara>
+ <simpara>The full name of the library, e.g., "Any"<sbr/>
+ 库的全名，如 "Any" </simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -80,7 +91,9 @@
<code>boost/libs</code>, in which the library
resides. This name may be a relative path, such as
<code>math/octonion</code>, using "/" for the directory
- separator.</simpara>
+ separator.<sbr/>
+ 库所在的目录名，相对于 <code>boost/libs</code>。该名可以是一个
相对路径名，如
+ <code>math/octonion</code>，以 "/" 作为目录分隔符。</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -93,7 +106,10 @@
identify libraries and, for HTML output, will be used as the
base name for the HTML file in which the library's
documentation resides, so it should use only lowercase
- alphanumeric characters and underscores.</simpara>
+ alphanumeric characters and underscores.<sbr/>
+ 库的一个短且唯一的名字。对于带有简单目录名的库(即不含 "/")，该名
字与 <code>dirname</code> 相同。
+ 这个 <code>id</code> 用于标识该库，而且对于 HTML 输出，它被用作库
文档所处 HTML
+ 文件的基名，所以它应该只使用小写字母和下划线。</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -101,7 +117,9 @@
<listitem>
<simpara>Always set to <code>$Date: 2008-07-12 15:30:45 -0400
(Sat, 12 Jul 2008) $</code>, which is
expanded by CVS to include the date and time that the file
- was last modified.</simpara>
+ was last modified.<sbr/>
+ 总是被设置为 <code>$Date: 2008-07-12 15:30:45 -0400 (Sat, 12 Jul
2008) $</code>，它会被 CVS
+ 扩展为该文件最后修改的日期和时间。</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -113,23 +131,30 @@
library and the list of categorizations. The
<librarypurpose> element should always contain a very short
(single sentence) description of the library's purpose, and should
- <emphasis>not</emphasis> terminate with a period.</para>
+ <emphasis>not</emphasis> terminate with a period.<sbr/>
+ 在 <library> 元素内部，我们有 <libraryinfo> 元素，它给出关
于库本身的信息。
+ 它包含作者的姓名(可能有一个以上的 <author> 元素)，接着是库的用途
和分类列表。
+ <librarypurpose> 元素应包含一个关于库的用途的非常短的(单个句子)说
明，且不应以句号结束。</para>
<para>The list of categories is specified by a set of
<librarycategory> elements. Each <librarycategory>
element has a <code>name</code> element that identifies one of the
categories. The actual list of categories is in the file
- <filename>doc/src/boost.xml</filename>.
+ <filename>doc/src/boost.xml</filename>.<sbr/>
+ 分类列表由一组 <librarycategory> 元素指定。每个
<librarycategory> 元素有一个标识一种类别的
+ <code>name</code> 元素。现行的分类列表在文件
<filename>doc/src/boost.xml</filename> 中。
</para>
<para>At this point, we can apply the BoostBook XSL stylesheets to
<code>any.xml</code> (to DocBook) followed by a DocBook XSL
stylesheet to generate HTML output, as described in <xref
- linkend="boostbook.getting.started"/>.</para>
+ linkend="boostbook.getting.started"/>.<sbr/>
+ 到此为止，我们可以将 BoostBook XSL stylesheets 应用于
<code>any.xml</code> (至 DocBook)后跟 DocBook XSL stylesheet
+ 以生成 HTML 输出，正如 <xref linkend="boostbook.getting.started"/> 中所
描述的。</para>
</section>
<section>
- <title>From HTML to BoostBook</title>
+ <title>From HTML to BoostBook 从 HTML 到 BoostBook</title>
<para>Most library authors are comfortable with writing HTML
documentation. Writing <ulink
@@ -137,7 +162,11 @@
by extension, BoostBook documentation) is quite similar to writing
HTML, except that BoostBook uses different element names from HTML
(see <xref linkend="html.to.boostbook"/>) and BoostBook XML is a
- much more rigid format than HTML.</para>
+ much more rigid format than HTML.<sbr/>
+ 多数的库作者都乐于编写 HTML 文档。编写 <ulink
+ url="http://www.docbook.org";>DocBook</ulink> 文档(以及作为其扩展的
BoostBook 文档)与编写 HTML
+ 非常相似，除了 BoostBook 使用了与 HTML 不同的元素名(请见 <xref
linkend="html.to.boostbook"/>)，
+ 以及 BoostBook XML 具有比 HTML 更为严格的格式。</para>
<para>One of the easiest ways to convert HTML documentation into
BoostBook documentation is to use <ulink
@@ -146,7 +175,12 @@
are properly closed, then apply the transformations in <xref
linkend="html.to.boostbook"/> to the body of the XHTML
document. The following command uses HTML Tidy to transform HTML
- into valid XHTML:</para>
+ into valid XHTML:<sbr/>
+ 将 HTML 文档转换为 BoostBook 文档的一个最容易的方法是使用 <ulink
+ url="http://tidy.sourceforge.net/";>HTML Tidy</ulink> 来将你的 HTML
+ 转换为有效的 XHTML，以确保所有元素被正确关闭，然后将 <xref
+ linkend="html.to.boostbook"/> 中的转换应用于 XHTML 文档的 body。
+ 以下命令使用 HTML Tidy 来将 HTML 转换为 XHTML：</para>
<programlisting>
tidy -asxhtml input.html > output.xhtml</programlisting>
@@ -159,10 +193,13 @@
documentation for the library and to build alphabetical and
categorized lists of known libraries; similarly, tables of
contents are built automatically from the titles of sections in
- the BoostBook document.</para>
+ the BoostBook document.<sbr/>
+ 在将文档从 HTML 转换为 BoostBook 时，注意有些在 HTML 中必须手工维护的冗
余信息在 BoostBook 中是自动生成的：
+ 例如，在 <xref linkend="boostbook.defining"/> 中所描述的库类别、用途和
作者，这些信息即用在库的文档中，
+ 也用于构建已知库的字母序列表和分类列表；同样，目录也是由 BoostBook 文档
中各章节的题目自动构建。</para>
<table id="html.to.boostbook">
- <title>Converting HTML elements to BoostBook</title>
+ <title>Converting HTML elements to BoostBook 将 HTML 元素转换至
BoostBook</title>
<tgroup cols="2" align="left">
<thead>
<row>
@@ -226,8 +263,10 @@
</section>
<section id="boostbook.sectioning">
- <title>Sectioning in BoostBook</title>
- <para>"Sectioning" refers to organization of a document into separate
sections, each with a title, some text, and possibly subsections. Each
section is described in BoostBook via a <section> element. An
introduction section may look like this:</para>
+ <title>Sectioning in BoostBook 在 BoostBook 中的章节</title>
+ <para>"Sectioning" refers to organization of a document into separate
sections, each with a title, some text, and possibly subsections. Each
section is described in BoostBook via a <section> element. An
introduction section may look like this:<sbr/>
+ "分节" 是指将一个文档组织成各个独立的章节，每个章节有一个题目、一些文
本，还可能有子章节。
+ 每一个章节在 BoostBook 中以一个 <section> 元素表示。例如，一个"简
介"章节可能如下：</para>
<programlisting>
<section id="any.intro">
<title>Introduction</title>
@@ -248,7 +287,11 @@
<section> element gives a unique ID to each section, so that
it may later be identified for linking. It is suggested that all
IDs start with the short name of a library followed by a period,
- so that IDs do not conflict between libraries.</para>
+ so that IDs do not conflict between libraries.<sbr/>
+ <section> 元素包含了逻辑上组成某个章节的所有信息。章节的题目放在
<title>
+ 元素中，章节的内部可以有段落、程序、列表、表格或子章节。
<section> 元素的 id
+ 属性为每个章节给定一个唯一的 ID，这样以后可以作为链接的标识。建议所有
的 IDs
+ 都以库的短名加一个句号作为起始，这样不同库之间的 IDs 就不会冲突。
</para>
</section>
</chapter>
=======================================
--- /trunk/tools/boostbook/doc/reference.xml Mon Dec 28 23:05:14 2009
+++ /trunk/tools/boostbook/doc/reference.xml Mon Aug 16 23:44:54 2010
@@ -7,8 +7,85 @@
http://www.boost.org/LICENSE_1_0.txt)
-->
<chapter id="reference">
- <title>Reference</title>
- <para>Elements:<itemizedlist spacing="compact"><listitem><simpara><link
linkend="boostbook.dtd.access">Element <sgmltag>access</sgmltag> - Declares
an access specification for class
members</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.boostbook">Element <sgmltag>boostbook</sgmltag> -
Defines a BoostBook
book</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.class">Element <sgmltag>class</sgmltag> - Declares a
class or class template</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.class-specialization">Element
<sgmltag>class-specialization</sgmltag> - A specialization (partial or
full) of a class
template</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.code">Element <sgmltag>code</sgmltag> - Mimics the
<sgmltag>code</sgmltag> tag in
HTML</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.compile-fail-test">Element
<sgmltag>compile-fail-test</sgmltag> - A testcase that should fail to
compile</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.compile-test">Element
<sgmltag>compile-test</sgmltag> - A testcase that should compile
correctly</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.complexity">Element <sgmltag>complexity</sgmltag> -
The time/space/etc. complexity of a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.constructor">Element <sgmltag>constructor</sgmltag>
- Declares a constructor of the enclosing
class</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.copy-assignment">Element
<sgmltag>copy-assignment</sgmltag> - Declares a copy-assignment
operator</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.data-member">Element <sgmltag>data-member</sgmltag>
- Declares a data member of a
class</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.default">Element <sgmltag>default</sgmltag> - The
default value of a function or template
parameter</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.description">Element <sgmltag>description</sgmltag>
- Detailed description of a
construct</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.destructor">Element <sgmltag>destructor</sgmltag> -
Declares a destructor for the enclosing
class</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.effects">Element <sgmltag>effects</sgmltag> -
Declares the side effects of a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.enum">Element <sgmltag>enum</sgmltag> - Declares an
enumeration type</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.enumname">Element <sgmltag>enumname</sgmltag> -
References an enumeration type with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.enumvalue">Element <sgmltag>enumvalue</sgmltag> - A
single value of an
enumeration</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.free-function-group">Element
<sgmltag>free-function-group</sgmltag> - A set of functions that are
grouped together under one
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.function">Element <sgmltag>function</sgmltag> -
Declares a function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.functionname">Element
<sgmltag>functionname</sgmltag> - References a function with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.globalname">Element <sgmltag>globalname</sgmltag> -
References a global with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.header">Element <sgmltag>header</sgmltag> - Declares
a C++ header with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.headername">Element <sgmltag>headername</sgmltag> -
References a C++ header with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.if-fails">Element <sgmltag>if-fails</sgmltag> - What
it means when a testcase
fails</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.inherit">Element <sgmltag>inherit</sgmltag> -
Declares a base class of the enclosing class or
struct</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.lib">Element <sgmltag>lib</sgmltag> - A library
dependency</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.library">Element <sgmltag>library</sgmltag> -
Top-level element for a
library</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.library-reference">Element
<sgmltag>library-reference</sgmltag> - Declares the reference material for
a library</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.librarycategory">Element
<sgmltag>librarycategory</sgmltag> - Declares that the enclosing library is
in this category</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.librarycategorydef">Element
<sgmltag>librarycategorydef</sgmltag> - Defines a new library
category</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.librarycategorylist">Element
<sgmltag>librarycategorylist</sgmltag> - Categorized listing of
libraries</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.libraryinfo">Element <sgmltag>libraryinfo</sgmltag>
- Provides information about a
library</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.librarylist">Element <sgmltag>librarylist</sgmltag>
- Placeholder for an alphabetical list of
libraries</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.libraryname">Element <sgmltag>libraryname</sgmltag>
- References a library of the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.librarypurpose">Element
<sgmltag>librarypurpose</sgmltag> - Describes in one short sentence or
phrase the purpose of a
library</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.link-fail-test">Element
<sgmltag>link-fail-test</sgmltag> - Declares a test that should compile but
fail to link</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.link-test">Element <sgmltag>link-test</sgmltag> -
Declares a test that should compile and
link</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.macroname">Element <sgmltag>macroname</sgmltag> -
References a macro with the given
name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.method">Element <sgmltag>method</sgmltag> - Declares
a method, i.e., a member
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.method-group">Element
<sgmltag>method-group</sgmltag> - A set of methods that are grouped
together under one name</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.namespace">Element <sgmltag>namespace</sgmltag> -
Declares a namespace</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.notes">Element <sgmltag>notes</sgmltag> -
Non-normative notes about a function's
semantics</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.overloaded-function">Element
<sgmltag>overloaded-function</sgmltag> - An overloaded
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.overloaded-method">Element
<sgmltag>overloaded-method</sgmltag> - An overloaded
method</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.parameter">Element <sgmltag>parameter</sgmltag> - A
function parameter</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.paramtype">Element <sgmltag>paramtype</sgmltag> -
The type of a function
parameter</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.postconditions">Element
<sgmltag>postconditions</sgmltag> - Conditions that must hold after the
function returns</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.precondition">Element
<sgmltag>precondition</sgmltag> - Conditions that must be met prior to
executing a function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.programlisting">Element
<sgmltag>programlisting</sgmltag> - A sample of program
code</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.purpose">Element <sgmltag>purpose</sgmltag> - A
short description of an entity's
use</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.rationale">Element <sgmltag>rationale</sgmltag> -
Describes the rationale for a particular function's
design</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.requirement">Element <sgmltag>requirement</sgmltag>
- A requirement/property in the Jamfile for a
testcase</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.requires">Element <sgmltag>requires</sgmltag> -
Declares the requirements of a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.returns">Element <sgmltag>returns</sgmltag> -
Description of the return value of a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.run-fail-test">Element
<sgmltag>run-fail-test</sgmltag> - A testcase that should compile and link,
but fail on execution</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.run-test">Element <sgmltag>run-test</sgmltag> - A
testcase that should compile, link, and
execute</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.signature">Element <sgmltag>signature</sgmltag> -
One signature of an overloaded function or
method</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.snippet">Element <sgmltag>snippet</sgmltag> - Pulls
in a code snippet from a <sgmltag>programlisting</sgmltag>
element</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.source">Element <sgmltag>source</sgmltag> - Defines
source code for a test</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.specialization">Element
<sgmltag>specialization</sgmltag> - Defines the specialization arguments
for a class
specialization</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.static-constant">Element
<sgmltag>static-constant</sgmltag> - Declares a static constant, e.g.,
<code>const int foo =
5;</code>.</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.struct">Element <sgmltag>struct</sgmltag> - Declares
a C++ struct</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.struct-specialization">Element
<sgmltag>struct-specialization</sgmltag> - A specialization (full or
partial) of a struct
template</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.template">Element <sgmltag>template</sgmltag> -
Declares the template parameters of a class or
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.template-arg">Element
<sgmltag>template-arg</sgmltag> - A template argument in a
specialization</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.template-nontype-parameter">Element
<sgmltag>template-nontype-parameter</sgmltag> - A nontype template
parameter</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.template-type-parameter">Element
<sgmltag>template-type-parameter</sgmltag> - Declares a template type
parameter</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.template-varargs">Element
<sgmltag>template-varargs</sgmltag> - Declares a variable-length list of
template parameters</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.testsuite">Element <sgmltag>testsuite</sgmltag> -
Describes a library
testsuite</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.throws">Element <sgmltag>throws</sgmltag> -
Description of the exceptions thrown by a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.type">Element <sgmltag>type</sgmltag> - The type of
an element or return type of a
function</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.typedef">Element <sgmltag>typedef</sgmltag> -
Declares a typedef</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.union">Element <sgmltag>union</sgmltag> - Declares a
C++ union or union
template</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.union-specialization">Element
<sgmltag>union-specialization</sgmltag> - A specialization (full or
partial) of a union
template</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.using-class">Element <sgmltag>using-class</sgmltag>
- Injects the method and function names of a class into the local
scope</link></simpara></listitem><listitem><simpara><link
linkend="boostbook.dtd.using-namespace">Element
<sgmltag>using-namespace</sgmltag> - Injects the declared names from a
namespace into the local
scope</link></simpara></listitem></itemizedlist></para>
+ <title>Reference 参考手册</title>
+ <para>Elements: 元素：<itemizedlist spacing="compact">
+ <listitem><simpara><link linkend="boostbook.dtd.access">Element
<sgmltag>access</sgmltag> - Declares an access specification for class
members 为类成员声明一个访问规格</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.boostbook">Element
<sgmltag>boostbook</sgmltag> - Defines a BoostBook book 定义一本 BoostBook
书</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.class">Element
<sgmltag>class</sgmltag> - Declares a class or class template 声明一个类或类
模板</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.class-specialization">Element
<sgmltag>class-specialization</sgmltag> - A specialization (partial or
full) of a class template 类模板的特化(偏特化或全特化
)</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.code">Element
<sgmltag>code</sgmltag> - Mimics the <sgmltag>code</sgmltag> tag in HTML 模
仿 HTML 中的 code 标签</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.compile-fail-test">Element
<sgmltag>compile-fail-test</sgmltag> - A testcase that should fail to
compile 一个会编译失败的测试案例</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.compile-test">Element
<sgmltag>compile-test</sgmltag> - A testcase that should compile correctly
一个可以正确编译的测试案例</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.complexity">Element
<sgmltag>complexity</sgmltag> - The time/space/etc. complexity of a
function 一个函数的时间/空间/等的复杂度</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.constructor">Element
<sgmltag>constructor</sgmltag> - Declares a constructor of the enclosing
class 声明所属类的构造函数</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.copy-assignment">Element
<sgmltag>copy-assignment</sgmltag> - Declares a copy-assignment operator 声
明一个复制赋值操作符</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.data-member">Element
<sgmltag>data-member</sgmltag> - Declares a data member of a class 声明一个
类的数据成员</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.default">Element
<sgmltag>default</sgmltag> - The default value of a function or template
parameter 一个函数或模板的参数的缺省值</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.description">Element
<sgmltag>description</sgmltag> - Detailed description of a construct 一个结
构的详细说明</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.destructor">Element
<sgmltag>destructor</sgmltag> - Declares a destructor for the enclosing
class 声明所属类的析构函数</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.effects">Element
<sgmltag>effects</sgmltag> - Declares the side effects of a function 声明一
个函数的副作用</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.enum">Element
<sgmltag>enum</sgmltag> - Declares an enumeration type 声明一个枚举类型
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.enumname">Element
<sgmltag>enumname</sgmltag> - References an enumeration type with the given
name 引用一个给定名字的枚举类型 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.enumvalue">Element
<sgmltag>enumvalue</sgmltag> - A single value of an enumeration 枚举类型的单
个值 </link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.free-function-group">Element
<sgmltag>free-function-group</sgmltag> - A set of functions that are
grouped together under one name 在同一个名字之下的一组函数
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.function">Element
<sgmltag>function</sgmltag> - Declares a function 声明一个函数
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.functionname">Element
<sgmltag>functionname</sgmltag> - References a function with the given name
引用带给定名字的函数 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.globalname">Element
<sgmltag>globalname</sgmltag> - References a global with the given name 引用
一个给定名字的全局变量 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.header">Element
<sgmltag>header</sgmltag> - Declares a C++ header with the given name 声明给
定名字的一个C++头文件</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.headername">Element
<sgmltag>headername</sgmltag> - References a C++ header with the given name
引用一个给定名字的C++头文件</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.if-fails">Element
<sgmltag>if-fails</sgmltag> - What it means when a testcase fails 当一个测试
案例失败时意味着什么</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.inherit">Element
<sgmltag>inherit</sgmltag> - Declares a base class of the enclosing class
or struct 声明所属类或结构的基类</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.lib">Element
<sgmltag>lib</sgmltag> - A library dependency 一个库的依赖关系
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.library">Element
<sgmltag>library</sgmltag> - Top-level element for a library 一个库的顶层元
素</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.library-reference">Element
<sgmltag>library-reference</sgmltag> - Declares the reference material for
a library 声明一个库的参考材料</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.librarycategory">Element
<sgmltag>librarycategory</sgmltag> - Declares that the enclosing library is
in this category 声明所属类属于这一类别</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.librarycategorydef">Element
<sgmltag>librarycategorydef</sgmltag> - Defines a new library category 定义
一个新的库类别</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.librarycategorylist">Element
<sgmltag>librarycategorylist</sgmltag> - Categorized listing of libraries 库
的分类列表</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.libraryinfo">Element
<sgmltag>libraryinfo</sgmltag> - Provides information about a library 提供有
关一个库的信息</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.librarylist">Element
<sgmltag>librarylist</sgmltag> - Placeholder for an alphabetical list of
libraries 用于库的字母序列表的占位符</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.libraryname">Element
<sgmltag>libraryname</sgmltag> - References a library of the given name 引用
给定名字的库</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.librarypurpose">Element
<sgmltag>librarypurpose</sgmltag> - Describes in one short sentence or
phrase the purpose of a library 用一句短句或短语描述库的用途
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.link-fail-test">Element
<sgmltag>link-fail-test</sgmltag> - Declares a test that should compile but
fail to link 声明一个可以编译但不能链接的测试 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.link-test">Element
<sgmltag>link-test</sgmltag> - Declares a test that should compile and link
声明一个可以编译和链接的测试</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.macroname">Element
<sgmltag>macroname</sgmltag> - References a macro with the given name 引用一
个给定名字的宏</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.method">Element
<sgmltag>method</sgmltag> - Declares a method, i.e., a member function 声明
一个方法，即一个成员函数</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.method-group">Element
<sgmltag>method-group</sgmltag> - A set of methods that are grouped
together under one name 在同一个名字之下的一组方法
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.namespace">Element
<sgmltag>namespace</sgmltag> - Declares a namespace 声明一个名字空间
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.notes">Element
<sgmltag>notes</sgmltag> - Non-normative notes about a function's semantics
关于一个函数的语义的非标准化说明 </link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.overloaded-function">Element
<sgmltag>overloaded-function</sgmltag> - An overloaded function 一个重载的函
数</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.overloaded-method">Element
<sgmltag>overloaded-method</sgmltag> - An overloaded method 一个重载的方法
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.parameter">Element
<sgmltag>parameter</sgmltag> - A function parameter 一个函数参数
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.paramtype">Element
<sgmltag>paramtype</sgmltag> - The type of a function parameter 函数参数的类
型 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.postconditions">Element
<sgmltag>postconditions</sgmltag> - Conditions that must hold after the
function returns 在函数返回后必须满足的条件 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.precondition">Element
<sgmltag>precondition</sgmltag> - Conditions that must be met prior to
executing a function 在执行函数前必须被满足的条件
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.programlisting">Element
<sgmltag>programlisting</sgmltag> - A sample of program code 程序代码示例
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.purpose">Element
<sgmltag>purpose</sgmltag> - A short description of an entity's use 一个实体
用途的简短描述 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.rationale">Element
<sgmltag>rationale</sgmltag> - Describes the rationale for a particular
function's design 描述一个特定函数设计的原理 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.requirement">Element
<sgmltag>requirement</sgmltag> - A requirement/property in the Jamfile for
a testcase 一个测试案例的 Jamfile 中的要求/属性</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.requires">Element
<sgmltag>requires</sgmltag> - Declares the requirements of a function 声明一
个函数的要求</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.returns">Element
<sgmltag>returns</sgmltag> - Description of the return value of a function
一个函数的返回值的说明 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.run-fail-test">Element
<sgmltag>run-fail-test</sgmltag> - A testcase that should compile and link,
but fail on execution 一个可以编译和链接，但执行失败的测试案例
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.run-test">Element
<sgmltag>run-test</sgmltag> - A testcase that should compile, link, and
execute 一个可以编译、链接和执行成功的测试案例 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.signature">Element
<sgmltag>signature</sgmltag> - One signature of an overloaded function or
method 一个重载函数或方法的签名</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.snippet">Element
<sgmltag>snippet</sgmltag> - Pulls in a code snippet from a
<sgmltag>programlisting</sgmltag> element 从一个
<sgmltag>programlisting</sgmltag> 元素取出的代码片断
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.source">Element
<sgmltag>source</sgmltag> - Defines source code for a test 定义一个测试的源
代码 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.specialization">Element
<sgmltag>specialization</sgmltag> - Defines the specialization arguments
for a class specialization 为一个特化类定义特化的参数
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.static-constant">Element
<sgmltag>static-constant</sgmltag> - Declares a static constant, e.g.,
<code>const int foo = 5;</code>. 定义一个静态常数，如 <code>const int foo =
5;</code> </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.struct">Element
<sgmltag>struct</sgmltag> - Declares a C++ struct 声明一个C++结构
</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.struct-specialization">Element
<sgmltag>struct-specialization</sgmltag> - A specialization (full or
partial) of a struct template 一个结构模板的特化(全特化或偏特化)
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.template">Element
<sgmltag>template</sgmltag> - Declares the template parameters of a class
or function 声明一个类或函数的模板参数</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.template-arg">Element
<sgmltag>template-arg</sgmltag> - A template argument in a specialization 在
一个特化中的模板参数</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.template-nontype-parameter">Element
<sgmltag>template-nontype-parameter</sgmltag> - A nontype template
parameter 一个非类型模板参数</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.template-type-parameter">Element
<sgmltag>template-type-parameter</sgmltag> - Declares a template type
parameter 声明一个模板类型参数 </link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.template-varargs">Element
<sgmltag>template-varargs</sgmltag> - Declares a variable-length list of
template parameters 声明一个可变长度的模板参数列表
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.testsuite">Element
<sgmltag>testsuite</sgmltag> - Describes a library testsuite 描述一个库的测
试套件</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.throws">Element
<sgmltag>throws</sgmltag> - Description of the exceptions thrown by a
function 对由一个函数抛出的异常的说明</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.type">Element
<sgmltag>type</sgmltag> - The type of an element or return type of a
function 一个元素的类型或一个函数的返回类型 </link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.typedef">Element
<sgmltag>typedef</sgmltag> - Declares a typedef 声明一个 typedef
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.union">Element
<sgmltag>union</sgmltag> - Declares a C++ union or union template 声明一个
C++联合或联合模板</link></simpara></listitem>
+ <listitem><simpara><link
linkend="boostbook.dtd.union-specialization">Element
<sgmltag>union-specialization</sgmltag> - A specialization (full or
partial) of a union template 一个联合模板的特化(全特化或偏特化)
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.using-class">Element
<sgmltag>using-class</sgmltag> - Injects the method and function names of a
class into the local scope 将一个类的方法或函数名注入到本地作用域
</link></simpara></listitem>
+ <listitem><simpara><link linkend="boostbook.dtd.using-namespace">Element
<sgmltag>using-namespace</sgmltag> - Injects the declared names from a
namespace into the local scope 将声明的名字从一个名字空间注入到本地作用域
</link></simpara></listitem></itemizedlist></para>
<refentry id="boostbook.dtd.class-specialization">
<refmeta>
<refentrytitle>
@@ -17,7 +94,7 @@
</refmeta>
<refnamediv>
<refname>class-specialization</refname>
- <refpurpose>A specialization (partial or full) of a class
template</refpurpose>
+ <refpurpose>A specialization (partial or full) of a class template 一
个类模板的特化(偏特化或全特化)</refpurpose>
</refnamediv>
<refsynopsisdiv>class-specialization ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link
linkend="boostbook.dtd.specialization">specialization</link>?, <link
linkend="boostbook.dtd.inherit">inherit</link>?, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, (<link
linkend="boostbook.dtd.access">access</link>| <link
linkend="boostbook.dtd.static-constant">static-constant</link>| <link
linkend="boostbook.dtd.typedef">typedef</link>| <link
linkend="boostbook.dtd.enum">enum</link>| <link
linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link
linkend="boostbook.dtd.constructor">constructor</link>| <link
linkend="boostbook.dtd.destructor">destructor</link>| <link
linkend="boostbook.dtd.method-group">method-group</link>| <link
linkend="boostbook.dtd.free-function-group">free-function-group</link>|
<link linkend="boostbook.dtd.function">function</link>| <link
linkend="boostbook.dtd.method">method</link>| <link
linkend="boostbook.dtd.overloaded-function">overloaded-function</link>|
<link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>|
<link linkend="boostbook.dtd.data-member">data-member</link>| <link
linkend="boostbook.dtd.class">class</link>| <link
linkend="boostbook.dtd.class-specialization">class-specialization</link>|
<link linkend="boostbook.dtd.struct">struct</link>| <link
linkend="boostbook.dtd.struct-specialization">struct-specialization</link>|
<link linkend="boostbook.dtd.union">union</link>| <link
linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
@@ -36,10 +113,12 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>
+被声明为被引用元素的名字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -53,7 +132,7 @@
</refmeta>
<refnamediv>
<refname>link-test</refname>
- <refpurpose>Declares a test that should compile and link</refpurpose>
+ <refpurpose>Declares a test that should compile and link 声明一个可以
编译和链接的测试</refpurpose>
</refnamediv>
<refsynopsisdiv>link-test ::=
(<link linkend="boostbook.dtd.source">source</link>*, <link
linkend="boostbook.dtd.lib">lib</link>*, <link
linkend="boostbook.dtd.requirement">requirement</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>, <link
linkend="boostbook.dtd.if-fails">if-fails</link>?)
@@ -72,8 +151,10 @@
</thead>
<tbody>
-<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element</entry></row>
-<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
+<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element<sbr/>
+与该元素相关联的文件的名字与该元素相关联的文件的名字</entry></row>
+<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>
+被声明为被引用元素的名字</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -87,7 +168,7 @@
</refmeta>
<refnamediv>
<refname>link-fail-test</refname>
- <refpurpose>Declares a test that should compile but fail to
link</refpurpose>
+ <refpurpose>Declares a test that should compile but fail to link 声明
一个可以编译但不能链接的测试</refpurpose>
</refnamediv>
<refsynopsisdiv>link-fail-test ::=
(<link linkend="boostbook.dtd.source">source</link>*, <link
linkend="boostbook.dtd.lib">lib</link>*, <link
linkend="boostbook.dtd.requirement">requirement</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>, <link
linkend="boostbook.dtd.if-fails">if-fails</link>?)
@@ -106,8 +187,10 @@
</thead>
<tbody>
-<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element</entry></row>
-<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
+<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element<sbr/>
+与该元素相关联的文件的名字</entry></row>
+<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>
+被声明为被引用元素的名字</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -121,7 +204,7 @@
</refmeta>
<refnamediv>
<refname>typedef</refname>
- <refpurpose>Declares a typedef</refpurpose>
+ <refpurpose>Declares a typedef 声明一个 typedef</refpurpose>
</refnamediv>
<refsynopsisdiv>typedef ::=
(<link linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?)
@@ -140,10 +223,12 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>
+被声明为被引用元素的名字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -157,7 +242,7 @@
</refmeta>
<refnamediv>
<refname>static-constant</refname>
- <refpurpose>Declares a static constant, e.g., <code>const int foo =
5;</code>.</refpurpose>
+ <refpurpose>Declares a static constant, e.g., <code>const int foo =
5;</code>. 声明一个静态常量，如 <code>const int foo =
5;</code>.</refpurpose>
</refnamediv>
<refsynopsisdiv>static-constant ::=
(<link linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.default">default</link>, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?)
@@ -176,10 +261,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -193,7 +279,7 @@
</refmeta>
<refnamediv>
<refname>code</refname>
- <refpurpose>Mimics the <sgmltag>code</sgmltag> tag in
HTML</refpurpose>
+ <refpurpose>Mimics the <sgmltag>code</sgmltag> tag in HTML 模仿 HTML
中的 <sgmltag>code</sgmltag> 标签</refpurpose>
</refnamediv>
<refsynopsisdiv>code ::=
(ANY)
@@ -202,7 +288,9 @@
<para>Text within a <sgmltag>code</sgmltag> tag is generally typeset
in a different, monospaced font so that it stands out as code. The
<sgmltag>code</sgmltag> tag in BoostBook is transformed directly
- into the <sgmltag>computeroutput</sgmltag> tag in DocBook.</para>
+ into the <sgmltag>computeroutput</sgmltag> tag in DocBook.<sbr/>
+ <sgmltag>code</sgmltag> 标签内的文本通常都被排版为一种特别的、等宽的字
体，这样看起来更象代码。
+ 在 BoostBook 中的 <sgmltag>code</sgmltag> 标签会被直接转换为 DocBook 中
的 <sgmltag>computeroutput</sgmltag> 标签。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -218,9 +306,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -234,7 +323,7 @@
</refmeta>
<refnamediv>
<refname>destructor</refname>
- <refpurpose>Declares a destructor for the enclosing
class</refpurpose>
+ <refpurpose>Declares a destructor for the enclosing class 声明所属类
的析构函数</refpurpose>
</refnamediv>
<refsynopsisdiv>destructor ::=
(<link linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, <link
linkend="boostbook.dtd.requires">requires</link>?, <link
linkend="boostbook.dtd.effects">effects</link>?, <link
linkend="boostbook.dtd.postconditions">postconditions</link>?, <link
linkend="boostbook.dtd.returns">returns</link>?, <link
linkend="boostbook.dtd.throws">throws</link>?, <link
linkend="boostbook.dtd.complexity">complexity</link>?, <link
linkend="boostbook.dtd.notes">notes</link>?, <link
linkend="boostbook.dtd.rationale">rationale</link>?)
@@ -242,7 +331,8 @@
<refsection><title>Description</title>
<para>General documentation on functions in BoostBook is provided in
the <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
- element documentation.</para>
+ element documentation.<sbr/>
+ BoostBook 中的函数的一般文档在 <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link> 元素文档
中提供。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -258,10 +348,12 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.<sbr/>
+该函数的指示符，如 inline, static, 等等</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -275,7 +367,7 @@
</refmeta>
<refnamediv>
<refname>template-type-parameter</refname>
- <refpurpose>Declares a template type parameter</refpurpose>
+ <refpurpose>Declares a template type parameter 声明一个模板类型参数
</refpurpose>
</refnamediv>
<refsynopsisdiv>template-type-parameter ::=
(<link linkend="boostbook.dtd.default">default</link>?, <link
linkend="boostbook.dtd.purpose">purpose</link>?)
@@ -294,11 +386,13 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>pack</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to '1'
if the parameter is a parameter pack.</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>pack</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to '1'
if the parameter is a parameter pack.<sbr/>
+如果参数是一个参数包，则设置为 '1'</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -312,7 +406,7 @@
</refmeta>
<refnamediv>
<refname>description</refname>
- <refpurpose>Detailed description of a construct</refpurpose>
+ <refpurpose>Detailed description of a construct 一个结构的详细说明
</refpurpose>
</refnamediv>
<refsynopsisdiv>description ::=
(ANY)
@@ -324,7 +418,10 @@
(<sgmltag>para</sgmltag>, <sgmltag>simpara</sgmltag>), lists
(<sgmltag>orderedlist</sgmltag>, <sgmltag>itemizedlist</sgmltag>),
tables (<sgmltag>informaltable</sgmltag>, <sgmltag>table</sgmltag>),
- etc.</para>
+ etc.<sbr/>
+ 虽然该元素的上下文模型是 <code>ANY</code>，但是详细的说明应包括出现在一个
章节中的结构化 DocBook
+ 元素，如段落(<sgmltag>para</sgmltag>, <sgmltag>simpara</sgmltag>)，列表
(<sgmltag>orderedlist</sgmltag>,
+ <sgmltag>itemizedlist</sgmltag>)，表格(<sgmltag>informaltable</sgmltag>,
<sgmltag>table</sgmltag>)，等等。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -340,9 +437,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -356,13 +454,14 @@
</refmeta>
<refnamediv>
<refname>librarylist</refname>
- <refpurpose>Placeholder for an alphabetical list of
libraries</refpurpose>
+ <refpurpose>Placeholder for an alphabetical list of libraries 库的字
母序列表所用的占位符</refpurpose>
</refnamediv>
<refsynopsisdiv>librarylist ::=
EMPTY
</refsynopsisdiv>
<refsection><title>Description</title>
- <para>Developers aren't generally expected to use this element. Its
existence is mainly as a placeholder in <filename>boost.xml</filename> for
the alphabetical list of libraries.</para>
+ <para>Developers aren't generally expected to use this element. Its
existence is mainly as a placeholder in <filename>boost.xml</filename> for
the alphabetical list of libraries.<sbr/>
+ 开发者通常不需要使用这一元素。它的存在主要是库的字母序列表所使用的在
<filename>boost.xml</filename> 中的占位符。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -378,9 +477,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -394,7 +494,7 @@
</refmeta>
<refnamediv>
<refname>library-reference</refname>
- <refpurpose>Declares the reference material for a
library</refpurpose>
+ <refpurpose>Declares the reference material for a library 声明一个库
的参考资料</refpurpose>
</refnamediv>
<refsynopsisdiv>library-reference ::=
(title?, section*, (<link linkend="boostbook.dtd.header">header</link>|
<link linkend="boostbook.dtd.library-reference">library-reference</link>)*)
@@ -403,7 +503,9 @@
<para>Reference documentation for a library is contained with a
<library-reference> element. The <library-reference>
element has no attributes, and contains as children only
- <header> elements.</para>
+ <header> elements.<sbr/>
+ 一个库的参考资料以一个 <library-reference> 元素包含。
+ <library-reference> 元素没有属性，只包含一个 <header> 元素。
</para>
<para>The <header> element defines a C++ header file. Within
each C++ header file lie the definitions of C++ constructs to be
@@ -411,7 +513,10 @@
element gives the name of the header, as one would specify when
including the header. For instance, the <library-reference>
for the <libraryname>Any</libraryname> library may look like
- this:</para>
+ this:<sbr/>
+ <header> 元素定义了一个 C++ 头文件。在每个 C++ 头文件内部是被文档化
的 C++ 结构的定义。
+ <header> 元素的 <code>name</code> 属性给出了头文件的名字，正如你在
包含该头文件时要指定的一样。
+ 例如，对 <libraryname>Any</libraryname> 库的 <library-reference> 如
下：</para>
<programlisting><library-reference>
<header name="boost/any.hpp">
@@ -421,11 +526,13 @@
<para>If the <libraryname>Any</libraryname> library contained
multiple headers, we would list them all as children of the
- <library-reference> element.</para>
+ <library-reference> element.<sbr/>
+ 如果 <libraryname>Any</libraryname> 库包含多个头文件，我们应该把它们全部
列在 <library-reference> 元素中。</para>
<para><sgmltag>library-reference</sgmltag> elements can be nested,
so that reference material can be divided into separate sections
- that each contain different headers.</para>
+ that each contain different headers.<sbr/>
+ <sgmltag>library-reference</sgmltag> 元素可以嵌套，所以参考资料可以被分为
多个独立章节，每个章节包含不同的头文件。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -441,9 +548,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -457,7 +565,7 @@
</refmeta>
<refnamediv>
<refname>boostbook</refname>
- <refpurpose>Defines a BoostBook book</refpurpose>
+ <refpurpose>Defines a BoostBook book 定义一本 BoostBook 书
</refpurpose>
</refnamediv>
<refsynopsisdiv>boostbook ::=
(title, (chapter| <link linkend="boostbook.dtd.library">library</link>)*)
@@ -465,7 +573,8 @@
<refsection><title>Description</title>
<simpara>This element is the topmost level defined by
<filename>boost.xml</filename> for all Boost documentation. It will
- not generally be used by developers.</simpara>
+ not generally be used by developers.<sbr/>
+ 对于所有 Boost 文档，这一元素是由 <filename>boost.xml</filename> 定义的最
顶层元素。它通常不被开发者使用。</simpara>
</refsection>
<refsection>
<title>Attributes</title>
@@ -481,9 +590,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -497,7 +607,7 @@
</refmeta>
<refnamediv>
<refname>union</refname>
- <refpurpose>Declares a C++ union or union template</refpurpose>
+ <refpurpose>Declares a C++ union or union template 声明一个 C++ 联合
或联合模板</refpurpose>
</refnamediv>
<refsynopsisdiv>union ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link
linkend="boostbook.dtd.inherit">inherit</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, (<link
linkend="boostbook.dtd.access">access</link>| <link
linkend="boostbook.dtd.static-constant">static-constant</link>| <link
linkend="boostbook.dtd.typedef">typedef</link>| <link
linkend="boostbook.dtd.enum">enum</link>| <link
linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link
linkend="boostbook.dtd.constructor">constructor</link>| <link
linkend="boostbook.dtd.destructor">destructor</link>| <link
linkend="boostbook.dtd.method-group">method-group</link>| <link
linkend="boostbook.dtd.free-function-group">free-function-group</link>|
<link linkend="boostbook.dtd.function">function</link>| <link
linkend="boostbook.dtd.method">method</link>| <link
linkend="boostbook.dtd.overloaded-function">overloaded-function</link>|
<link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>|
<link linkend="boostbook.dtd.data-member">data-member</link>| <link
linkend="boostbook.dtd.class">class</link>| <link
linkend="boostbook.dtd.class-specialization">class-specialization</link>|
<link linkend="boostbook.dtd.struct">struct</link>| <link
linkend="boostbook.dtd.struct-specialization">struct-specialization</link>|
<link linkend="boostbook.dtd.union">union</link>| <link
linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
@@ -516,10 +626,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -533,13 +644,14 @@
</refmeta>
<refnamediv>
<refname>inherit</refname>
- <refpurpose>Declares a base class of the enclosing class or
struct</refpurpose>
+ <refpurpose>Declares a base class of the enclosing class or struct 声
明所属类或结构的一个基类</refpurpose>
</refnamediv>
<refsynopsisdiv>inherit ::=
(<link linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection><title>Description</title>
- <para>This element contains the type of the class inherited.</para>
+ <para>This element contains the type of the class inherited.<sbr/>
+ 该元素包含所继承类的类型。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -555,11 +667,12 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
<row><entry>access</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
access specifier ("public", "private", or "protected") of the
inheritance.</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
<row><entry>pack</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to '1' if this is a pack exapansion.</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -573,7 +686,7 @@
</refmeta>
<refnamediv>
<refname>template-varargs</refname>
- <refpurpose>Declares a variable-length list of template
parameters</refpurpose>
+ <refpurpose>Declares a variable-length list of template parameters 声
明一个可变长度的模板参数列表</refpurpose>
</refnamediv>
<refsynopsisdiv>template-varargs ::=
EMPTY
@@ -583,7 +696,9 @@
C++, but because they are sometimes needed in documentation they are
allowed in BoostBook. This element generally expands to "..." and
can be used anywhere any other template parameter can be
- used.</para>
+ used.<sbr/>
+ 可变长度的模板参数列表在C++中并不被允许，但是由于它们在文档中有时候是需要
的，所以在 BoostBook 中是可用的。
+ 该元素通常扩展为 "..."，可以在任何其它模板参数可用的地方使用。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -599,9 +714,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -615,14 +731,15 @@
</refmeta>
<refnamediv>
<refname>source</refname>
- <refpurpose>Defines source code for a test</refpurpose>
+ <refpurpose>Defines source code for a test 定义一个测试的源代码
</refpurpose>
</refnamediv>
<refsynopsisdiv>source ::=
(#PCDATA| <link linkend="boostbook.dtd.snippet">snippet</link>)*
</refsynopsisdiv>
<refsection><title>Description</title>
<para>This element will contain the source code for a testcase that
- will be generated from the documentation. To reduce the amount of
escaping in the text, it is recommended to use CDATA sections, which look
like this:
+ will be generated from the documentation. To reduce the amount of
escaping in the text, it is recommended to use CDATA sections, which look
like this:<sbr/>
+ 该元素包含从文档生成的测试案例的源代码。为减少文本中的转义符数量，建议使
用 CDATA 节，如下：
<programlisting><![CDATA[
<your program text here: no escaping needed!>
@@ -631,7 +748,9 @@
<para>In addition to CDATA sections, code snippets can be pulled in
from <sgmltag>programlisting</sgmltag> elements using the <link
linkend="boostbook.dtd.snippet"><sgmltag>snippet</sgmltag></link>
- element.</para>
+ element.<sbr/>
+ 除了 CDATA 节，代码片断也可以使用 <link
linkend="boostbook.dtd.snippet"><sgmltag>snippet</sgmltag></link>
+ 元素从 <sgmltag>programlisting</sgmltag> 元素中取出。</para>
</refsection>
</refentry>
<refentry id="boostbook.dtd.function">
@@ -642,7 +761,7 @@
</refmeta>
<refnamediv>
<refname>function</refname>
- <refpurpose>Declares a function</refpurpose>
+ <refpurpose>Declares a function 声明一个函数</refpurpose>
</refnamediv>
<refsynopsisdiv>function ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link
linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.parameter">parameter</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, <link
linkend="boostbook.dtd.requires">requires</link>?, <link
linkend="boostbook.dtd.effects">effects</link>?, <link
linkend="boostbook.dtd.postconditions">postconditions</link>?, <link
linkend="boostbook.dtd.returns">returns</link>?, <link
linkend="boostbook.dtd.throws">throws</link>?, <link
linkend="boostbook.dtd.complexity">complexity</link>?, <link
linkend="boostbook.dtd.notes">notes</link>?, <link
linkend="boostbook.dtd.rationale">rationale</link>?)
@@ -652,19 +771,25 @@
function's interface (e.g., its C++ signature) and its
behavior. Constructors, destructors, member functions, and free
functions all use the same documentation method, although the
- top-level tags differ.</para>
+ top-level tags differ.<sbr/>
+ BoostBook 中的函数通过指定函数的接口(如它的 C++ 签名)及其行为来文档化。
+ 构造函数、析构函数、成员函数和普通函数都使用相同的文档化方法，虽然它们的
顶层标签不相同。</para>
<para>The behavior of functions in BoostBook is documenting using a
style similar to that of the C++ standard, with clauses describing
the requirements, effects, postconditions, exception behavior, and
- return values of functions.</para>
+ return values of functions.<sbr/>
+ 在 BoostBook 中，函数的行为是以类似于C++标准的方式来记录的，以各个子句来
描述函数的要求、作用、后置条件、异常行为和返回值。</para>
<para>The following example illustrates some constructors and a
destructor for <classname>boost::any</classname>. Note that one of
the constructors takes a single parameter whose name is "other" and
whose type, <code>const any&</code> is contained in the
<paramtype> element; any number of parameters may be specified
- in this way.</para>
+ in this way.<sbr/>
+ 以下例子示范了 <classname>boost::any</classname> 的一些构造函数和析构函
数。
+ 注意，其中一个构造函数接受单个参数，参数名为 "other"，参数的类型为
+ <code>const any&</code>，在 <paramtype> 元素中包含；以这种方式
可以指定任意数量的参数。</para>
<programlisting><class name="any">
<constructor>
@@ -717,11 +842,13 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.<sbr/>
+该函数的指示符，如 inline, static, 等等</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -754,9 +881,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
<row><entry>alt</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -770,7 +898,7 @@
</refmeta>
<refnamediv>
<refname>postconditions</refname>
- <refpurpose>Conditions that must hold after the function
returns</refpurpose>
+ <refpurpose>Conditions that must hold after the function returns 在函
数返回后必须满足的条件</refpurpose>
</refnamediv>
<refsynopsisdiv>postconditions ::=
(ANY)
@@ -789,9 +917,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -805,7 +934,7 @@
</refmeta>
<refnamediv>
<refname>compile-test</refname>
- <refpurpose>A testcase that should compile correctly</refpurpose>
+ <refpurpose>A testcase that should compile correctly 一个可以正确编译
的测试案例</refpurpose>
</refnamediv>
<refsynopsisdiv>compile-test ::=
(<link linkend="boostbook.dtd.source">source</link>*, <link
linkend="boostbook.dtd.lib">lib</link>*, <link
linkend="boostbook.dtd.requirement">requirement</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>, <link
linkend="boostbook.dtd.if-fails">if-fails</link>?)
@@ -824,8 +953,9 @@
</thead>
<tbody>
-<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element</entry></row>
-<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
+<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the file associated with this element<sbr/>
+与该元素相关联的文件的名字</entry></row>
+<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -839,7 +969,7 @@
</refmeta>
<refnamediv>
<refname>method</refname>
- <refpurpose>Declares a method, i.e., a member function</refpurpose>
+ <refpurpose>Declares a method, i.e., a member function 声明一个方
法，即一个成员函数</refpurpose>
</refnamediv>
<refsynopsisdiv>method ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link
linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.parameter">parameter</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, <link
linkend="boostbook.dtd.requires">requires</link>?, <link
linkend="boostbook.dtd.effects">effects</link>?, <link
linkend="boostbook.dtd.postconditions">postconditions</link>?, <link
linkend="boostbook.dtd.returns">returns</link>?, <link
linkend="boostbook.dtd.throws">throws</link>?, <link
linkend="boostbook.dtd.complexity">complexity</link>?, <link
linkend="boostbook.dtd.notes">notes</link>?, <link
linkend="boostbook.dtd.rationale">rationale</link>?)
@@ -847,7 +977,8 @@
<refsection><title>Description</title>
<para>General documentation on functions in BoostBook is provided in
the <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
- element documentation.</para>
+ element documentation.<sbr/>
+ 在 BoostBook 中的对函数的一般文档是在 <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link> 元素中提
供。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -863,12 +994,15 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>cv</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>cv-qualifiers
for
this method, e.g., const volatile</entry></row>
-<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>cv</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>cv-qualifiers
for
this method, e.g., const volatile<sbr/>
+该方法的cv限定符，如 const volatile</entry></row>
+<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.<sbr/>
+该函数的指示符，如 inline, static, 等等</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -882,7 +1016,8 @@
</refmeta>
<refnamediv>
<refname>snippet</refname>
- <refpurpose>Pulls in a code snippet from a
<sgmltag>programlisting</sgmltag> element</refpurpose>
+ <refpurpose>Pulls in a code snippet from a
<sgmltag>programlisting</sgmltag> element
+ 从一个 <sgmltag>programlisting</sgmltag> 元素中取出一个代码片断
</refpurpose>
</refnamediv>
<refsynopsisdiv>snippet ::=
EMPTY
@@ -901,7 +1036,8 @@
</thead>
<tbody>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the <sgmltag>programlisting</sgmltag> element to
insert</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the <sgmltag>programlisting</sgmltag> element to insert<sbr/>
+插入的 <sgmltag>programlisting</sgmltag> 元素的名字</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -915,7 +1051,7 @@
</refmeta>
<refnamediv>
<refname>constructor</refname>
- <refpurpose>Declares a constructor of the enclosing
class</refpurpose>
+ <refpurpose>Declares a constructor of the enclosing class 声明所属类
的一个构造函数</refpurpose>
</refnamediv>
<refsynopsisdiv>constructor ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link
linkend="boostbook.dtd.parameter">parameter</link>*, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?, <link
linkend="boostbook.dtd.requires">requires</link>?, <link
linkend="boostbook.dtd.effects">effects</link>?, <link
linkend="boostbook.dtd.postconditions">postconditions</link>?, <link
linkend="boostbook.dtd.returns">returns</link>?, <link
linkend="boostbook.dtd.throws">throws</link>?, <link
linkend="boostbook.dtd.complexity">complexity</link>?, <link
linkend="boostbook.dtd.notes">notes</link>?, <link
linkend="boostbook.dtd.rationale">rationale</link>?)
@@ -923,7 +1059,8 @@
<refsection><title>Description</title>
<para>General documentation on functions in BoostBook is provided in
the <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
- element documentation.</para>
+ element documentation.<sbr/>
+ 在 BoostBook 中的对函数的一般文档是在 <link
linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link> 元素中提
供。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -939,10 +1076,12 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.<sbr/>
+该函数的指示符，如 inline, static, 等等</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -956,7 +1095,7 @@
</refmeta>
<refnamediv>
<refname>namespace</refname>
- <refpurpose>Declares a namespace</refpurpose>
+ <refpurpose>Declares a namespace 声明一个名字空间</refpurpose>
</refnamediv>
<refsynopsisdiv>namespace ::=
(<link linkend="boostbook.dtd.class">class</link>| <link
linkend="boostbook.dtd.class-specialization">class-specialization</link>|
<link linkend="boostbook.dtd.struct">struct</link>| <link
linkend="boostbook.dtd.struct-specialization">struct-specialization</link>|
<link linkend="boostbook.dtd.union">union</link>| <link
linkend="boostbook.dtd.union-specialization">union-specialization</link>|
<link linkend="boostbook.dtd.typedef">typedef</link>| <link
linkend="boostbook.dtd.enum">enum</link>| <link
linkend="boostbook.dtd.free-function-group">free-function-group</link>|
<link linkend="boostbook.dtd.function">function</link>| <link
linkend="boostbook.dtd.overloaded-function">overloaded-function</link>|
<link linkend="boostbook.dtd.namespace">namespace</link>)*
@@ -967,7 +1106,10 @@
constructs, such as classes or functions. The <code>name</code>
attribute of a <namespace> element gives the namespace name
(e.g., "boost"). The <libraryname>Any</libraryname> library is
- defined entirely within namespace boost by:</para>
+ defined entirely within namespace boost by:<sbr/>
+ BoostBook 名字空间通过 <namespace> 元素声明。和 C++ 一样，名字空间
可以嵌套，可以包含其它 C++ 结构，如类或函数。
+ <namespace><namespace> 元素的 <code>name</code> 属性给出名字
空间的名字(如 "boost")。
+ 以下将 <libraryname>Any</libraryname> 库定义在名字空间 boost 内：</para>
<programlisting><library-reference>
<header name="boost/any.hpp">
@@ -991,10 +1133,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1008,7 +1151,7 @@
</refmeta>
<refnamediv>
<refname>if-fails</refname>
- <refpurpose>What it means when a testcase fails</refpurpose>
+ <refpurpose>What it means when a testcase fails 当一个测试案例失败时
意味着什么</refpurpose>
</refnamediv>
<refsynopsisdiv>if-fails ::=
(ANY)
@@ -1019,7 +1162,9 @@
have on the usefulness of a library. This field is useful in cases
where a failed testcase does not mean that the library won't be
useful, but may mean that certain library features will not be
- available.
+ available.<sbr/>
+ 向用户说明某个特定失败测试案例对于库有何作用。
+ 当一个失败测试案例并不是表示该库不可使用，而是表示该库某个特性不可用
时，这一字段就很有用了。
</para>
</refsection>
</refentry>
@@ -1050,9 +1195,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
<row><entry>alt</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1066,7 +1212,7 @@
</refmeta>
<refnamediv>
<refname>free-function-group</refname>
- <refpurpose>A set of functions that are grouped together under one
name</refpurpose>
+ <refpurpose>A set of functions that are grouped together under one
name 在同一个名字下的一组函数</refpurpose>
</refnamediv>
<refsynopsisdiv>free-function-group ::=
(<link linkend="boostbook.dtd.function">function</link>| <link
linkend="boostbook.dtd.overloaded-function">overloaded-function</link>)*
@@ -1085,10 +1231,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1102,7 +1249,7 @@
</refmeta>
<refnamediv>
<refname>functionname</refname>
- <refpurpose>References a function with the given name</refpurpose>
+ <refpurpose>References a function with the given name 引用一个给定名
字的函数</refpurpose>
</refnamediv>
<refsynopsisdiv>functionname ::=
(#PCDATA)
@@ -1113,7 +1260,11 @@
function. Lookups obey currently-active <link
linkend="boostbook.dtd.using-class"><sgmltag>using-class</sgmltag></link>
and <link
linkend="boostbook.dtd.using-namespace"><sgmltag>using-namespace</sgmltag></link>
directives to aid in the search, along with searching within the
- current scope.</para>
+ current scope.<sbr/>
+ 如果找到一个具有给定的、可能带有限定符的名字的函数(或重载函数)，将生成到
此函数的一个链接。
+ 查找按照当前活动的 <link
linkend="boostbook.dtd.using-class"><sgmltag>using-class</sgmltag></link>
+ 和 <link
linkend="boostbook.dtd.using-namespace"><sgmltag>using-namespace</sgmltag></link>
+ 指示符来进行搜索，并在当前作用域内搜索。</para>
</refsection>
<refsection>
<title>Attributes</title>
@@ -1129,10 +1280,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
<row><entry>alt</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1146,7 +1298,7 @@
</refmeta>
<refnamediv>
<refname>librarycategory</refname>
- <refpurpose>Declares that the enclosing library is in this
category</refpurpose>
+ <refpurpose>Declares that the enclosing library is in this category
声明所属库在此类别中</refpurpose>
</refnamediv>
<refsynopsisdiv>librarycategory ::=
(#PCDATA)
@@ -1165,10 +1317,11 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced<sbr/>被声明为被引用元素的名
字</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1182,7 +1335,7 @@
</refmeta>
<refnamediv>
<refname>notes</refname>
- <refpurpose>Non-normative notes about a function's
semantics</refpurpose>
+ <refpurpose>Non-normative notes about a function's semantics 关于一个
函数的语义的非标准说明</refpurpose>
</refnamediv>
<refsynopsisdiv>notes ::=
(ANY)
@@ -1201,9 +1354,10 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
+设置为 $Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $，以保持 "最后
修订" 信息与CVS的变化同步</entry></row>
+<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element<sbr/>该元素的全局标识符</entry></row>
+<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes<sbr/>用于 XIncludes 的实现细节</entry></row>
</tbody>
</tgroup>
</informaltable>
@@ -1217,7 +1371,7 @@
</refmeta>
<refnamediv>
<refname>data-member</refname>
- <refpurpose>Declares a data member of a class</refpurpose>
+ <refpurpose>Declares a data member of a class 声明一个类的数据成员
</refpurpose>
</refnamediv>
<refsynopsisdiv>data-member ::=
(<link linkend="boostbook.dtd.type">type</link>, <link
linkend="boostbook.dtd.purpose">purpose</link>?, <link
linkend="boostbook.dtd.description">description</link>?)
@@ -1236,11 +1390,13 @@
</thead>
<tbody>
-<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes</entry></row>
-<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The
specifiers
for this function, e.g., inline, static, etc.</entry></row>
-<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The
name
of the element being declared to referenced</entry></row>
-<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A
global identifier for this element</entry></row>
-<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation
detail
used by XIncludes</entry></row>
+<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set
to
$Date: 2009-10-10 10:53:46 -0400 (Sat, 10 Oct 2009) $ to keep "last
revised" information in sync with CVS changes<sbr/>
***The diff for this file has been truncated for email.***
=======================================
--- /trunk/tools/boostbook/doc/together.xml Mon Dec 28 23:05:14 2009
+++ /trunk/tools/boostbook/doc/together.xml Mon Aug 16 23:44:54 2010
@@ -10,10 +10,10 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd";>
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"; id="boostbook.together"
last-revision="$Date: 2009-04-15 03:37:45 -0400 (Wed, 15 Apr
2009) $">
- <title>Bringing Together a BoostBook Document</title>
+ <title>Bringing Together a BoostBook Document 集合成一个 BoostBook 文档
</title>
<section id="boostbook.linking">
- <title>Linking in BoostBook</title>
+ <title>Linking in BoostBook 在 BoostBook 中的链接</title>
<para>How one links to another element in BoostBook depends
greatly on the nature of the element linked and how the link
@@ -21,7 +21,11 @@
<xref>, <link>, and <ulink>. Additionally, there
are linking elements for referencing specific types of entities,
such as classes (<classname>), functions
- (<functionname>), or libraries (<libraryname>).</para>
+ (<functionname>), or libraries (<libraryname>).<sbr/>
+ 如何链接到 BoostBook 中的其它元素，这非常取决于被链接元素的本身特性和该
链接如何出现。
+ 有三种常用的链接元素：<xref>, <link> 和 <ulink>。
+ 另外，还有引向特定实体类型的链接元素，如类(<classname>), 函数
(<functionname>)
+ 或库(<libraryname>)。</para>
<para>The <xref> element references elements that have an
<code>id</code> attribute and a title. The actual link text is
@@ -32,7 +36,11 @@
<code>boostbook.linking</code>, so we create a reference it to
with <code><xref linkend="boostbook.linking"/></code>, which
will look like this in the text: <xref
- linkend="boostbook.linking"/>.</para>
+ linkend="boostbook.linking"/>.<sbr/>
+ <xref> 元素引用带有 <code>id</code> 属性和标题的元素。实际的链接
文本由被引用元素的标题和类型组成。
+ 要链接到一个特定的 ID，请创建一个 <xref> 元素，带有
<code>linkend</code> 属性并设为指定目标的 ID。
+ 例如，本节的 ID 是 <code>boostbook.linking</code>，所以我们用
<code><xref linkend="boostbook.linking"/></code>
+ 来创建一个引用引向本节，在文本中它看起来如下：<code><xref
linkend="boostbook.linking"/></code>.</para>
<para>The <link> element references an ID in the same way as
<xref>, except that <link> does not generate any text
@@ -41,7 +49,11 @@
our own text with <code><link
linkend="boostbook.linking">like this</link></code>. This
markup will result in a link to this chapter that looks <link
- linkend="boostbook.linking">like this</link>.</para>
+ linkend="boostbook.linking">like this</link>.<sbr/>
+ <link> 元素以和 <xref> 一样的方式引用一个 ID，不过
<link> 不生成任何文本，所以文本必须在元素内部提供。
+ 例如，我们可以再一次链接到本节，不过这次我们通过 <code><link
+ linkend="boostbook.linking">like this</link></code> 来指定自己
的文本。
+ 这个标记将生成一个到本节的链接，看起来如：<link
linkend="boostbook.linking">like this</link>。</para>
<para>The <ulink> element references a URL that is outside
of the DocBook document. The <code>url</code> attribute contains
@@ -50,7 +62,12 @@
<code><ulink
url="http://www.boost.org">Boost</ulink>,</code> which
appears in the document like this: <ulink
- url="http://www.boost.org";>Boost</ulink>.</para>
+ url="http://www.boost.org";>Boost</ulink>.<sbr/>
+ <ulink> 元素引用一个在 DocBook 文档之外的 URL。其
<code>url</code> 属性包含链至的 URL，且元素数据提供链接文本。
+ 例如，我们可以通过 <code><ulink
url="http://www.boost.org">Boost</ulink>,</code>
+ 链接到 Boost 网站，在文档中会出现：<ulink
+ url="http://www.boost.org";>Boost</ulink>。
+</para>
<para>In BoostBook, <ulink> supports a custom url schema for
linking to files within the boost distribution. This is formed by
@@ -62,7 +79,13 @@
which will appear like this: <ulink
url="boost:/libs/flyweight/index.html">Boost.Flyweight</ulink>.
This schema is only supported for BoostBook <ulink> elements.
- It isn't available for any other elements or in Docbook.</para>
+ It isn't available for any other elements or in Docbook.<sbr/>
+ 在 BoostBook 中，<ulink> 支持定制的 url 架构，以链接至 boost 分发
包内部的文件。
+ 这是通过将 <code>url</code> 属性设置为 <code>boost:</code> 并后随文件路
径来实现的。
+ 例如，我们可以将 flyweight 库以 <code><ulink
url="boost:/libs/flyweight/index.html">Boost.Flyweight</ulink></code>
+ 来链接，它将显示为：<ulink
url="boost:/libs/flyweight/index.html">Boost.Flyweight</ulink>。
+ 这种架构只支持 BoostBook <ulink> 元素。对于其它元素或是在
Docbook 内是不可用的。
+</para>
<para>The <classname>, <functionname>,
<methodname>, and <libraryname> link to classes,
@@ -77,6 +100,16 @@
element references the <classname>boost::function</classname>
class template but displays the text <classname
alt="boost::function">function</classname>: <code><classname
- alt="boost::function">function</classname></code>.</para>
+ alt="boost::function">function</classname></code>.<sbr/>
+ <classname>, <functionname>,
+ <methodname> 和 <libraryname> 分别链接至类、函数、方法和
库。
+ 每个元素的文本同时给出链至元素的名字和链接文本。
+ 例如，我们可以通过
<code><libraryname>Function</libraryname></code> 链接至
+ Function 库，这将生成：<libraryname>Function</libraryname>。
+ 如果要显示不同于实际名字的文本，则要指定 <code>alt</code> 属性。
+ 例如，以下 XML 元素引用 <classname>boost::function</classname> 类模
板，但显示文本
+ <classname alt="boost::function">function</classname>:
<code><classname
+ alt="boost::function">function</classname></code>.
+</para>
</section>
</chapter>
Other related posts:
- » [boost-doc-zh] r423 committed - 翻译 tools/boostbook 的 qbk/xml 文件 - boost-doc-zh
