Difference between revisions of "Documentation/DevGuide/Extensions/Checklist for Writing Extensions"
From Apache OpenOffice Wiki
< Documentation | DevGuide
m (added help) |
m |
||
| Line 15: | Line 15: | ||
# You may add a [[Documentation/DevGuide/Extensions/Simple_License|'''license''']]. Text files containing a license need to be "registered" in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|description.xml]]. | # You may add a [[Documentation/DevGuide/Extensions/Simple_License|'''license''']]. Text files containing a license need to be "registered" in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|description.xml]]. | ||
# To allow an ''''online update'''' of the extension one does not need to prepare the extension when using the [http://extensions.services.openoffice.org OOo extension repository]. More information can be found [[Documentation/DevGuide/Extensions/Online Update of Extensions|here]]. | # To allow an ''''online update'''' of the extension one does not need to prepare the extension when using the [http://extensions.services.openoffice.org OOo extension repository]. More information can be found [[Documentation/DevGuide/Extensions/Online Update of Extensions|here]]. | ||
| − | # Provide an [[Documentation/DevGuide/Extensions/Options Dialog|'''options page''']] in case the extension needs to be configured. | + | # Provide an [[Documentation/DevGuide/Extensions/Options Dialog|'''options page''']] in case the extension needs to be configured. Do not create your own menu or menu entries if there sole purpose is to adjust settings for the extension. |
# Provide links to '''release notes''' and the '''publisher''' web site (TODO: more documentation) in the description.xml. These are currently only used within the 'update dialog'. When using the [http://extensions.services.openoffice.org OOo extension repository], then these information should be automatically generated from the information entered on the web site (may not work completely yet). | # Provide links to '''release notes''' and the '''publisher''' web site (TODO: more documentation) in the description.xml. These are currently only used within the 'update dialog'. When using the [http://extensions.services.openoffice.org OOo extension repository], then these information should be automatically generated from the information entered on the web site (may not work completely yet). | ||
# Provide content for [[Documentation/DevGuide/Extensions/Help Content|'''help system''']] if necessary. | # Provide content for [[Documentation/DevGuide/Extensions/Help Content|'''help system''']] if necessary. | ||
Revision as of 07:46, 29 April 2008
This page gives a brief overview about what is important when developing an extension.
- Use the .oxt file extension and provide description.xml. Look here why you should use
.oxt. - Provide an extension identifier in the description.xml
- Provide a version in the description.xml.
- Provide a display name in the description.xml.
- Specify the target platforms in the description.xml.
- Specify the dependencies in the description.xml. For example, if your extension requires a 'minimal version' of OOo then use the OpenOffice.org-minimal-version dependency.
- You may add a license. Text files containing a license need to be "registered" in the description.xml.
- To allow an 'online update' of the extension one does not need to prepare the extension when using the OOo extension repository. More information can be found here.
- Provide an options page in case the extension needs to be configured. Do not create your own menu or menu entries if there sole purpose is to adjust settings for the extension.
- Provide links to release notes and the publisher web site (TODO: more documentation) in the description.xml. These are currently only used within the 'update dialog'. When using the OOo extension repository, then these information should be automatically generated from the information entered on the web site (may not work completely yet).
- Provide content for help system if necessary.
| Content on this page is licensed under the Public Documentation License (PDL). |
