Docbook学习笔记

修订版本 1.6.7

Table of Contents

前面的废话

1. 我的初衷

1. Docbook的编辑工具

1. XMLMind

1.1. 安装使用

1.1.1. 我的版本
1.1.2. 安装
1.1.3. 使用

1.2. 更强大的Docbook的模版？

1.3. Docbook5或更高？

1.3.1. 安装Docbook5的Add-On
1.3.2. 编写Docbook5文档
1.3.3. 升级Docbook5
1.3.4. 为Docbook5添加新模板

1.4. 几个编译成HTML的技巧

1.4.1. 用指定的文件名生成HTML文件
1.4.2. XMLMind中的文件分割
1.4.3. 改变生成Html的编码

1.6. Meta-information

1.7. Block

1.7.1. Lists
1.7.2. Admonitions（警告）

1.1. DocBook DTD或Schema

4. DocBook XSL

1. Chunk
2. 编码

5. DocBook元素参考

1. A
2. B
3. C
4. D
5. E
6. F
7. G
8. H
9. I
10. J
11. K
12. L
13. M
14. N
15. O
16. P
17. Q
18. R
19. S
20. T
21. U
22. V
23. W
24. X
25. Y
26.

Chapter 1. Docbook的编辑工具

1. XMLMind

XMLmind下编写Docbook真的是很简单。如果在UltraEdit中写过，或用Emacs写过Docbook这种感觉就会跟明显。

1.1. 安装使用

XMLMind 分Standard版和Professional版，其中Standard版是Free的。

免费用的自然功能要弱一点，主要是版本管理和协作开发方面的功能没有，

还有就是只能将文档转换成html和RTF，其它如转成Word文档和PDF文档的功能没有。

对于个人用户来说，这些功能都没有什么大不了的，能很方便地编辑Docbook就行了。

1.1.1. 我的版本

我使用的是XmlMind的3.2.0版本。默认支持的Docbook版本包括4.2，4.3和4.4。

1.1.2. 安装

Windows下直接解压后，就可以用了。

1.1.3. 使用

直接运行“安装目录/bin”下的xxe.exe或xxe.bat进入编辑界面。具体的操作自己多摸几遍就会了。不用多说。

1.2. 更强大的Docbook的模版？

当我们生成新的Docbook文件，不管是选择book还是article或chapter，

XMLMind会自动调用保存在硬盘相应位置的模版生成一个新的Docbook文件。

这些模板在什么地方呢？答案：安装目录addonconfigdocbooktemplate，

如果觉得有其它更强大的模板，可以拷贝到这个目录下覆盖相应的模板。

Example 1.1. 为Docbook添加一个Preface的模板

开始添加一个新的模板

1：在“安装目录addonconfigdocbooktemplate”下生成一个新的preface.xml的文件。

2：在其中添加如下代码：

<?xml version="1.0" encoding="UTF-8" ?>
<preface id="preface">
<title></title>
<section>
 <title></title>
 <para></para>
</section>
</preface>

3：保存后。打开“安装目录addonconfigdocbook”下的docbook.xxe，找到如下代码：

  <template name="Book" location="template/V4.4/book.xml" />
<template name="Article" location="template/V4.4/article.xml" />
<template name="Refentry (part of a modular document)"
         location="template/refentry.xml" />
<template name="Part (part of a modular document)"
         location="template/part.xml" />
<template name="Chapter (part of a modular document)"
         location="template/chapter.xml" />
<template name="Appendix (part of a modular document)"
         location="template/appendix.xml" />
<template name="Glossary (part of a modular document)"
         location="template/glossary.xml" />
<template name="Section (part of a modular document)"
         location="template/section.xml" />

4：在其中找个合适的位置，加入如下代码后保存：

  <template name="Preface (part of a modular document)"
         location="template/preface.xml" />

5：找到如下代码：

 <or>
     <rootElementLocalName>part</rootElementLocalName>
     <rootElementLocalName>chapter</rootElementLocalName>
     <rootElementLocalName>refentry</rootElementLocalName>
     <rootElementLocalName>appendix</rootElementLocalName>
     <rootElementLocalName>glossary</rootElementLocalName>
     <rootElementLocalName>section</rootElementLocalName>
     <rootElementLocalName>sect1</rootElementLocalName>
     <rootElementLocalName>sect2</rootElementLocalName>
     <rootElementLocalName>sect3</rootElementLocalName>
     <rootElementLocalName>book</rootElementLocalName>
     <rootElementLocalName>article</rootElementLocalName>
</or>

6：在其中添加一行：

<rootElementLocalName>preface</rootElementLocalName>

7：重新启动XMLMind。将在“New”菜单中看到Preface的模版。

1.3. Docbook5或更高？

Docbook5.0 的版本已经是b5了。应该来说是比较成熟了。

相对于前面的几个版本，里面去掉了许多重复的tag，

进行了适当删减。但XMLmind默认版本不支持 Docbook5.0。

但是，XMLmind虽然不提倡用Docbook5来写文档，但还是提供了一个实验性质的Add-On，用来支持 Docbook5。

1.3.1. 安装Docbook5的Add-On

在菜单Options下选择"Install Add-Ons"，在下载的列表中选择“docbook5_config”和“xhtml_rng_config”，然后安装。

它的默认下载地址是http://www.xmlmind.net/xmleditor/_download/list.xxe_addon,如果连接不上，

可以用在Options菜单中中设置一下代理。

在安装的过程中，将会要求你进行一些基本设置，配置后保存在一个docbook5_config目录下。

而且这些Add-Ons并没有像预想的那样安装在 “安装目录/Addon”下，

