Example

OpenOffice.org Developer's Guide

Extensions

< Previous Section

Next Section >

• Extension Manager

• Extension Repositories
• The Active Extension
• Updating Extensions
• Processing Extensions
• Packaging Notes For Bundled Extensions
• Deployment Items
• Installing Extensions for All or a Single User
• Extension Manager in OpenOffice.org
• unopkg
• Location of Installed Extensions
• Extension Layers

• Checklist for Writing Extensions
• File Format
• description.xml

• Description of XML Elements
• Localized XML Elements
• Example

• Display Name
• Icon
• Extension Description
• Extension Identifiers
• Extension Versions
• Target Platform
• Simple License
• Dependencies
• Publisher Information
• System Integration
• Online Update of Extensions

• Running Online - Update
• Concept
• Example Scenario for Providing Updates
• Migration of Update Information
• Description of the Update Information
• Description of Atom Feed
• Examples

• Options Dialog

• Creating the GUI of the Options Page
• Saving and Reading Data for the Options Page
• Defining the Usage of Options Pages

• Adding a Leaf to an Existing Node
• Adding Several Leaves
• Grouping of Leaves
• Adding Nodes
• Adding Several Nodes
• Absolute Position of Leaves
• Grouping of Nodes
• Assigning Nodes to Modules
• Defining a Module
• Absolute Position of Nodes

• The Options Dialog of the Extension Manager

• Help Content

< Previous Page

Next Page >

<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006" 
xmlns:d="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">
  
  <version value="1.0" />   

  <identifier value="com.mycompany.extensions.my_extension" />

  <platform value="windows_x86,solaris_sparc" />

  <dependencies>
    <OpenOffice.org-minimal-version value="3.3" d:name="OpenOffice.org 3.3"/>
  </dependencies>
  
  <update-information>
    <src xlink:href="http://extensions.openoffice.org/testarea/desktop/license/update/lic3.update.xml" />
  </update-information>
  
  <registration>
    <simple-license accept-by="admin" suppress-on-update="true" >
      <license-text xlink:href="registration/license_de-DE.txt" lang="de-DE" />
      <license-text xlink:href="registration/license_en-GB.txt" lang="en-GB" />
      <license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" />
      <license-text xlink:href="registration/license_en-US.txt" lang="en-US" />
    </simple-license>
  </registration>
  
  <publisher>
    <name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_de.html"
    lang="de">My OpenOffice de</name>
    <name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_en.html" 
    lang="en">My OpenOffice en</name>
  </publisher>

  <release-notes>
    <src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_de.txt" lang="de" />
    <src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_en.txt" lang="en" />
  </release-notes>

  <display-name>
    <name lang="de">Meine tolle extensions</name>
    <name lang="en">My great extension</name>
  </display-name>
  
  <icon>
    <default xlink:href="images/icon.png" />
    <high-contrast xlink:href="images/icon_hc.png" />
  </icon>

  <extension-description>
    <src xlink:href="description/desc_de.txt" lang="de" />
    <src xlink:href="description/desc_en.txt" lang="en" />
  </extension-description>

</description>

This description.xml contains:

• The version is 1.0. [go to XML description].
• The identifier is: com.mycompany.extensions.my_extension. [go to XML description]
• The platforms on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [go to XML description]
• There is a dependency for OpenOffice.org 3.3 and higher. That is, the minimum version with which the extension works is 3.3.[go to XML description]
• It supports the update feature and update information can be obtained at the specified address. [go to XML description]
• A license text is displayed during installation. Different localizations of the license text are available. [go to XML description]
• There are two localized versions of a publisher name and URL. [go to XML description]
• There are two links to release notes in different languages. [go to XML description]
• There is a localized display name. That is, in an English version of Apache OpenOffice the Extension Manager will show the string: My great extension. [go to XML description]
• The extension contains icons which are used by the Extensions Manager when displaying the extension. [go to XML description]
• A localized description is displayed in the Extension Manager's dialog. [go to XML description]

Please note that the <publisher> and <release-notes> elements in a description.xml are currently not used by the Extension Manager. However, when uploading the extension to the extensions repository (https://extensions.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays this information (since OpenOffice.org 2.4).

Content on this page is licensed under the Public Documentation License (PDL).