制作Docbook文档

1. 制作Docbook文档需要了解的知识:

  1. XML - 这是最基本的,如果这个都不懂的话,最好先找本入门级的书看看;
  2. DTD - 有助于你理解Docbook的结构;
  3. XSL - 有助于定制自己的Docbook;
  4. XSL-FO - 最好了解一点,有助于更好的定制自己的PDF输出。

2. 制作Docbook文档的最简单的过程包括以下的步骤:

  1. 编辑XML文件;
  2. 对XML文件进行处理,生成HTML或者PDF文档。

2.1. 编辑XML文件

如果使用纯文本编辑器来完成这项工作,我敢打赌一天之后你就做不下去了,直接编辑XML可是一件苦差事。使用类似XMLSPY这样的工具,提供自动填充功能,并且随时可以进行有效性检查,不容易出错,可以让工作轻松不少。

Docbook文档分两类:书(book)和文章(article)。article就是一般的文章,不包含章(chapter),只有节(section)。book比较完整,可以包含前言(preface),部分(part),章(chapter),文章(article)等等。以上描述的都是Docbook DTD定义的元素,这里不可能给出详细的说明,具体每个元素的结构参见Docbook DTD。

让我们先来看一个book类型文档的典型定义:

list 1. 典型的book类型文档

 1<book>
 2<bookinfo>
 3<title>My Book</title>
 4<author>
 5<firstname>My First Name</firstname>
 6<surname>My Last Name</surname>
 7</author>
 8<publisher>
 9<publishername>CSDN</publishername>
10</publisher>
11<isbn>ISBN#</isbn>
12<copyright>
13<year>2005</year>
14</copyright>
15</bookinfo>
16<part>
17<title>My Part</title>
18<chapter>
19<title>My Chapter</title>
20<sect1>
21<title>My Section1</title>
22<para>This is a demo of a book.</para>
23</sect1>
24</chapter>
25</part>
26</book>

该文档声明使用的DTD为 http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd ,所有的内容都包含在book元素中,bookinfo元素包含书名(title)、作者(author)、出版社(publisher)、书号(isbn)和版权(copyright)。接着part元素包含的内容是该书的一个部分,下面有一章,接着有一节(sect1),当然都有各自的标题。

怎么样,各个元素的含义是不是很显而易见,根据元素的名称,你就能知道自己的内容该包含在什么元素里面。

在上面的例子里面,有些元素不是必须的。譬如bookinfo,可以没有或者有一个,看Docbook DTD就可以知道。

下面我以article类型的文档为例子,说明Docbook文档的制作过程。

首先是XML声明,说明文档的一些基本信息:

紧接着是文档的DTD声明,说明文档使用的DTD还有根元素。典型的docbook文档的DTD声明如下:

这个声明表明,文档的根元素是

  1<article>,使用外部DTD,该DTD用一个公共标识符  "-//OASIS//DTD DocBook XML V4.2//EN"  标识,该DTD位于网络的某处。标识符必须是全球唯一的,其形式为:   
  2_  
  3prefix _ // _` owner-identifier ` _ // _` text-class ` _ _` text-description ` _ // _` language ` _ // _` display-version ` _   
  4  
  5第一个prefix为“+/-”,“+”表示是已注册的标识,“-”则相反。其他各部分的含义自己对照。   
  6  
  7接着就可以添加内容了。首先是根元素:   
  8<article>
  9</article>   
 10  
 11article必须有一个标题:   
 12  
 13<article>
 14<title>My Article</title>
 15</article>   
 16  
 17标题之后必须有内容,不可能有无内容的文章:   
 18  
 19<article>
 20<title>My Article</title>
 21<sect1>
 22</sect1>
 23</article>   
 24  
 25这里我们添加一个小节,“sect1”是小节的最顶层元素,其编排方式与MS Word的“heading 1”类似。   
 26  
 27与article相同,sect1也必须有标题:   
 28  
 29<article>
 30<title>My Article</title>
 31<sect1>
 32<title>My Section</title>
 33</sect1>
 34</article>   
 35  
 36sect1也不允许无内容:   
 37  
 38<article>
 39<title>My Article</title>
 40<sect1>
 41<title>My Section</title>
 42<para>This is my first article.</para>
 43</sect1>
 44</article>   
 45  
 46正文的内容一般用<para>元素封装,para即段落(paragraph)的意思。   
 47  
 48现在就有了一个最简单的Docbook文档。list 2是完整的代码。   
 49  
 50list 2. 一个简单的article文档   
 51<?xml version="1.0" encoding="UTF-8"?>
 52<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"   
 53"  http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd  ">
 54
 55<article>
 56<title>My Article</title>
 57<sect1>
 58<title>My Section</title>
 59<para>This is my first article.</para>
 60</sect1>
 61</article>   
 62  
 63编辑完成之后,保存为myarticle.xml,接着就可以生成HTML或者PDF了。   
 64  
 652.2 生成HTML   
 66  
 67关于如何安装配置工具,参见 http://blog.csdn.net/mickeyrat/archive/2005/02/06/283471.aspx 。   
 68  
 69我使用cygwin下的xsltproc来生成HTML,在cygwin的shell中输入命令:   
 70  
 71xsltproc --nonet --output myarticle.html c:/docbook-xsl-1.67.2/html/docbook.xsl myarticle.xml   
 72  
 73nonet表示我不希望从网络获取DTD,这样可以节省时间。   
 74  
 75output指定我希望输出的文件名,这里指定的是myarticle.html。   
 76  
 77紧接着是用来转换XML文件的XSL样式单,需要注意,使用的是html目录下的XSL样式单。   
 78  
 79最后是要处理的Docbook文档。   
 80  
 81没有意外的话,现在你就可以用浏览器打开myarticle.html看看效果了。   
 82  
 832.3 生成PDF文件   
 84  
 85下面使用FOP生成PDF文件。关于如何安装配置FOP,参见 http://blog.csdn.net/mickeyrat/archive/2005/02/06/283471.aspx 。   
 86  
 87在控制台输入命令:   
 88  
 89fop -xml myarticle.xml -xsl C:\docbook-xsl-1.67.2\fo\docbook.xsl myarticle.pdf   
 90  
 91Linux的命令类似,注意docbook.xsl的路径。   
 92  
 93-xml指定需要转换的docbook文档。   
 94  
 95-xsl指定使用的样式单,注意,这里使用的fo目录下的样式单,这是专为转换XSL-FO开发的。   
 96  
 97最后是输出文档的文件名。   
 98  
 99在FOP处理过程中,会输出许多诸如   
100  
101property - "background-position-horizontal" is not implemented yet.   
102  
103的信息。不用理会,这是因为FOP还在开发中,许多XSL-FO的特性都不支持。这样的问题并不影响最终文档的生成。   
104  
105快打开myarticle.pdf看看效果吧,是不是很专业的PDF文档?   
106  
107是不是觉得制作docbook文档很简单呢?这么想可就错了,本文剩余的部分会介绍制作docbook文档的高级技巧。   
108  
1093\. 定制自己的XSL样式单   
110  
111当你开始正式制作自己的docbook文档之后,你会发现生成的文档并不能完全满足你对格式的要求,譬如章节号、页码、标题等等。这一节就告诉你如何定制自己的XSL样式单,生成满足特定的需求的文档。下面的内容会涉及XSL和XSL-FO。   
112  
113(明天继续:))</para></article>
Published At
Categories with Web编程
Tagged with
comments powered by Disqus