可以再次调用"Install Add-Ons"，在“Uninstall”页面下选中Docbook5，查看它的安装目录。

1.3.2. 编写Docbook5文档

安装好了后，此时点击File菜单的New，就能看到Docbook5。

1.3.3. 升级Docbook5

这个包里安装的是docbook5.0b4，如果想要更新到最新版，

可以到http://www.oasis-open.org/docbook/xml/5.0b5/docbook-5.0b5.zip下载。

解压后将docbook.rng和db4-upgrade.xsl拷贝到docbook5_config目录下，覆盖原来的两个文件。

1.3.4. 为Docbook5添加新模板

这个Add-On的默认模版只有一个Article，我们也可以添加一些其它的Book，Chapter等模板。

步骤如下：

1：在docbook5_config目录下，生成一个book.xml或其它模板名字的文件。

2：编辑book.xml(内容参考article.xml)

3：用文本编辑器打开docbook5_xxe文件，找到<template name="Article" location="article.xml" />

4：在其后添加一句：<template name="Book" location="book.xml" />

5：重新启动XMLMind。就会在New菜单中看到Docbook5下有了Book的模板。

1.4. 几个编译成HTML的技巧

编译成HTML，只需点击菜单“DocBookConvert DocumentConverto to Html”

就会当前目录生成多个HTML文件。如Book、Chapter和Section等元素下的内容都回单独生成一个HTML文件。

1.4.1. 用指定的文件名生成HTML文件

自动生成的文件名没有什么可读性。只能大致知道是第几章第几节的内容。

因为只是诸如Book、Chapter、Preface、Section等节点会自动生成一个单独的文件。

所以在Book或Acticle中，一遇到这些节点，我们就应该做一些处理。处理得步骤如下：

1.4.2. XMLMind中的文件分割

参看???TITLE???

1.4.3. 改变生成Html的编码

html默认的编码是ISO-8859-1，如果想要使编码为UTF-8，

在目录XMLMindaddonconfigdocbookxslhtml下面打开文件chunker.xsl，找到：

<xsl:param name="chunker.output.encoding" select="'ISO-8859-1'"/>

将其中的“ISO-8859-1”修改成“UTF-8”。

参看Section 2, “编码”

Chapter 2. Docbook文档分析

1. Docbook元素的分类

Docbook可以分成以下几类：

Sets

Books

Divisions, which divide books into parts

Components, which divide books or divisions into chapters

Sections, which subdivide components

Meta-information elements

Block elements

Inline elements

1.1. Sets

一个Set包括两个或多个Books。

1.2. Books

一个Book往往包括以下元素：

Dedication（献辞）

献辞往往放在一本书的最前面。
Navigational Components（导航性Component）

由几个Components级别的元素组成以用于导航。如各类列表（list）、图表（table）、举例（example）和索引（index）等等。
Divisions（分块）

Divisions主要指仅低于book级别的元素，如part和reference。

一本book可以在不包含division的情况下，直接包含任意的components。
Components（）

和chapter同级别或类似的元素都成为components。

1.3. Divisions

1.4. Components

Components are the chapter-like elements of a book or part:

preface, chapter, appendix, glossary, and bibliography.

An article can also occur at the component level.

We describe articles in more detail in the section titled the section called “Making an Article””.

Components generally contain block elements and/or sections, and some can contain navigational components and refentrys.

1.5. Sections

存在着多种不同风味的Sections。

sect1元素

sect2, sect3, sect4, sect5

The sect1…sect5 elements are the most common sectioning elements.
They can occur in most component-level elements.
These numbered section elements must be
properly nested (sect2s can only occur inside sect1s, sect3s
can only occur inside sect2s, and so on). There are five levels of numbered sections.
section元素

对于那些有编号的section，这是一个不错的选择。
section元素本身是递归循环的，可以嵌入到任意的section下面。当生成html或其它文件是，xslt会自动编号。
simplesect元素

simplesect 是没有任何嵌套section的一个section。可以把 simplesect 说成是section树的树叶。
bridgehead元素

bridgehead元素提供一个section的标题，但是没有任何嵌入的section。一般用于暂时“空置”某个section。
refsect1…refsect3 元素

这些元素，只会出现在refentry中。类似于sect1...sect5，但是只有3级。
glossdiv, bibliodiv, and indexdiv元素

glossary, bibliography, and index elements 可以被分成几个top_level的几块,
但不能说它们是sections. 这些元素不能像sections那样可以嵌套。

1.6. Meta-information

Meta -information（元信息）主要被设计来表示文档内容的文献摘要信息（bibliographic information ）。

如（author, title, publisher,等等）。

其它诸如修订历史、关键词和索引条目（revision histories, keyword sets, and index terms）也属于“元信息”。

1.7. Block

Block元素可以说是指那些“段落”级别的元素。这些元素有如下许多的类别：

lists （列表）, admonitions（警告）, line-specific environments（特殊行环境）,

synopses of several sorts（各种摘要）, tables（表格）, figures（图形）,

examples（示例）, and a dozen or more miscellaneous elements（其它各种杂七杂八的元素）。

“段落”级别的元素基本上可以分成“block”和“inline”两种。

“Block”元素往往出现在“段落”的前或后。

“inline” 元素，一般紧密地出现在“行”里。中间没有任何间隔。“inline”元素主要用于给数据或文字作标记，

如交叉引用、上标、下标（cross references, filenames, commands,

options, subscripts and superscripts, and glossary terms. ）等。

1.7.1. Lists

在Docbook中总共有8种列表元素。

1.7.1.1. calloutlist

calloutlist是一个callouts的列表。用于对出现在文档中的一系列callout进行描述性说明。

