Description of XML Elements

From Apache OpenOffice Wiki
Jump to: navigation, search



Element /description

<description> is the root element of the description.xml.


Attributes of <description>
Attribute Description
xmlns The default namespace of element description and all children must be defined as

http://openoffice.org/extensions/description/2006

xmlns:dep The namespace for dependency information must also be defined as

http://openoffice.org/extensions/description/2006

xmlns:xlink The xlink namespace must be defined as

http://www.w3.org/1999/xlink

other namespace definitions Other namespaces can be added as necessary


Element /description/identifier


Attributes of <identifier>
Attribute Description
value Required. The extension identifier.


See also


Element /description/version


Attributes of <version>
Attribute Description
value Required. A textual representation of the extension version.


See also


Element /description/platform


Attributes of <platform>
Attribute Description
value Required. A token representing a particular platform. See Target Platform for details.


See also


Element /description/registration

The registration element currently only contains the <simple-license> element. If the <registration> element exists, then it must have a child element.

See also


Element /description/registration/simple-license

Parent: <registration>

The element contains the <license-text> elements, determines if all user must agree to the license, or just the person who installs it, and determines a default <license-text> element. The mechanism for determining a "default" has changed in OOo 2.4. See Documentation/DevGuide/Extensions/Localized XML Elements for details. This element is disregarded for bundled extensions.

If the <simple-license> element exists, then it must have at least one child element.


Attributes of <simple-license>
Attribute Description
accept-by Required.Value is either “user” or “admin”. “user” means that every user has to agree to the license. That is, the extension can only be installed as user extension but not as shared extension. If it has the value “admin” then it can be deployed as shared extension as well. In that case only the person who installs it has to agree to the license. Individual users will not be asked to accept the license. They can use the extension right away. In case the value is “user” and the extension is being installed as user extension then the user must always agree to the license. By using suppress-if-required=“true“ it is, however, possible to install an extension for all users, that is, as shared extension, even if accept-by=“user“.
default-license-id Required. Since OOo 2.4 this attribute is obsolete. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the OpenOffice.org-minimal-version dependency with a value of '2.4'.

The attribute determines what <license-text> is used if no <license-text> element has a lang attribute whose value matches the locals of OpenOffice.org. There must always be exactly one <license-text> element with a license-id attribute whose value matches that of the default-license-id. The type is xsd:IDREF.

suppress-on-update Optional. When the attribute is not provided then the value “false” is assumed. The value true indicates that the license for this extension will not be displayed during installation when the same extension (same id but probably different version) is already installed. This applies for the automatic update as well as for manually installing an extension. The version of the already installed extension does not matter. Suppressing the license can be useful during the online update, because otherwise the update operation could be interrupted by many license dialogs.
suppress-if-required Optional. Since 3.3. When the attribute is not provided then the value “false” is assumed. The value “true“ indicates that the license will not be displayed during installation if this is desired, which can be expressed by the unopkg switch --suppress-license and is implicitely assumed for bundled extensions.


See also


Element /description/registration/simple-license/license-text

The element contains information about where to find the file containing the license text, which language it uses, and if this element is the “default” <license-text>. The mechanism for determining a "default" has changed in OOo 2.4. See Documentation/DevGuide/Extensions/Localized XML Elements for details.


Attributes of <license-text>
Attribute Description
xlink:href Required. The value is a relative URL to the license file within the extension.
lang Required. A language identifier according to RFC 3066. See also Documentation/DevGuide/Extensions/Localized XML Elements.
license-id Optional. Since OOo 2.4 this attribute is obsolete. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the OpenOffice.org-minimal-version dependency with a value of '2.4'.

One license-text element must have this attribute and the value must match the value of the default-license-id attribute of the <simple-license> element. The type is xsd:ID.


See also


Element /description/dependencies


See also


Element /description/dependencies/OpenOffice.org-minimal-version


Attributes of <OpenOffice.org-minimal-version>
Attribute Description
xmlns:dep The namespace for dependency information (inherited from <description>) must be defined as

http://openoffice.org/extensions/description/2006

