Difference between revisions of "Documentation/DevGuide/Extensions/Checklist for Writing Extensions"

Revision as of 13:16, 4 June 2008

This page gives a brief overview about what is important when developing an extension.

1. Use the .oxt file extension and provide description.xml. Look here why you should use .oxt.
2. Provide an extension identifier in the description.xml
3. Provide a version in the description.xml.
4. Provide a display name in the description.xml.
5. Specify the target platforms in the description.xml.
6. 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.
7. You may add a license. Text files containing a license need to be "registered" in the description.xml.
8. 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.
9. 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.
10. Provide publisher information in the description.xml.
11. Provide links to release notes (TODO: more documentation) in the description.xml. Currently only used within the 'update dialog'. When using the OOo extension repository, then the link to the release notes is automatically generated from the information entered on the web site. That is, when using the repository one does not need to provide this information in the description.xml.
12. Provide content for help system if necessary.