callouts主要包括注解和描述（annotations or descriptions）。

每个callout都会指向一个mediaobject, programlisting, or screen 对象。

Example 2.1. callout举例

在下面的例子中，将mv命令的两个需要作进一步解释的地方，分别放置一个callout：

mv 1filename filename

将mv命令中两个需要注解的地方，在下面的calloutlist中，做出说明。显示如下：

	需要改名的文件。
	将文件改成新的文件名。

1.7.1.2. bibliolist

许多bibliography（书目）的列表。

1.7.1.3. glosslist

包含术语以及它的定义的一个列表。

1.7.1.4. itemizedlist

无序列表的每一项前有一个圆点或圆圈。使用itemizedlist环境。

<itemizedlist>
<listitem><para>项目一</para></listitem>
<listitem><para>项目二</para></listitem>
</itemizedlist>

输出结果为：

项目一

项目二

itemizedlist元素的mark属性可以指定几种项前的符号：opencircle, bullet, box。

如果在listitem中指定override属性为上面的取值，可以修改当前项的符号。

1.7.1.5. orderedlist

这是有序列表。

<orderedlist numeration="lowerroman">
<listitem>
<para>One</para>
</listitem>
<listitem>
<para>Two</para>
</listitem>
</orderedlist>

输出结果如下：

orderedlist 元素的numeration属性可以选择：lowerroman(小写罗马数字),

upperroman(大写罗马数字), loweralpha(小写字母), upperalpha(大写字母),

arabic(阿拉伯数字)以显示不同的编号。

1.7.1.6. segmentedlist

一系列的小型Items列表。如，一个包含“国家”和“首都”的segmentedlist。如下代码：

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example segmentedlist</title>

<para>The capitals of the states of the United States of America are:

<segmentedlist><title>State Capitals</title>
<?dbhtml list-presentation="list"?>
<segtitle>State</segtitle>
<segtitle>Capital</segtitle>
<seglistitem><seg>China</seg><seg>Beijing</seg></seglistitem>
<seglistitem><seg>Alabama</seg><seg>Montgomery</seg></seglistitem>
<seglistitem><seg>Alaska</seg><seg>Juneau</seg></seglistitem>
<seglistitem><seg>Arkansas</seg><seg>Little Rock</seg></seglistitem>
</segmentedlist>

</para>

</article>

显示的结果如下：

State Capital

State: China

Capital: Beijing

State: Alabama

Capital: Montgomery

State: Alaska

Capital: Juneau

State: Arkansas

Capital: Little Rock

由上可知，segmentedlist有点类似于一个没有表格线的table，由segtitle指定表头，

seglistitem指定行，seg为表格数据。

1.7.1.7. simplelist

一个无任何修饰，由单个词或短语组成的列表。

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example simplelist</title>

<para>Here is a <tag>SimpleList</tag>, rendered inline:
<simplelist type='inline'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>

</article>

Example 2.2. 输出

Here is a SimpleList, rendered inline:

, A, B, C, D, E, F, G

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example simplelist</title>

<para>Here is the same <tag>SimpleList</tag> rendered horizontally with
three columns:
<simplelist type='horiz' columns='3'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>

</article>

Example 2.3. 输出

Here is a SimpleList, rendered inline:

	A	B
C	D	E
F	G

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example simplelist</title>

<para>Here is the same <tag>SimpleList</tag> rendered horizontally with
three columns:
<simplelist type='vert' columns='4'>
<member>A</member>
<member>B</member>
<member>C</member>
<member>D</member>
<member>E</member>
<member>F</member>
<member>G</member>
</simplelist>
</para>

</article>

Example 2.4. 输出

Here is a SimpleList, rendered inline:

	B	D	F
A	C	E	G

1.7.1.8. variablelist

用于描述一系列的名词解释。

<variablelist>
<varlistentry>
<term><filename>TTF</filename></term>
<listitem><para>TrueType fonts.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>PFA</filename></term>
<term><filename>PFB</filename></term>
<listitem><para>PostScript fonts.  <filename>PFA</filename> files are common on
<acronym>UNIX</acronym> systems, <filename>PFB</filename> files
are more common on Windows systems.</para></listitem>
</varlistentry>
</variablelist>

输出结果如下：

TTF: TrueType fonts
PFAPFB: PostScript fonts. PFAfiles are common on UNIX systems, PFB files are more common on Windows system.

1.7.2. Admonitions（警告）

Docbook有5种不同类型的警告：caution, important, note, tip, and warning。

1.7.2.1. caution

1.7.2.2. important

1.7.2.3. note

1.7.2.4. tip

1.7.2.5. warning

1.8. Inline

2. Chapter 3. Docbook的文档转换

1. 安装必备环境

“文档转换”又可以称为“文档发布”，就是将以XML形式存在的文档，

转换成其它诸如PDF、Word、HTML或CHM等形式的文档。

使用Docbook发布文档，需要安装以下的工具：

ocBook DTD或Schema

DocBook XSL

XSLT转换程序

XSL-FO处理程序

以下主要摘录自sanool 的《docbook使用教程》，根据学习情况稍作了修改。

1.1. DocBook DTD或Schema

Docbook DTD可以到OASIS的网站上下载（http://www.oasis-open.org/docbook/xml/），

在这里你可以找到zip格式的压缩包。

目前的最新版本是5.0beta5。5.0之后的版本不再需要DTD，只需要在文档前面声明如下：

<article xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0" xml:lang="en">

对于5.0之前的版本，事实上可以不下载Docbook DTD。如果你的文档DTD声明这样写：

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">

