Difference between revisions of "Documentation/DevGuide/Extensions/Example"

From Apache OpenOffice Wiki
Jump to: navigation, search
m
m (links to tag descriptions)
Line 60: Line 60:
 
This ''description.xml'' contains these information:
 
This ''description.xml'' contains these information:
  
* The version is 1.0.
+
* The version is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to description]]].
* The identifier is: ''com.mycompany.extensions.my_extension''
+
* The identifier is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to description]]]
* The extension can only be installed on Windows systems (x86 CPU) and Solaris Systems (SPARC CPU).
+
* The extension can only be installed on Windows systems (x86 CPU) and Solaris Systems (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to description]]]
* It only works with OpenOffice.org 2.2 and higher.
+
* It only works with OpenOffice.org 2.2 and higher. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to description]]]
* It supports the update feature and update information can be obtained at the specified address.
+
* It supports the update feature and update information can be obtained at the specified address. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to description]]]
* When this extension is installed as shared extension then a license text is being displayed. Different localizations of the license text are available.
+
* When this extension is installed as shared extension then a license text is being displayed. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to description]]]
* There are two localized versions of a publisher name and URL (since OOo 2.4).  
+
* There are two localized versions of a publisher name and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to description]]]
* There are two links to release notes in different languages (since OOo 2.4).
+
* There are two links to release notes in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to description]]]
* There is a localized display name (since OOo 2.4). That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''.
+
* There is a localized display name. That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to 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 (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).
 
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 (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).

Revision as of 09:50, 21 May 2008




<?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="2.2" d:name="OpenOffice.org 2.2"/>
  </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" default-license-id="en-NZ" 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-id="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>
 
</description>


This description.xml contains these information:

  • The version is 1.0. [go to description].
  • The identifier is: com.mycompany.extensions.my_extension. [go to description]
  • The extension can only be installed on Windows systems (x86 CPU) and Solaris Systems (SPARC CPU). [go to description]
  • It only works with OpenOffice.org 2.2 and higher. [go to description]
  • It supports the update feature and update information can be obtained at the specified address. [go to description]
  • When this extension is installed as shared extension then a license text is being displayed. Different localizations of the license text are available. [go to description]
  • There are two localized versions of a publisher name and URL. [go to description]
  • There are two links to release notes in different languages. [go to description]
  • There is a localized display name. That is, in an english version of OOo the Extension Manager will show the string: My great extension. [go to 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 (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).

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