Difference between revisions of "Documentation/DevGuide/Extensions/Extension Description"
| Line 7: | Line 7: | ||
The Extension Manager can display a small text for each extension in the dialog. The full text will become visible when the extension is being selected. Originally, this text was displayed in a 'tool tip' in versions of OOo previous v3.0. | The Extension Manager can display a small text for each extension in the dialog. The full text will become visible when the extension is being selected. Originally, this text was displayed in a 'tool tip' in versions of OOo previous v3.0. | ||
| − | Versions of OOo earlier than 3.1 use the [[Documentation/DevGuide/Extensions/File Format#Extension Tooltip Description|"Tooltip Description"]] of an extension which is kept in the [[Documentation/DevGuide/Extensions/File Format#Extension Tooltip Description| manifest.xml]]. Using the "Tooltip Description" is '''deprecated''' as of OOo 3.1. Since then the description is specified in the [[Documentation/DevGuide/Extensions/Description of XML Elements|description.xml]]. | + | Versions of OOo earlier than 3.1 use the [[Documentation/DevGuide/Extensions/File Format#Extension Tooltip Description|"Tooltip Description"]] of an extension which is kept in the [[Documentation/DevGuide/Extensions/File Format#Extension Tooltip Description| manifest.xml]]. Using the "Tooltip Description" is '''deprecated''' as of OOo 3.1 and that functionality will not be maintained. Since then the description is specified in the [[Documentation/DevGuide/Extensions/Description of XML Elements|description.xml]]. Do not use both, the [[Documentation/DevGuide/Extensions/File Format#Extension Tooltip Description| manifest.xml]] and the [[Documentation/DevGuide/Extensions/Description of XML Elements|description.xml]], in the same extension to specify a description. If an extension requieres at least version 3.1 of OOo (see [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]]), then use the [[Documentation/DevGuide/Extensions/Description of XML Elements|description.xml]]. |
| + | |||
| + | Using a description is similar to the use of a [[Documentation/DevGuide/Extensions/Simple License|license]]. One can put a couple of localized description files into the extension and reference them in the description.xml. The description using a locale which matches that of the office will be displayed. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for how the localization works. | ||
The description files must contain '''UTF-8''' encoded text. | The description files must contain '''UTF-8''' encoded text. | ||
Revision as of 08:06, 22 July 2008
The Extension Manager can display a small text for each extension in the dialog. The full text will become visible when the extension is being selected. Originally, this text was displayed in a 'tool tip' in versions of OOo previous v3.0.
Versions of OOo earlier than 3.1 use the "Tooltip Description" of an extension which is kept in the manifest.xml. Using the "Tooltip Description" is deprecated as of OOo 3.1 and that functionality will not be maintained. Since then the description is specified in the description.xml. Do not use both, the manifest.xml and the description.xml, in the same extension to specify a description. If an extension requieres at least version 3.1 of OOo (see OpenOffice.org-minimal-version), then use the description.xml.
Using a description is similar to the use of a license. One can put a couple of localized description files into the extension and reference them in the description.xml. The description using a locale which matches that of the office will be displayed. See Documentation/DevGuide/Extensions/Localized XML Elements for how the localization works. The description files must contain UTF-8 encoded text.
See also
| Content on this page is licensed under the Public Documentation License (PDL). |