根据这样的定义，大部分XML处理器能够从网络上获取DTD。

这样做的好处是编辑的Docbook文档移植性好，

可以在没有安装Docbook DTD的机器上使用。

不过由于Docbook DTD比较庞大，通过网络获取DTD会影响处理速度，

在低速网络或者网络比较糟糕的情况下，影响尤为显著。如果选择使用本地DTD，文档的DTD引用应该这样写：

Example 3.1. Linux

<!DOCTYPE book SYSTEM "/usr/share/docbook-4.2/docbookx.dtd">

Example 3.2. Windows

<!DOCTYPE book SYSTEM "file:///C:/xml/docbook42/docbookx.dtd">

Docbook提供了一种方式，让用户可以使用相同的DTD声明，

但可以在使用网络获取DTD和使用本地DTD之间切换，同时拥有两者的优势。

这就是catalog文件的作用。典型的catalog的声明如下：

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<group id="DocbookDTD" prefer="public">
 <system
   systemId="http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   uri="file:///usr/share/xml/docbook42/docbookx.dtd"/>
</group>
</catalog>

这个声明把网络DTD映射到本地DTD。如果使用支持Catalog的XSLT Processor，它首先会查找本地文件，如果本地文件不存在，再查找网络。

Chapter 4. DocBook XSL

1. Chunk

XMLMind中的文件分割

默认的情况下，XMLMind会自动分割到Sect1或者相当于Sect1的Section。如果需要增加分割的深度的话，那么：
- 找到目录“XMLMindaddonconfigdocbook”
- 打开文件“xslMenu.incl”
- 找到如下代码：
```
<parameter name="chunk.section.depth">1</parameter>
```
- 将参数“1”改成“2”或更大。

xsltproc中的文件分割

有三种方法可以进行控制：
- 设置 chunk.section.depth 或 chunk.first.sections的值
  
  If you only want to control what section levels get put into separate HTML files, then you should set the chunk.section.depth parameter. By default it is set to 1. So if you want sect1 and sect2 elements to be chunked into individual files, set the parameter to 2.
  
  The chunk stylesheet by default includes the first sect1 of a chapter (or article) with the content that precedes it in the chapter. If you want those also to be chunked to separate files, then set the chunk.first.sections parameter to 1.
- 制作一个新的基于chunk.xsl的文件
  
  If the standard chunking process doesn't meet your needs, and you are willing to manually intervene, then you can completely control how content gets chunked. This might be useful if some sections are very short and you would rather keep them together. But since it requires hand editing of a generated table of contents file, it is only useful if done infrequently or with documents that have stable structure.
  1. Process your document with the special maketoc.xsl stylesheet, which generates an XML table of contents file. Using xsltproc for example:
    
    xsltproc -output mytoc.xml html/maketoc.xsl myfile.xml
  1. Edit the generated mytoc.xml file to remove any tocentry elements that you don't want chunked, or add entries that you do want chunked.
  2. Process your document with the special chunktoc.xsl stylesheet instead of the regular chunk.xsl stylesheet, and pass it the generated TOC filename in the chunk.toc parameter. For example:
    
    xsltproc
    -output output/
    -stringparam chunk.toc mytoc.xml
    html/chunktoc.xsl myfile.xml
    
    This will chunk your document based on the entries in the generated TOC file. You can still use any of the chunking parameters to modify the chunking behavior
    
    If you also want the HTML TOC that is produced during chunking to match your XML TOC file, then set the parameter manual.toc to that same filename.
    
    Note
    
    When you use this process, you must have an id attribute on every element that you want to start a new chunk. This includes the document element, which generates the title page and table of contents. You can see which elements don't have an id by examining the generated TOC file and looking for empty id attributes in the tocentrys. Any such entries will be merged with their parent elements during chunking.
- 修改chunk的模版
  
  If you want to control what elements produce chunks, beyond just the section level choice, then you must modify the templates that do chunk processing. See the section “Chunking customization” for more information.

2. 编码

You may need to change the output encoding for your chunked HTML files.

The chunker.output.encoding parameter lets you change the default value

of the HTML character encoding from the default value of ISO-8859-1.

For example, if you want your HTML files to use UTF-8 encoding instead,

you could process your document with the following:

xsltproc
-output  output/
-stringparam chunker.output.encoding UTF-8
html/chunk.xsl  myfile.xml

This will produce the following line in each chunked HTML file:

It will also encode the HTML content itself using UTF-8 encoding.
When a browser opens the file,
the meta tag informs it that the file is encoded in UTF-8
so it will use a UTF-8 font to display the text.
This feature is only available with Saxon and XSL processors
that support EXSLT extensions (such as xsltproc).
It does not work in Xalan, however.

Note

By default, chunked HTML output from Saxon will not contain any non-ASCII characters,

regardless of the encoding your specify.

Any non-ASCII characters will be represented as named or numerical entities.

This behavior is controlled by the saxon.character.representation stylesheet parameter.

See the section “Saxon output character representation” for more information.

The default output encoding for XHTML is UTF-8, as described in the section “XHTML”.

Chapter 5. DocBook元素参考

DocBook Element Reference

1. A

    abbrev - （缩写）An abbreviation, especially one followed by a period
 abstract - （摘要）A summary
 accel - （加速键）A graphical user interface (GUI) keyboard shortcut
 ackno - （感谢）Acknowledgements in an Article
 acronym - (只取首字母的缩写词)An often pronounceable word made
