LibreOffice Eclipse plugin for extension development
Clone or download
shobhanmandal and smehrbrodt Revert changes: OXT Export: Automatically add .oxt extension #51 (#69)
The changes made was not required since during the creation of the UnoPackage which ultimately results in the ".oxt" file this has been handled in org.libreoffice.plugin.core.model.UnoPackage.java
Latest commit 1322576 May 17, 2018

README.md

LOEclipse

This plugin helps with developing and debugging LibreOffice extensions/components from Eclipse.

This release supports only LibreOffice 5.0 and upwards (due to some changed internal paths). It was tested with Eclipse Mars (4.5). Older versions might still work, but are untested.

For historic releases supporting older versions of LibreOffice (and OpenOffice) visit this site.

Installation

Install this plugin via the Eclipse Marketplace. Drag the button below to your running Eclipse instance.

Drag to your running Eclipse workspace to install LOEclipse

After installing the plugin, you can create new extensions/components by using File->New->Project->LibreOffice.

You can also have a look at the LibreOffice Starter Extension. It contains a step-by-step guide to get started with extension development.

Documentation

Developer and User Documentation is found in core/doc/help/html.

Development

Communication

Feel free to join #libreoffice-dev on freenode to get in touch with LibreOffice and LOEclipse developers.

You can also write to the LibreOffice development mailing list if you have trouble working on this project.

Prerequisites

Setup Eclipse for development

  1. Install Eclipse IDE for Eclipse Committers. The Eclipse IDE for Java Developers will not work.
  2. Clone this repository
  3. Import the three projects build, core and java (using File->Import->General->Existing projects into workspace)
  4. Add the LibreOffice jars to the build path
    • Go to Window->Preferences in Eclipse and open the Java->Build path->User Libraries configuration page.
    • Add a new library named LO-Classes
    • Select the Library, click Add External Jars
    • Add the LibreOffice jars unoil.jar juh.jar jurt.jar ridl.jar unoloader.jar. You find them here:
      • macOS: /Applications/LibreOffice.app/Contents/Resources/java
      • Ubuntu: /usr/lib/libreoffice/program/classes
      • Windows: C:\Program Files[ (x86)]\LibreOffice 5\program\classes\
    • Now there should be no more project errors.
  5. Go to Run->Run Configurations, and create a new run configuration of the type Eclipse Application. Now you can run or debug the LOEclipse plugin using this run configuration.

Release Management

After releasing a new version, we need to build the update site. To do that, run the following command in the build folder:

ant -Dlibreoffice.home=... -Declipse.home=...

where libreoffice.home is the path to the LibreOffice installation and eclipse.home the path to the eclipse installation (needs to contain a plugins and a features directory).

You can also persist the options by setting the ANT_ARGS variable to

-Dlibreoffice.home=... -Declipse.home=....

Available build targets

Run ant help to see the available build targets.

Features

  • UNO-IDL syntax highlighting
  • SDK and LibreOffice Configuration
  • Java code generation
  • New UNO project wizard
  • New UNO file wizard
  • New UNO service wizard
  • New UNO interface wizard
  • Skeleton-maker integration for basic components creation
  • URE configuration
  • New URE application wizard
  • Automatic component build and packaging
  • Automatic deployment to an existing LibreOffice installation
  • Remote debugging using the Eclipse debugger
  • Generate ant build script to build the extension without Eclipse