Convertire la documentazione del software del sito Maven in PDF

Question

Attualmente sto lavorando su un progetto scritto in Java e sto usando Maven e il plugin del sito maven per generare un sito Web contenente tutti i relativi JavaDoc, report, ecc. Ho bisogno di allo stesso tempo per essere in grado di convertire la stessa documentazione in un formato leggibile, simile a un libro. Esistono script o strumenti progettati per prendere un sito Web e convertirlo in un PDF formattato in modo ragionevole o in un altro stile in modo che possa essere facilmente fornito digitalmente o stampato?

Answer 1

Il maven-pdf-plugin genera un PDF della documentazione del progetto.

Due note dalla documentazione da considerare:

Nota 1: Per impostazione predefinita, il plug-in PDF genera un documento PDF che aggrega tutti i documenti del sito. Se si desidera generare singolarmente ciascun documento del sito, è necessario aggiungere -Daggregate = false nella riga di comando.

Nota 2: Per impostazione predefinita, il plug-in PDF utilizza l'implementazione FOP. Il plugin supporta anche l'implementazione di iText, è sufficiente aggiungere -Dimplementation = itext nella riga di comando.

Si può effettivamente specificare la proprietà di aggregazione nel POM (vedi esempio sotto)

Questa configurazione genera il PDF su ogni costruire che il profilo docs è attivo (si potrebbe fare su ogni costruzione, ma sarebbe un po 'lento per il tipico ciclo di sviluppo:.

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

è possibile attivare il profilo sulla riga di comando con -P docs o utilizzare una configurazione activation se si vuole essere più dettagliato