将Maven站点软件文档转换为PDF

时间:2009-09-29 14:24:44

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

我目前正在开发一个用Java编写的项目,我正在使用Maven和maven-site-plugin生成一个包含所有相关JavaDoc,报告等的网站。我需要同时能够将相同的文档转换为可读的书本格式。是否有任何脚本或工具设计用于访问网站,并将其转换为格式合理的PDF或其他样式,以便可以轻松地以数字形式或打印出来?

1 个答案:

答案 0 :(得分:7)

maven-pdf-plugin生成项目文档的PDF。

要考虑的文件中的两个注释:

  

注1:默认情况下,PDF插件会生成一个PDF文档,该文档汇总了您的所有站点文档。如果要单独生成每个站点文档,则需要在命令行中添加-Daggregate=false

     

注2:默认情况下,PDF插件使用FOP实现。该插件还支持iText实现,您只需在命令行中添加-Dimplementation=itext

您实际上可以在POM中指定聚合属性(请参阅下面的示例)。

此配置将在docs配置文件处于活动状态的每个构建版本上生成PDF(您可以在每次构建时执行此操作,但对于典型的开发周期来说,它会有点慢:

<profiles>
  <profile>
    <id>docs</id>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pdf-plugin</artifactId>
      <version>1.0</version>
      <executions>
        <execution>
          <id>pdf</id>
          <phase>site</phase>
          <goals>
            <goal>pdf</goal>
          </goals>
          <configuration>
            <outputDirectory>
              ${project.reporting.outputDirectory}
            </outputDirectory>
            <aggregate>false</aggregate>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </profile>
</profiles>

您可以使用-P docs在命令行上激活配置文件,或者如果您想要更细粒度,请使用activation配置。