使用maven创建文档

DocBook是Doxia的众多支持输入之一,Doxia是maven用来生成文档的引擎。请参阅: http://maven.apache.org/doxia/modules/index.html

事实上,Doxia网站回答了您的确切问题: http://maven.apache.org/doxia/book/index.html

您可以使用mvnsite命令(即使用 plugin site ).

this page .

基本上,您可以使用 APT 几乎纯文本 这很容易理解),或者是基于XML的格式, Xdoc

2年前,我使用XDoc格式和SiteMaven插件为我开发的一个应用程序创建了一个完整的用户指南。在全球范围内,这是相当容易创建的!

我希望这对你有帮助!

我已经成功地使用了Maven插件Docbkx。你应该试一试

Docbkx

你一定要看看 Maven Docbkx Plugin . 它可能适合你的需要。Doxia对DocBook的支持是次优的。事实上,上次我尝试它时,它产生了一些新的东西——据我所知——不是DocBook。

我提到的Maven Docbkx插件支持世界上所有的定制(通过插件参数,或者XSLT覆盖,如果你喜欢的话)+它提供了一些机制来将它与Maven构建集成。(例如将Maven pom属性包含到文档中的处理说明。)

请注意,我们的目标是拥有一个插件,防止您自己手动组装一个处理链。所以这个插件既可以转换为FO,也可以转换为PDF。

我最近使用docbook和maven的docbkx插件为我的maven多模块项目实现了项目文档。我现在有它自动生成html和pdf文件,每次我建立项目网站。我认为docbkx真的很棒,所以我建议你用它。

这是真的-您可以使用maven站点和doxia插件创建一个非常好的站点。事实上,我正在使用这两种方法来生成我的项目站点,但是doxia对docbook的支持非常有限,并且不允许您模块化文档,例如,包括主文档中的部分文档。所以对于大型参考手册,我使用的是docbkx。

如果你想看一眼,我的项目是 here

卡洛斯

虽然这个问题已经很老了,但我想对此进行更新。如果你想在你的文档中使用LaTeX,你应该使用maven插件来生成文档。有几个maven插件正在这样做,但是很多插件不再维护。

看看: mathan-latex-maven-plugin

目前还没有官方或半官方的插件可以处理LaTeX或DocBook,但您可以做的(除了使用上述站点插件外)是配置exec插件,以便在站点生命周期内(即在构建项目网站的同时)处理LaTeX/DocBook源。

例如,类似

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>exec-maven-plugin</artifactId>
  <executions>
    <execution>
    <id>latex</id>
    <goals>
      <goal>exec</goal>
    </goals>
    <phase>site</phase>
      <configuration>
          ...
      </configuration>
    </execution>
  </executions>
</plugin>