dep:name Required. Descriptive string that will be displayed. Example : “OpenOffice.org value” (where value is the value of the attribute value).
dep:OpenOffice.org-minimal-version Optional. This attribute should never be used with this element.
value Required. String. The required underlying OpenOffice.org version (“2.1”, “2.2”, etc.), starting with OpenOffice.org 2.1. You should not specify a particular micro version, e.g. “2.2.1”, use “2.2” instead.


See also

Element /description/dependencies/OpenOffice.org-maximal-version


Attributes of <OpenOffice.org-maximal-version>
Attribute Description
xmlns:dep The namespace for dependency information (inherited from <description>) must be defined as

http://openoffice.org/extensions/description/2006

dep:name Required. Descriptive string that will be displayed. Example : “OpenOffice.org value or older” (where value is the value of the attribute value).
dep:OpenOffice.org-maximal-version Optional. This attribute should always be defined as “2.3” for this element.
value Required. The required maximal underlying OpenOffice.org version (“3.0”, “3.1”, etc.). You must not specify a particular micro version, e.g. “3.1.1”, use “3.1” instead.


See also

Element /description/update-information

<update-information> must have at least one <src> child element. The second, third, etc. element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to get update information by using a URL and only use a different URL if an error occurred. That is, if for example the first URL references an atom feed that does not contain any references at all, but is a valid feed, then the Extension Manager assumes that there are no update information available. Then URLs from other <src> elements are not examined. Therefore the update information referenced by every URL must be identical.

See also


Element /description/update-information/src


Attributes of <src>
Attribute Description
xlink:href Required. The value is a URL which provides the update information directly or an atom feed which in turn references the update information. The URL can point directly to a file or it may invoke code, such as a servlet, cgi, etc, that returns the atom feed or the update information.


See also


Element /description/publisher

<publisher> must have at least one <name> child element. The children of this element provide a localized publisher name together with a URL.


See also


Element /description/publisher/name

The text value of this element is the publisher name.


Attributes of <name>
Attribute Description
xlink:href Required. The value is a URL to the web site of the publisher of the extension.
lang Required. A language identifier according to RFC 3066. See also Documentation/DevGuide/Extensions/Localized XML Elements.


See also


Element /description/release-notes

<release-notes> must have at least one <src> child element. The children provide URLs to localized release-notes.

Currently this element and its children are not used by the Extension Manager.

See also


Element /description/release-notes/src

The element contains a URL to the release notes.


Attributes of <src>
Attribute Description
xlink:href Required. The value is a URL to the release notes of the extension.
lang Required. A language identifier according to RFC 3066. See also Documentation/DevGuide/Extensions/Localized XML Elements.


See also


Element /description/display-name

<display-name> must have at least one <name> child element. The children of this element provide a localized display name. The name will be used in the GUI instead of the file name.

See also


Element /description/display-name/name

The text value of this element is the display name of the extension. The string length must be greater then null and must not only contain white space characters.


Attributes of <name>
Attribute Description
lang Required. A language identifier according to RFC 3066. See also Documentation/DevGuide/Extensions/Localized XML Elements.


See also


Element /description/icon


See also

Element /description/icon/default

  • Parent: <icon>
  • Children: none
  • Since: OOo 3.0


Attributes of <default>
Attribute Description
xlink:href The value is a relative URL to the icon file within the extension.


See also


Element /description/icon/high-contrast

  • Parent: <icon>
  • Children: none
  • Since: OOo 3.0


Attributes of <high-contrast>
Attribute Description
xlink:href The value is a relative URL to the icon file within the extension.


See also


Element /description/extension-description

Parent: <description>

  • Children:
  • Since: OOo 3.1

<extension-description> must have at least on <src> child element. Every child references a localized description. See Documentation/DevGuide/Extensions/Localized XML Elements for details.


See also


Element /description/extension-description/src

The element contains information about where to find the file containing the description text and which language it uses.


Attributes of <src>
Attribute Description
xlink:href Required. The value is a relative URL to the description file within the extension.
lang Required. A language identifier according to RFC 3066. See also Documentation/DevGuide/Extensions/Localized XML Elements.


See also

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