Difference between revisions of "Documentation/DevGuide/Extensions/Description of the Update Information"
From Apache OpenOffice Wiki
< Documentation | DevGuide
(Initial author Sun Microsystems, Inc.) |
m |
||
| Line 15: | Line 15: | ||
It follows the description of the XML structure of the update information data: | It follows the description of the XML structure of the update information data: | ||
| − | ==== Element <code> | + | ==== Element <code>/description</code> ==== |
| − | + | ||
* Parent element: document root | * Parent element: document root | ||
| − | * | + | * Children: |
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <identifier>|<identifier>]]</code> | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <identifier>|<identifier>]]</code> | ||
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <version>|<version>]]</code> | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <version>|<version>]]</code> | ||
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <update-download>|<update-download>]]</code> | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <update-download>|<update-download>]]</code> | ||
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dependencies>|<dependencies>]]</code> | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dependencies>|<dependencies>]]</code> | ||
| + | * Since: OOo 2.2 | ||
<code><description></code> is the root element of the update information XML document. | <code><description></code> is the root element of the update information XML document. | ||
| Line 48: | Line 48: | ||
|} | |} | ||
| − | ==== Element <code> | + | |
| + | ==== Element <code>/description/identifier</code> ==== | ||
* XPath: <code>/description/identifier</code> | * XPath: <code>/description/identifier</code> | ||
* Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | * Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | ||
| − | * | + | * Children: none |
| + | * Since OOo 2.2 | ||
{|border="1" cellpadding=4 style="border-collapse:collapse;" | {|border="1" cellpadding=4 style="border-collapse:collapse;" | ||
| Line 63: | Line 65: | ||
|} | |} | ||
| − | ==== Element <code> | + | |
| − | + | ==== Element <code>/description/version</code> ==== | |
* Parent element: <description> (page 4) | * Parent element: <description> (page 4) | ||
* Child elements: none | * Child elements: none | ||
| + | * Since: OOo 2.2 | ||
{|border="1" cellpadding=4 style="border-collapse:collapse;" | {|border="1" cellpadding=4 style="border-collapse:collapse;" | ||
| Line 78: | Line 81: | ||
|} | |} | ||
| − | ==== Element <code> | + | |
| − | + | ==== Element <code>/description/update-download</code> ==== | |
* Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | * Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | ||
| − | * | + | * Children: |
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <src>|<src>]] | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <src>|<src>]] | ||
| − | + | * Since: OOo 2.2 | |
<code><update-download></code> must have one or more <code><src></code> children. The second, third, etc. <code><src></code> element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to download the extension by using the first URL and only uses the next URL if an error occurred, for example because the the connection was interrupted. | <code><update-download></code> must have one or more <code><src></code> children. The second, third, etc. <code><src></code> element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to download the extension by using the first URL and only uses the next URL if an error occurred, for example because the the connection was interrupted. | ||
| − | ==== Element <code> | + | |
| − | + | ==== Element <code>/description/dependencies</code> ==== | |
* Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | * Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <description>|<description>]]</code> | ||
| − | * | + | * Children: |
** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dep:OpenOffice.org-minimal-version>|<dep:OpenOffice.org-minimal-version>]]</code> | ** <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dep:OpenOffice.org-minimal-version>|<dep:OpenOffice.org-minimal-version>]]</code> | ||
** others | ** others | ||
| + | * Since: OOo 2.2 | ||
| − | ==== Element | + | |
| − | + | ==== Element <code>/description/update-download/src</code> ==== | |
* Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <update-download>|<update-download>]]</code> | * Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <update-download>|<update-download>]]</code> | ||
| − | * | + | * Children: none |
| + | * Since: OOo 2.2 | ||
{|border="1" cellpadding=4 style="border-collapse:collapse;" | {|border="1" cellpadding=4 style="border-collapse:collapse;" | ||
| Line 108: | Line 113: | ||
|} | |} | ||
| − | ==== Element | + | |
| − | + | ==== Element <code>/description/dependencies/dep:OpenOffice.org-minimal-version<code> ==== | |
* Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dependencies>|<dependencies>]]</code> | * Parent element: <code>[[Documentation/DevGuide/Extensions/Description of the Update Information#Element <dependencies>|<dependencies>]]</code> | ||
| − | * | + | * Children: none |
| + | * Since: OOo 2.2 | ||
{|border="1" cellpadding=4 style="border-collapse:collapse;" | {|border="1" cellpadding=4 style="border-collapse:collapse;" | ||
Revision as of 16:24, 12 November 2007
- 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
The update information can be contained in a file which can be directly accessed through a URL or it can be generated on demand (HTTP get request). If it is a file then it could be named according to this pattern:
<extension_file_name>.update.xml
For example, the update information file for the extension myextension.oxt is myextension.update.xml. The .oxt file extension is not used.
It follows the description of the XML structure of the update information data:
Element /description
- Parent element: document root
- Children:
- Since: OOo 2.2
<description> is the root element of the update information XML document.
| Attribute | Description |
|---|---|
xmlns
|
The default namespace of element description and all children must be defined as |
xmlns:dep
|
The namespace for dependency information must be defined as |
xmlns:xlink
|
The xlink namespace must be defined as |
| other namespace definitions | Other namespaces can be added as necessary. |
Element /description/identifier
- XPath:
/description/identifier - Parent element:
<description> - Children: none
- Since OOo 2.2
| Attribute | Description |
|---|---|
value
|
Required. The extension identifier. |
Element /description/version
- Parent element: <description> (page 4)
- Child elements: none
- Since: OOo 2.2
| Attribute | Description |
|---|---|
value
|
Required. A textual representation of the extension version. |
Element /description/update-download
- Parent element:
<description> - Children:
- Since: OOo 2.2
<code><update-download> must have one or more <src> children. The second, third, etc. <src> element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to download the extension by using the first URL and only uses the next URL if an error occurred, for example because the the connection was interrupted.
Element /description/dependencies
- Parent element:
<description> - Children:
- Since: OOo 2.2
Element /description/update-download/src
- Parent element:
<update-download> - Children: none
- Since: OOo 2.2
| Attribute | Description |
|---|---|
| <code>xlink:href<code> | Required. The value is a URL which refers to the extension |
Element <code>/description/dependencies/dep:OpenOffice.org-minimal-version<code>
- Parent element: <code><dependencies>
- Children: none
- Since: OOo 2.2
| Attribute | Description |
|---|---|
xmlns:dep
|
The namespace for dependency information (inherited from <description>) must be defined as
|
dep:name
|
Required. The string “OpenOffice.org value” (where value is the value of the attribute value).
|
value
|
Required. The required underlying OpenOffice.org version (“2.1”, “2.2”, etc.), starting with OpenOffice.org 2.1. |
| Content on this page is licensed under the Public Documentation License (PDL). |
