maven-jdocbook-plugin 使用

DocBook 是一个文档工具，Spring、Hibernate 等开源项目都是用它来编写、生成多格式文档的。这里主要介绍在 maven 环境中使用 maven-jdocbook-plugin 插件来使用 DocBook。

POM 中加入 jdocbook 插件：

<plugin>
    <groupId>org.jboss.maven.plugins</groupId>
    <artifactId>maven-jdocbook-plugin</artifactId>
    <version>2.3.8</version>
    <extensions>true</extensions>
    <configuration>
        <masterTranslation>zh-CN</masterTranslation>
        <formats>
            <format>
                <formatName>html</formatName>
            </format>
        </formats>
    </configuration>
 1&lt;dependencies&gt;
 2    &lt;dependency&gt;
 3        &lt;groupId&gt;org.jboss&lt;/groupId&gt;
 4        &lt;artifactId&gt;jbossorg-docbook-xslt&lt;/artifactId&gt;
 5        &lt;version&gt;1.1.1&lt;/version&gt;
 6        &lt;/dependency&gt;
 7    &lt;dependency&gt;
 8        &lt;groupId&gt;org.jboss&lt;/groupId&gt;
 9        &lt;artifactId&gt;jbossorg-jdocbook-style&lt;/artifactId&gt;
10        &lt;version&gt;1.1.1&lt;/version&gt;
11        &lt;type&gt;jdocbook-style&lt;/type&gt;
12    &lt;/dependency&gt;
13&lt;/dependencies&gt;
14
15&lt;executions&gt;
16    &lt;execution&gt;
17        &lt;id&gt;SDK_Manual_zh_CN&lt;/id&gt;
18        &lt;phase&gt;package&lt;/phase&gt;
19        &lt;goals&gt;
20            &lt;goal&gt;resources&lt;/goal&gt;
21            &lt;goal&gt;generate&lt;/goal&gt;
22        &lt;/goals&gt;
23
24        &lt;configuration&gt;
25            &lt;sourceDocumentName&gt;index.xml&lt;/sourceDocumentName&gt;
26            &lt;sourceDirectory&gt;${basedir}/src/main/docs&lt;/sourceDirectory&gt;
27            &lt;imageResource&gt;
28                &lt;directory&gt;${basedir}/src/main/docs/images&lt;/directory&gt;
29            &lt;/imageResource&gt;
30            &lt;cssResource&gt;
31                &lt;directory&gt;${basedir}/src/main/docs/css&lt;/directory&gt;
32            &lt;/cssResource&gt;
33
34            &lt;formats&gt;
35                &lt;format&gt;
36                    &lt;formatName&gt;html&lt;/formatName&gt;
37                    &lt;stylesheetResource&gt;classpath:/xslt/org/jboss/xhtml.xsl&lt;/stylesheetResource&gt;
38                    &lt;finalName&gt;index.html&lt;/finalName&gt;
39                &lt;/format&gt;
40                &lt;format&gt;
41                    &lt;formatName&gt;html_single&lt;/formatName&gt;
42                    &lt;stylesheetResource&gt;classpath:/xslt/org/jboss/xhtml-single.xsl&lt;/stylesheetResource&gt;
43                    &lt;finalName&gt;index.html&lt;/finalName&gt;
44                &lt;/format&gt;
45            &lt;/formats&gt;
46
47            &lt;options&gt;
48                &lt;xincludeSupported&gt;true&lt;/xincludeSupported&gt;
49            &lt;/options&gt;
50        &lt;/configuration&gt;
51    &lt;/execution&gt;
52&lt;/executions&gt;

</plugin>

还需要加入 JBoos 的 mvn 库：

<repositories>
    <repository>
        <id>jboss-public-repository-group</id>
        <name>JBoss Public Repository Group</name>
        <url>http://repository.jboss.org/nexus/content/groups/public/</url>
    </repository>
</repositories>

目录结构：

本文主要是参考用maven-jdocbook-plugin简单配置docbook5.0环境所写，并修复了其中一些配置有误的地方。