2009-09-29 6 views
5

Actualmente estoy trabajando en un proyecto escrito en Java y estoy usando Maven y el maven-site-plugin para generar un sitio web que contenga todos los JavaDoc relevantes, informes, etc. Necesito al mismo tiempo, para poder convertir la misma documentación en un formato legible y similar a un libro. ¿Existen scripts o herramientas diseñados para tomar un sitio web y convertirlo en un PDF con formato razonable u otro estilo para que se pueda dar fácilmente digitalmente o imprimir?Convertir la documentación del software Maven Site a PDF

Respuesta

7

El maven-pdf-plugin genera un PDF de la documentación del proyecto.

Dos notas de la documentación a considerar:

Nota 1: Por defecto, el plugin PDF genera un documento PDF que agrega todos los documentos del sitio. Si desea generar cada documento de sitio individualmente, debe agregar -Daggregate = false en la línea de comando.

Nota 2: De forma predeterminada, el complemento de PDF utiliza la implementación de FOP. El plugin también es compatible con la implementación de iText, solo necesita agregar -Dimplementation = itext en la línea de comando.

En realidad se puede especificar la propiedad agregada en su POM (ver ejemplo a continuación)

Esta configuración generará el PDF en cada generación que el perfil docs está activo (que podría hacerlo en cada generación, pero sería un poco lento para el típico ciclo de desarrollo:.

<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> 

puede activar el perfil en la línea de comandos con -P docs o utilizar una configuración activation si quieres ser de grano fino

+0

Lo único que este plugin parece ser incapaz de hacer es incluir algunos de los informes generados por maven más extensos, ya que tiene que darle una lista de cada archivo para incluir, que sería una tonelada para cosas como JavaDoc y wouldn ' t trabaja dinámicamente a medida que cambia el código. – FModa3

+0

@ FModa3 sí, no es ideal, pero una solución para eso es usar algo como el complemento groovy para procesar los archivos para generar el xsl –