Difference between revisions of "Extensions/Extensions and Apache OpenOffice 4.0"

From Apache OpenOffice Wiki
Jump to: navigation, search
(best practices)
(Information for Developers)
Line 53: Line 53:
  
 
=== Technical details ===
 
=== Technical details ===
 +
 +
* All dictionaries will work with no modifications in version 4.0.
 +
* If your Extension does not contain an <tt>addons.xcu</tt> file, it will work with no modifications too.
 +
* If your Extension contains an <tt>addons.xcu</tt> file, you will usually have to make some small changes for it to run in OpenOffice 4.0, see below.
 +
 +
[TODO: Example: how to adapt <tt>addons.xcu</tt> from version 3.x to version 4.0]

Revision as of 21:40, 13 June 2013

Introduction

Apache OpenOffice 4.0 introduces new handling mechanisms and new APIs for Extensions.

Extensions compatible with OpenOffice 3.x may or may not work in version 4.0.

This pages collects useful information for end users and developers.

Information For End Users

Extensions that you installed in OpenOffice 3.x won't be automatically available in OpenOffice 4.0 when you upgrade from OpenOffice 3.x to OpenOffice 4.0.

It is recommended that, before installing OpenOffice 4.0, you take note of the installed Extensions with: ToolsManage Extensions.

You can then check the site you downloaded the Extensions from (usually http://extensions.openoffice.org) and search for your Extensions, to see if there is a version compatible with OpenOffice 4.0.

In doubt, you can download the latest version and install it in OpenOffice 4.0 (save the file from the Extensions site, then open it with FileOpen in OpenOffice) and check if it works correctly.

Popular extensions that are reported to work correctly with OpenOffice 4.0 are:

  • All dictionaries
  • ...

Information for Developers

OpenOffice 4.0 brings some significant changes to the API used in Extensions.

Good practices

Specify both a minimal and maximal version of OpenOffice for compatibility

This is to be done when you create a new Extension release, within the description.xml file.

Typical (minimal version only) configuration:

   <dependencies>
       <OpenOffice.org-minimal-version value="3.0" d:name="OpenOffice.org 3.0" />
   </dependencies>

Recommended (both minimal and maximal version) configuration:

   <dependencies>
       <OpenOffice.org-minimal-version value="3.0" d:name="OpenOffice.org 3.0" />
       <OpenOffice.org-maximal-version value="4.0" d:name="OpenOffice.org 4.0" />
   </dependencies>

Test your Extension with a recent OpenOffice 4.0 snapshot

Download a recent OpenOffice 4.0 snapshot from here (remember: snapshots are not official releases and they are meant for testing only) and try installing your Extension.

Check that everything works, especially toolbar integration.

If the Extension works, you may want to create a new micro release with updated minimal and maximal version compatibility and upload it to http://extensions.openoffice.org

Technical details

  • All dictionaries will work with no modifications in version 4.0.
  • If your Extension does not contain an addons.xcu file, it will work with no modifications too.
  • If your Extension contains an addons.xcu file, you will usually have to make some small changes for it to run in OpenOffice 4.0, see below.

[TODO: Example: how to adapt addons.xcu from version 3.x to version 4.0]

Personal tools