Skip to content
Mohammad Naghavi edited this page Aug 4, 2015 · 2 revisions

Add XDocReport JARs in your project

XDocReport is modular and you can add only the modules that your require to your project. There are some core modules which should be always included and some other modules that depend on what kind of source document (ODT or DOCX) and which template engine you decided to use.

In any case you may either copy the JAR files directly or use build tools like Gradle to provide the dependency for you from Maven Central Repository.

Core Modules

For any document type and template engine you need to add at least following JARs :

**JARs name** **Description** **OSGi Bundle/Fragment**
fr.opensagres.xdocreport.core XDocReport Core Bundle
fr.opensagres.xdocreport.document Document type API Bundle
fr.opensagres.xdocreport.template Template engine API Bundle
fr.opensagres.xdocreport.converter Converter API Bundle

Docx Source Document Modules

If you are going to use DOCX as document source for your report, so you need to include following modules too:

**JARs name** **Description** **OSGi Bundle/Fragment**
fr.opensagres.xdocreport.document.docx Docx Document implementation Fragment -> fr.opensagres.xdocreport.document

Note for OSGi: this JAR is a fragment linked to the bundle OSGi fr.opensagres.xdocreport.document.

ODT Source Document Modules

If you are going to use ODT as document source for your report, so you need to include following modules too:

*JARs name* *Description* *OSGi Bundle/Fragment*
fr.opensagres.xdocreport.document.odt ODT Document implementation Fragment -> fr.opensagres.xdocreport.document

Note for OSGi: this JAR is a fragment linked to the bundle OSGi fr.opensagres.xdocreport.document.

Velocity JARs

If Velocity is your choice of template engine, you have to include Velocity template interface as well as Velocity library itself too.

Velocity Template Interface

Add Velocity template engine interface module:

*JARs name* *Description* *OSGi Bundle/Fragment*
fr.opensagres.xdocreport.template.velocity Velocity template engine implementation Fragment -> fr.opensagres.xdocreport.template

Note for OSGi: this JAR is a fragment linked to the bundle OSGi fr.opensagres.xdocreport.template.

Velocity Library

Add Velocity JARs:

*JARs name* *Description*
velocity-1.7 Velocity
commons-collections-3.2.1 Commons Collection
commons-lang-2.4 Commons Lang
oro-2.0.8 ORO
Clone this wiki locally