from the initial (or selected) letters of a name or phrase
 address - A real-world address, generally a postal address
 affiliation - （溯源由来）The institutional affiliation of an individual
 alt - （纯文本注解）A text-only annotation, often used for accessibility
 anchor - （文档中的定位点）A spot in the document
 annotation - （注解，评注）An annotation
 answer - （答案，回答）An answer to a question posed in a QandASet
 appendix - （附录）An appendix in a Book or Article
 application - （软件程序的名称）The name of a software program
 arc - An XLink arc in an extendedlink
 area (db.area.inareaset) - （图形或代码中标注的区域）
A region defined for a Callout in a graphic or code example
 area (db.area) - A region defined for a Callout in a graphic or code example
 areaset - （一组相关区域）A set of related areas in a graphic or code example
 areaspec - （区域集）A collection of regions in a graphic or code example
 arg - （参数）An argument in a CmdSynopsis
 article - （文章）An article
 artpagenums - （文章的页数）The page numbers of an article as published
 attribution - （引用文字的出处）
The source of a block quote or epigraph（铭文、碑文，格言、题词）
 audiodata - （外部声音数据指针）Pointer to external audio data
 audioobject - （声音数据的meta信息）A wrapper for audio
data and its associated meta-information
 author - （作者全名）The name of an individual author
 authorgroup - （作者成员）Wrapper for author information when
a document has multiple authors or collabarators
 authorinitials - （作者简称）The initials or other short
identifier for an authorfilename="ElemRef.html"

2. B

//一下以biblio开头的用于书籍列举参考书目

 bibliocoverage - （文档适用的地域和有效时间）The spatial or temporal
coverage of a document
 bibliodiv - A section of a Bibliography
 biblioentry - An entry in a Bibliography
 bibliography - （书目）A bibliography
 biblioid - （文档编号）An identifier for a document
 bibliolist - （书目列表）A wrapper for a list of bibliography entries
 bibliomisc - （biblio杂项）Untyped bibliographic information
 bibliomixed - An entry in a Bibliography
 bibliomset - A cooked container for related bibliographic information
 biblioref - A cross-reference to a bibliographic entry
 bibliorelation - The relationship of a document to another
 biblioset - A raw container for related bibliographic information
 bibliosource - The source of a document

 Block Elements - block elements是文件中可成為一個段落（paragraph）的elements，
如ItemizedList、OrderedList、ProgramListing、Para，
還有Tip、Warning、Screen、Figure、Table、Example、BlockQuote、Sidebar...等elements。
 blockquote - （与文本分离的引证内容）A quotation set off from the main text
 book - A book
 bridgehead - （自由浮动的标题）A free-floating heading

3. C

    callout - （被标记区可呼出的内容）A called out description of a marked Area
 calloutlist - A list of callout s
 caption (db.caption) - （标题，图片说明）A caption
 caption (db.html.caption) - A caption
 caution - （警告）A note of caution
 chapter - （章）A chapter, as of a book
 citation - （书目的引用）An inline bibliographic reference
to another published work
 citebiblioid - （书目ID的引用）A citation of a bibliographic identifier
 citerefentry - （某一页的引用）A citation to a reference page
 citetitle - （被引用作品的标题）The title of a cited work
 city - The name of a city in an address
 classname - （OO中的类名）The name of a class, in the object-oriented
programming sense
 classsynopsis - （摘要）The syntax summary for a class definition
 classsynopsisinfo - （补充）Information supplementing the contents
of a ClassSynopsis
 cmdsynopsis - （软件命令摘要）A syntax summary for a software command
 co - The location of a callout embedded in text
 code - An inline code fragment
 col - （HTML表列详细说明）Specifications for a column in an HTML table
 colgroup - A group of columns in an HTML table
 collab - （合作者ID）Identifies a collaborator
 colophon - Text at the back of a book describing facts about its production
 colspec - Specifications for a column in a table
 command - （可执行程序名称）The name of an executable program
or other software command
 Components是与书本第几章等同一级别（chapter-like）的elements，
如preface（前言、序文）、chapter（章）、
appendix（附錄）、glossary（詞彙）、bibliography（書目）、以及article。
 computeroutput -（显示的数据）Data, generally text, displayed or
presented by a computer

 confdates - （会议文档日期）The dates of a conference for which a
document was written
 confgroup - A wrapper for document meta-information about a conference
 confnum - An identifier, frequently numerical,
associated with a conference for which a document was written
 confsponsor - The sponsor of a conference for which a document was written
 conftitle - The title of a conference for which a document was written

 constant - A programming or system constant
 constraint - A constraint in an EBNF production
 constraintdef - The definition of a constraint in an EBNF production
 constructorsynopsis - A syntax summary for a constructor

 contractnum - The contract number of a document
 contractsponsor - The sponsor of a contract
 contrib - A summary of the contributions made to a document
by a credited source
 copyright - Copyright information about a document
 coref - A cross reference to a co
 country - The name of a country
 cover - Additional content for the cover of a publication

4. D

    database - The name of a database, or part of a database
 date - The date of publication or revision of a document
 dedication - （献辞）A wrapper for the dedication section of a book
 destructorsynopsis - A syntax summary for a destructor
 edition - （版本）The name or number of an edition of a document
 editor - The name of the editor of a document

5. E

    email - An email address
 emphasis (db._emphasis) - A limited span of emphasized text
 emphasis (db.emphasis) - Emphasized text
 entry - （一个Table单元）A cell in a table
 entrytbl - （一个子表）A subtable appearing in place of an Entry in a table
 envar - （软件的环境变量）A software environment variable
 epigraph - （文档开头引语）
A short inscription at the beginning of a document or component
 equation - （方程式）A displayed mathematical equation

 errorcode - An error code
 errorname - An error name
 errortext - An error message.
 errortype - The classification of an error message

 example - A formal example, with a title
 exceptionname - The name of an exception
 extendedlink - An XLink extended link

