Giter VIP home page Giter VIP logo

jodconverter's Introduction

  LibreOffice / Apache OpenOffice

Build status Build Status Coverage Status Codacy Badge License Maven Central Javadocs Join the chat at https://gitter.im/jodconverter/Lobby

I created this fork because I had to do some changes to the original project and now it is time to share my work with the community.

What you want to know...

  • Documentation: The JODConverter documentation (work in progress) can be found here.
  • Dependencies: See this for main project dependencies. This fork does not depend on SIGAR. JODConverter only needs to retrieve office processes (PIDs) and kill office processes (using PID). It should work just fine without SIGAR with the actual process managers created from an older version of JODConverter. But I added the ability to use any process manager you would like to implement if none of the provided managers can be used. See the processManager configuration option.
  • 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

Gradle:

compile 'org.jodconverter:jodconverter-local:4.2.0'

Maven:

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

Building the Project

With LibreOffice libraries:

gradlew clean build -x test

With OpenOffice libraries:

gradlew clean build -x test -PuseOpenOffice

Building Cli Executable

gradlew clean build -x test distZip

Support 💬

JODConverter Gitter Community Join the chat at https://gitter.im/jodconverter/Lobby, 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:

  • XWiki fork: Nice choice if you can afford using the SIGAR tools (which I couldn't sadly). The filter package is strongly inspired by this project.
  • Nuxeo fork: Nice choice if you don't want to use SIGAR and don't came across an unresponsive office process following a timeout exception that drives you crazy.
  • 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.

A special thanks to:

@michelole who created a pull request in these two forks with a stress test that made my office process to crash every times! My first commit was when I was able to build my things with his stress test on!!

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.

jodconverter's People

Contributors

sbraconnier avatar joseluisll avatar michelole avatar mirkonasato avatar recurve avatar aruis avatar gitter-badger avatar

Watchers

James Cloos avatar Max avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.