D 的个人博客

开源程序员,自由职业者

小而美的 Java 博客系统 Solo
Golang 在线 IDE Wide
黑客与画家的社区 Sym
  menu
398 文章
1,769 评论
3343045 浏览
5 当前访客
ღゝ◡╹)ノ❤️

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>
&lt;dependencies&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.jboss&lt;/groupId&gt;
        &lt;artifactId&gt;jbossorg-docbook-xslt&lt;/artifactId&gt;
        &lt;version&gt;1.1.1&lt;/version&gt;
        &lt;/dependency&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.jboss&lt;/groupId&gt;
        &lt;artifactId&gt;jbossorg-jdocbook-style&lt;/artifactId&gt;
        &lt;version&gt;1.1.1&lt;/version&gt;
        &lt;type&gt;jdocbook-style&lt;/type&gt;
    &lt;/dependency&gt;
&lt;/dependencies&gt;

&lt;executions&gt;
    &lt;execution&gt;
        &lt;id&gt;SDK_Manual_zh_CN&lt;/id&gt;
        &lt;phase&gt;package&lt;/phase&gt;
        &lt;goals&gt;
            &lt;goal&gt;resources&lt;/goal&gt;
            &lt;goal&gt;generate&lt;/goal&gt;
        &lt;/goals&gt;

        &lt;configuration&gt;
            &lt;sourceDocumentName&gt;index.xml&lt;/sourceDocumentName&gt;
            &lt;sourceDirectory&gt;${basedir}/src/main/docs&lt;/sourceDirectory&gt;
            &lt;imageResource&gt;
                &lt;directory&gt;${basedir}/src/main/docs/images&lt;/directory&gt;
            &lt;/imageResource&gt;
            &lt;cssResource&gt;
                &lt;directory&gt;${basedir}/src/main/docs/css&lt;/directory&gt;
            &lt;/cssResource&gt;

            &lt;formats&gt;
                &lt;format&gt;
                    &lt;formatName&gt;html&lt;/formatName&gt;
                    &lt;stylesheetResource&gt;classpath:/xslt/org/jboss/xhtml.xsl&lt;/stylesheetResource&gt;
                    &lt;finalName&gt;index.html&lt;/finalName&gt;
                &lt;/format&gt;
                &lt;format&gt;
                    &lt;formatName&gt;html_single&lt;/formatName&gt;
                    &lt;stylesheetResource&gt;classpath:/xslt/org/jboss/xhtml-single.xsl&lt;/stylesheetResource&gt;
                    &lt;finalName&gt;index.html&lt;/finalName&gt;
                &lt;/format&gt;
            &lt;/formats&gt;

            &lt;options&gt;
                &lt;xincludeSupported&gt;true&lt;/xincludeSupported&gt;
            &lt;/options&gt;
        &lt;/configuration&gt;
    &lt;/execution&gt;
&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环境 所写,并修复了其中一些配置有误的地方。

评论