6. F

    fax - A fax number
 fieldsynopsis - The name of a field in a class definition
 figure - A formal figure, generally an illustration, with a title
 filename - The name of a file
 firstname - The first name of a person
 firstterm - The first occurrence of a term
 footnote - A footnote
 footnoteref - A cross reference to a footnote (a footnote mark)
 foreignphrase - A word or phrase in a language other than the primary language of the document
 formalpara - A paragraph with a title
 funcdef - A function (subroutine) name and its return type
 funcparams - Parameters for a function referenced through a function pointer in a synopsis
 funcprototype - The prototype of a function
 funcsynopsis - The syntax summary for a function definition
 funcsynopsisinfo - Information supplementing the FuncDefs of a FuncSynopsis
 function - The name of a function or subroutine, as in a programming language

7. G

    glossary - A glossary
 glossdef - A definition in a GlossEntry
 glossdiv - A division in a Glossary
 glossentry - An entry in a Glossary or GlossList
 glosslist - A wrapper for a list of glossary entries
 glosssee - A cross-reference from one glossentry to another
 glossseealso - A cross-reference from one GlossEntry to another
 glossterm - A glossary term
 group - A group of elements in a CmdSynopsis
 guibutton - The text on a button in a GUI
 guiicon - Graphic and/or text appearing as a icon in a GUI
 guilabel - The text of a label in a GUI
 guimenu - The name of a menu in a GUI
 guimenuitem - The name of a terminal menu item in a GUI
 guisubmenu - The name of a submenu in a GUI

8. H

    hardware - A physical part of a computer system
 holder - The name of the individual or organization that holds a copyright
 honorific - The title of a person
 html:button - A button in an HTML form
 html:fieldset - A fieldset element in an HTML form
 html:form - An HTML form
 html:input - An input element in an HTML form
 html:label - A label in an HTML form
 html:legend - A legend in an HTML form fieldset
 html:option - An option element in an HTML form
 html:select - A select element in an HTML form
 html:textarea - A textarea element in an HTML form

9. I

    imagedata - Pointer to external image data
 imageobject - A wrapper for image data and its associated meta-information
 imageobjectco - A wrapper for an image object with callouts
 important - An admonition set off from the text
 index - An index to a book or part of a book
 indexdiv - A division in an index
 indexentry - An entry in an index
 indexterm (db.indexterm.endofrange) -
Identifies the end of a range associated with an indexed term
 indexterm (db.indexterm.singular) -
A wrapper for an indexed term
 indexterm (db.indexterm.startofrange) -
A wrapper for an indexed term that covers a range
 info (db.info) - A wrapper for information about a component or other block
 info (db.titleforbidden.info) -
A wrapper for information about a component or other block without a title
 info (db.titleonly.info) -
A wrapper for information about a component or other block with only a title
 info (db.titleonlyreq.info) -
A wrapper for information about
a component or other block with only a required title
 info (db.titlereq.info) -
A wrapper for information about a component or
other block with a required title
 informalequation - A displayed mathematical equation without a title
 informalexample - A displayed example without a title
 informalfigure - A untitled figure
 informaltable (db.cals.informaltable) - A table without a title
 informaltable (db.html.informaltable) - A table without a title
 initializer - The initializer for a FieldSynopsis
 Inline Elements - Inline elements是嵌在句子里的elements，
通常用於参考引用（Cross References，如Link、ULink），
电脑术语（如Command、Filename、Application），
GUI菜单（如GUIMenu、GUISubmenu、GUIMenuItem），
键盘組合（如KeyCombo、KeySym）或
其它（如 Literal、Emphasis）等等。
這些elements的使用可幫助文件使用者快速檢索其要找尋的字詞。
 inlineequation - A mathematical equation or expression occurring inline
 inlinemediaobject - An inline media object (video, audio, image, and so on)
 interfacename - The name of an interface
 issuenum - The number of an issue of a journal
 itemizedlist - A list in which each entry is marked with a
bullet or other dingbat
 itermset - A set of index terms in the meta-information of a document

10. J

    jobtitle - The title of an individual in an organization

11. K

    keycap - The text printed on a key on a keyboard
 keycode - The internal, frequently numeric, identifier for a key on a keyboard
 keycombo - A combination of input actions
 keysym - The symbolic name of a key on a keyboard
 keyword - One of a set of keywords describing the content of a document
 keywordset - A set of keywords describing the content of a document

12. L

    label - A label on a Question or Answer
 legalnotice - A statement of legal obligations or requirements
 lhs - The left-hand side of an EBNF production
 lineage - The portion of a person's name indicating a relationship to ancestors
 lineannotation - A comment on a line in a verbatim listing
 link - A hypertext link
 listitem - A wrapper for the elements of a list item
 literal - Inline text that is some literal value
 literallayout - A block of text in which line breaks
and white space are to be reproduced faithfully
 locator - An XLink locator in an extendedlink

13. M

    manvolnum - A reference volume number
 markup - A string of formatting markup in text that is
to be represented literally
 mathphrase - A mathematical phrase, an expression
that can be represented with ordinary text and a small amount of markup
 mediaobject - A displayed media object (video, audio, image, etc.)
 member - An element of a simple list
 menuchoice - A selection or series of selections from a menu
 Meta-Information - 註解Section或以上level的elements的相关信息，
