Difference between revisions of "Documentation/DevGuide/Extensions/Example"
From Apache OpenOffice Wiki
< Documentation | DevGuide
m (Added icon element) |
(more links and icon element corrected) |
||
| Line 28: | Line 28: | ||
<registration> | <registration> | ||
| − | <simple-license accept-by="admin | + | <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_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-GB.txt" lang="en-GB" /> | ||
| − | <license-text xlink:href="registration/license_en-NZ.txt" lang | + | <license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" /> |
<license-text xlink:href="registration/license_en-US.txt" lang="en-US" /> | <license-text xlink:href="registration/license_en-US.txt" lang="en-US" /> | ||
</simple-license> | </simple-license> | ||
| Line 54: | Line 54: | ||
<icon> | <icon> | ||
| − | < | + | <default xlink:href="images/icon.png" /> |
<high-contrast xlink:href="images/icon_hc.png" /> | <high-contrast xlink:href="images/icon_hc.png" /> | ||
</icon> | </icon> | ||
| Line 66: | Line 66: | ||
This ''description.xml'' contains these information: | This ''description.xml'' contains these information: | ||
| − | * The version is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to description]]]. | + | * The '''[[Documentation/DevGuide/Extensions/Extension Versions |version]]''' is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]]. |
| − | * The identifier is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to description]]] | + | * The '''[[Documentation/DevGuide/Extensions/Extension Identifiers|identifier]]''' is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]] |
| − | * The extension can | + | * The '''[[Documentation/DevGuide/Extensions/Target Platform|platforms]]''' on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]] |
| − | * | + | * There is a '''[[Documentation/DevGuide/Extensions/Dependencies|dependency]]''' for OpenOffice.org 2.2 and higher. That is, the minimum version with which the extension works is 2.2.[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]] |
| − | * 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]]] | + | * It supports the '''[[Documentation/DevGuide/Extensions/Online Update of Extensions|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 XML description]]] |
| − | * | + | * A '''[[Documentation/DevGuide/Extensions/Simple License|license]]''' text is displayed displayed during installation. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to XML description]]] |
| − | * 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 localized versions of a '''publisher name''' and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]] |
| − | * 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 are two links to '''release notes''' in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to XML 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''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to description]]] | + | * There is a localized '''[[Documentation/DevGuide/Extensions/Display Name|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 XML description]]] |
| − | * The extension contains icons which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to description]]] | + | * The extension contains '''icons''' which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[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 (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 14:47, 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" 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> </description>
This description.xml contains these information:
- 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 2.2 and higher. That is, the minimum version with which the extension works is 2.2.[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 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 OOo 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]
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). |
