金氧

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>

    <dependencies>
        <dependency>
            <groupId>org.jboss</groupId>
            <artifactId>jbossorg-docbook-xslt</artifactId>
            <version>1.1.1</version>
            </dependency>
        <dependency>
            <groupId>org.jboss</groupId>
            <artifactId>jbossorg-jdocbook-style</artifactId>
            <version>1.1.1</version>
            <type>jdocbook-style</type>
        </dependency>
    </dependencies>

    <executions>
        <execution>
            <id>SDK_Manual_zh_CN</id>
            <phase>package</phase>
            <goals>
                <goal>resources</goal>
                <goal>generate</goal>
            </goals>

            <configuration>
                <sourceDocumentName>index.xml</sourceDocumentName>
                <sourceDirectory>${basedir}/src/main/docs</sourceDirectory>
                <imageResource>
                    <directory>${basedir}/src/main/docs/images</directory>
                </imageResource>
                <cssResource>
                    <directory>${basedir}/src/main/docs/css</directory>
                </cssResource>

                <formats>
                    <format>
                        <formatName>html</formatName>
                        <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
                        <finalName>index.html</finalName>
                    </format>
                    <format>
                        <formatName>html_single</formatName>
                        <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
                        <finalName>index.html</finalName>
                    </format>
                </formats>

                <options>
                    <xincludeSupported>true</xincludeSupported>
                </options>
            </configuration>
        </execution>
    </executions>
</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&gt;
    </repository>
</repositories>

目录结构:

目录结构

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

« 防风,但不防傻逼 RabbitMQ 网络分区问题 »