如BookInfo,DocInfo，ArticleInfo或SectionInfo。這些elements內含：
Author（作者）、Title（主題）、Publisher（出版商）、
版本信息（revision histories）、
关键词（keyword sets）、
索引词条（index terms）等elements。
 methodname - The name of a method
 methodparam - Parameters to a method
 methodsynopsis - A syntax summary for a method
 modifier - Modifiers in a synopsis
 mousebutton - The conventional name of a mouse button
 msg - A message in a message set
 msgaud - The audience to which a message in a message set is relevant
 msgentry - A wrapper for an entry in a message set
 msgexplan - Explanatory material relating to a message in a message set
 msginfo - Information about a message in a message set
 msglevel - The level of importance or severity of a message in a message set
 msgmain - The primary component of a message in a message set
 msgorig - The origin of a message in a message set
 msgrel - A related component of a message in a message set
 msgset - A detailed set of messages, usually error messages
 msgsub - A subcomponent of a message in a message set
 msgtext - The actual text of a message component in a message set

14. N

    nonterminal - A non-terminal in an EBNF production
 note - A message set off from the text

15. O

    olink - A link that addresses its target indirectly
 ooclass - A class in an object-oriented programming language
 ooexception - An exception in an object-oriented programming language
 oointerface - An interface in an object-oriented programming language
 option - An option for a software command
 optional - Optional information
 orderedlist - A list in which each entry is marked with a
sequentially incremented label
 orgdiv - A division of an organization
 orgname - The name of an organization other than a corporation
 otheraddr - Uncategorized information in address
 othercredit - A person or entity, other than an author or editor,
credited in a document
 othername - A component of a persons name that is not a first name,
surname, or lineage

16. P

    package - A software or application package
 pagenums - The numbers of the pages in a book, for use in a bibliographic entry
 para - A paragraph
 paramdef - Information about a function parameter in a programming language
 parameter - A value or a symbolic reference to a value
 part - A division in a book
 partintro - An introduction to the contents of a part
 personblurb - A short description or note about a person
 personname - The personal name of an individual
 phone - A telephone number
 phrase (db._phrase) - A limited span of text
 phrase (db.phrase) - A span of text
 pob - A post office box in an address
 postcode - A postal code in an address
 preface - Introductory matter preceding the first chapter of a book
 primary - The primary word or phrase under which an index term should be sorted
 primaryie - A primary term in an index entry, not in the text
 printhistory - The printing history of a document
 procedure - A list of operations to be performed in a well-defined sequence
 production - A production in a set of EBNF productions
 productionrecap - A cross-reference to an EBNF production
 productionset - A set of EBNF productions
 productname - The formal name of a product
 productnumber - A number assigned to a product
 programlisting - A literal listing of all or part of a program
 programlistingco - A program listing with associated areas used in callouts
 prompt - A character or string indicating the start of
an input field in a computer display
 property - A unit of data associated with some part of a computer system
 pubdate - The date of publication of a document
 publisher - The publisher of a document
 publishername - The name of the publisher of a document

17. Q

    qandadiv - A titled division in a QandASet
 qandaentry - A question/answer set within a QandASet
 qandaset - A question-and-answer set
 question - A question in a QandASet
 quote - An inline quotation

18. R

    refclass - The scope or other indication of applicability of a reference entry
 refdescriptor - A description of the topic of a reference page
 refentry - A reference page (originally a UNIX man-style reference page)
 refentrytitle - The title of a reference page
 reference - A collection of reference entries
 refmeta - Meta-information for a reference entry
 refmiscinfo - Meta-information for a reference entry other than
the title and volume number
 refname - The name of (one of) the subject(s) of a reference page
 refnamediv - The name, purpose, and classification of a reference page
 refpurpose - A short (one sentence) synopsis of the topic of a reference page
 refsect1 - A major subsection of a reference entry
 refsect2 - A subsection of a refsect1
 refsect3 - A subsection of a refsect2
 refsection - A recursive section in a refentry
 refsynopsisdiv - A syntactic synopsis of the subject of the reference page
 releaseinfo - Information about a particular release of a document
 remark - A remark (or comment) intended for presentation in a draft manuscript
 replaceable - Content that may or must be replaced by the user
 returnvalue - The value returned by a function
 revdescription - A extended description of a revision to a document
 revhistory - A history of the revisions to a document
 revision - An entry describing a single revision in the
history of the revisions to a document
 revnumber - A document revision number
 revremark - A description of a revision to a document
 rhs - The right-hand side of an EBNF production
 row (db.entrytbl.row) - A row in a table
 row (db.row) - A row in a table

19. S

    sbr - An explicit line break in a command synopsis
 screen - Text that a user sees or might see on a computer screen
 screenco - A screen with associated areas used in callouts
 screenshot - A representation of what the user sees or might
see on a computer screen
 secondary - A secondary word or phrase in an index term
 secondaryie - A secondary term in an index entry, rather than in the text
 sect1 - A top-level section of document
 sect2 - A subsection within a Sect1
 sect3 - A subsection within a Sect2
 sect4 - A subsection within a Sect3
 sect5 - A subsection within a Sect4
 section - A recursive section
 see - Part of an index term directing the reader instead to
another entry in the index
 seealso - Part of an index term directing the reader also to
another entry in the index
 seealsoie - A See also entry in an index, rather than in the text
 seeie - A See entry in an index, rather than in the text
 seg - An element of a list item in a segmented list
 seglistitem - A list item in a segmented list
 segmentedlist - A segmented list, a list of sets of elements
 segtitle - The title of an element of a list item in a segmented list
 seriesvolnums - Numbers of the volumes in a series of books
 set - A collection of books
 setindex - An index to a set of books
 shortaffil - A brief description of an affiliation
 shortcut - A key combination for an action that is also
accessible through a menu
 sidebar - A portion of a document that is isolated from the
