XMLWorker Documentation ( itextdoc )

As promised after the release of iText and XMLWorker, there would be a release of itextdoc. Our project to parse our own documentation for the XMLWorker with the XMLWorker.

The itextdoc maven plugin is now available from Maven Central. To use it in your build cycle of a project add

<plugin>
   <groupId>com.itextpdf.maven</groupId>
   <artifactId>itextdoc</artifactId>
   <version>0.1.0</version>
   <executions>
    <execution>
      <phase>package</phase>
      <goals>
         <goal>create</goal>
      </goals>
      <inherited>false</inherited>
    </execution> 
   </executions>
</plugin>

What does it do and how can you use it?

itextdoc transforms html to PDF with iText and XMLWorker. Optionally you can transform the html to a styled website but that’s still under construction.

By default the plugin looks for a folder itextdoc under the src folder. Easily configure another folder by adding a configuration to the executuion.

<configuration>
  <flatsite>true</flatsite> // enable generation of a site
  <site>true</site> // enable generation of a javascript driven site
  <src>src/doc</src> // change default source directory
  </configuration>

Currently only a doc.xml file is accepted as the xml file wherein you define the different html files (or one) and your CSS file.

The result is something like this. The initial documentation for itext doc, not styled with custom css.

To create a website use the site and flatsite configuration parameters. But the site generation is not yet fully functioning.

Where to request features and report bugs?

At sourceforge features, bugs.

Other links
check for latest version
Ohloh
iText

Note: don’t forget iText, XMLWorker are AGPL.

2 Replies to “XMLWorker Documentation ( itextdoc )”

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: