使用maven创建文档

时间:2008-11-05 12:05:46

标签: maven-2 latex docbook maven-pdf-plugin

我正处于重访maven的过程中。当我们上次查看这个时,我们的团队经历了糟糕的经历,因为在maven从1.x重新架构到2.x期间,我们需要的很多依赖项没有被移动到新的存储库中。但是,我现在有时间重新考虑。

我有兴趣使用maven和LaTeX或DocBook来创建文档,我想知道是否有人有任何共享经验,项目/模块结构,使用好的插件等等......

非常感谢: - )

编辑:

为了澄清,我本来想写一篇技术文章/书,我想要的文物可能是PDF。

7 个答案:

答案 0 :(得分:7)

DocBook是Doxia的众多支持输入之一,Doxia是用于通过maven生成docs的引擎。请参阅此处:http://maven.apache.org/doxia/modules/index.html

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

答案 1 :(得分:6)

您可以使用mvn site命令(即使用plugin site)轻松地使用Maven创建一个包含文档的站点(

)。

此插件创建技术报告(例如Javadoc,单元测试报告,代码覆盖率......),但也可用于创建“真实站点”。 您在this page

中有更多详细信息

基本上,您使用APT几乎纯文本,非常容易理解)或基于XML的格式Xdoc来编写页面。

2年前,我使用XDoc格式和Site Maven插件为我开发的一个应用程序创建了完整的用户指南。在全球范围内,创建起来非常容易!

我希望这会对你有所帮助!

答案 2 :(得分:3)

我一直在使用Maven插件Docbkx。你应该试一试

Docbkx

答案 3 :(得分:2)

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

我所指的Maven Docbkx插件支持世界的所有自定义(通过插件参数或XSLT覆盖,如果你进入那个)+它具有一些机制来将它与Maven构建集成。 (例如将Maven pom属性包含在文档中的处理说明。)

请注意,目标是拥有一个插件,可以防止您自己手动组建处理链。因此,这个插件将转换为FO,并将其转换为PDF。

答案 4 :(得分:0)

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

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

如果你想看一眼,我的项目是here。您可以实际下载源代码并查看它的细节。当然,如果您对此设置有任何疑问,我将非常乐意提供帮助。

干杯 卡洛斯

答案 5 :(得分:0)

虽然这个问题很老,但我想对此进行更新。如果您想将LaTeX用作文档,则应使用maven插件生成文档。有几个maven-plugins这样做,但很多都不再维护了。  有一个新的maven-plugin,它需要一个或多个配置才能使它工作,生成的PDF(或PS或DVI)可以作为工件发布。

查看:mathan-latex-maven-plugin

答案 6 :(得分:-3)

AFAIK没有官方或半官方插件可以处理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>