main narrative flow
 simpara - A paragraph that contains only text and inline
markup, no block elements
 simplelist - An undecorated list of single words or short phrases
 simplemsgentry - A wrapper for a simpler entry in a message set
 simplesect - A section of a document with no subdivisions
 spanspec - Formatting information for a spanned column in a table
 state - A state or province in an address
 step - A unit of action in a procedure
 stepalternatives - Alternative steps in a procedure
 street - A street address in an address
 subject - One of a group of terms describing the subject
matter of a document
 subjectset - A set of terms describing the subject matter of a document
 subjectterm - A term in a group of terms describing the
subject matter of a document
 subscript - A subscript (as in H2 O, the molecular formula for water)
 substeps - A wrapper for steps that occur within steps in a procedure
 subtitle - The subtitle of a document
 superscript - A superscript (as in x^2, the mathematical
notation for x multiplied by itself)
 surname - A family name; in western cultures the last name
 symbol - A name that is replaced by a value before processing
 synopfragment - A portion of a CmdSynopsis broken out from
the main body of the synopsis
 synopfragmentref - A reference to a fragment of a command synopsis
 synopsis - A general-purpose element for representing the
syntax of commands or functions
 systemitem - A system-related item or term

20. T

    table (db.cals.table) - A formal table in a document
 table (db.html.table) - A formal table in a document
 tag - A component of XML (or SGML) markup
 task - A task to be completed
 taskprerequisites - The prerequisites for a task
 taskrelated - Information related to a task
 tasksummary - A summary of a task
 tbody (db.cals.entrytbl.tbody) - A wrapper for the rows
of a table or informal table
 tbody (db.cals.tbody) - A wrapper for the rows of a table or informal table
 tbody (db.html.tbody) - A wrapper for the rows of a table or informal table
 td - A table entry in an HTML table
 term - The word or phrase being defined or described in a variable list
 termdef - An inline definition of a term
 tertiary - A tertiary word or phrase in an index term
 tertiaryie - A tertiary term in an index entry, rather than in the text
 textdata - Pointer to external text data
 textobject - A wrapper for a text description of an object
and its associated meta-information
 tfoot (db.cals.tfoot) - A table footer consisting of one or more rows
 tfoot (db.html.tfoot) - A table footer consisting of one or more rows
 tgroup - A wrapper for the main content of a table, or part of a table
 th - A table header entry in an HTML table
 thead (db.cals.entrytbl.thead) - A table header consisting of one or more rows
 thead (db.cals.thead) - A table header consisting of one or more rows
 thead (db.html.thead) - A table header consisting of one or more rows
 tip - A suggestion to the user, set off from the text
 title - The text of the title of a section of a document
or of a formal block-level element
 titleabbrev - The abbreviation of a title
 toc - A table of contents
 tocdiv - A division in a table of contents
 tocentry - A component title in a table of contents
 token - A unit of information
 tr - A row in an HTML table
 trademark - A trademark
 type - The classification of a value

21. U

    uri - A Uniform Resource Identifier
 userinput - Data entered by the user

22. V

    varargs - An empty element in a function synopsis indicating
a variable number of arguments
 variablelist - A list in which each entry is composed of a
set of one or more terms and an associated description
 varlistentry - A wrapper for a set of terms and the associated
description in a variable list
 varname - The name of a variable
 videodata - Pointer to external video data
 videoobject - A wrapper for video data and its associated meta-information
 void - An empty element in a function synopsis indicating
that the function in question takes no arguments
 volumenum - The volume number of a document in a set (as
of books in a set or articles in a journal)

23. W

    warning - An admonition set off from the text
 wordasword - A word meant specifically as a word and not
representing anything else

24. X

    xref - A cross reference to another part of the document

25. Y

    year - The year of publication of a document

Crazy ITer

Docbook学习笔记

Chapter 1. Docbook的编辑工具

1. XMLMind

1.1. 安装使用

1.1.1. 我的版本

1.1.2. 安装

1.1.3. 使用

1.2. 更强大的Docbook的模版？

1.3. Docbook5或更高？

1.3.1. 安装Docbook5的Add-On

1.3.2. 编写Docbook5文档

1.3.3. 升级Docbook5

1.3.4. 为Docbook5添加新模板

1.4. 几个编译成HTML的技巧

1.4.1. 用指定的文件名生成HTML文件

1.4.2. XMLMind中的文件分割

1.4.3. 改变生成Html的编码

Chapter 2. Docbook文档分析

1. Docbook元素的分类

1.1. Sets

1.2. Books

1.3. Divisions

1.4. Components

1.5. Sections

1.6. Meta-information

1.7. Block

1.7.1. Lists

1.7.1.1. calloutlist

1.7.1.2. bibliolist

1.7.1.3. glosslist

1.7.1.4. itemizedlist

1.7.1.5. orderedlist

1.7.1.6. segmentedlist

1.7.1.7. simplelist

1.7.1.8. variablelist

1.7.2. Admonitions（警告）

1.7.2.1. caution

1.7.2.2. important

1.7.2.3. note

1.7.2.4. tip

1.7.2.5. warning

1.8. Inline

2.

Chapter 3. Docbook的文档转换

1. 安装必备环境

1.1. DocBook DTD或Schema

Chapter 4. DocBook XSL

1. Chunk

Note

2. 编码

Note

Chapter 5. DocBook元素参考

DocBook Element Reference

1. A

2. B

3. C

4. D

5. E

6. F

7. G

8. H

9. I

10. J

11. K

12. L

13. M

14. N

15. O

16. P

17. Q

18. R

19. S

20. T

21. U

22. V

23. W

24. X

25. Y

26.