org.jodconverter:jodconverter-local

  ^LibreOffice / _{Apache OpenOffice}

What you want to know...

• Documentation: The JODConverter documentation (work in progress) can be found here.
• Examples: A dedicated repository with sample projects can be found here.
• Dependencies:
  • jodconverter-local module dependencies.
  • jodconverter-remote module dependencies.
  • jodconverter-spring module dependencies.
  • jodconverter-spring-boot-starter module dependencies.
• Tests: JODConverter is supposed to work just fine on recent versions of Windows, MacOS and Unix/Linux. Any confirmation would be welcome, so we could build a list of official supported OS distributions.

Usage for local conversions

Build default, JODConverter is built using the OpenOffice libraries. See here to know why. But you can now decide whether you want to use JODConverter with the LibreOffice libraries or the OpenOffice libraries.

With LibreOffice libraries:

Gradle:

implementation 'org.jodconverter:jodconverter-local-lo:4.4.8'

Maven:

<dependency>
  <groupId>org.jodconverter</groupId>
  <artifactId>jodconverter-local-lo</artifactId>
  <version>4.4.8</version>
</dependency>

With OpenOffice libraries:

Gradle:

implementation 'org.jodconverter:jodconverter-local:4.4.8'

or

implementation 'org.jodconverter:jodconverter-local-oo:4.4.8'

Maven:

<dependency>
  <groupId>org.jodconverter</groupId>
  <artifactId>jodconverter-local</artifactId>
  <version>4.4.8</version>
</dependency>

or

<dependency>
  <groupId>org.jodconverter</groupId>
  <artifactId>jodconverter-local-oo</artifactId>
  <version>4.4.8</version>
</dependency>

Building the Project

gradlew clean build -x test

Building Cli Executable

gradlew clean build -x test distZip

Support ^{:speech_balloon:}

JODConverter Gitter Community , growing FAQ.

How to contribute

1. Check for open issues, or open a new issue to start a discussion around a feature idea or a bug.
2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact me on Gitter using the link above.
3. Fork this repository on GitHub to start making your changes.
4. Write a test showing that the bug was fixed or that the feature works as expected.
5. Note that the repository follows the Google Java style. You can format your code to this format by typing gradlew spotlessApply on the subproject you work on (e.g, gradlew :jodconverter-local:spotlessApply), by using the Eclipse plugin, or by using the Intellij plugin.
6. Create a pull request, and wait until it gets merged and published.

Credits...

Here are my favorite/inspiration forks/projects:

• documents4j project: Nice choice if you want 100% perfect conversion using MS Office. But work only on Windows out of the box (Local implementation) and not totally free (since MS Office is not free). The new "job" package is strongly inspired by this project.

Original JODConverter

JODConverter (Java OpenDocument Converter) automates document conversions using LibreOffice or OpenOffice.org.

The previous home for this project is at Google Code, including some wiki pages.

Donations

If this project helps you, please consider a cup of :coffee:. Thanks!! :heart: