Difference between revisions of "Documentation/DevGuide/Extensions/Checklist for Writing Extensions"
From Apache OpenOffice Wiki
< Documentation | DevGuide
(First content) |
(more content) |
||
| Line 7: | Line 7: | ||
This page gives a brief overview about what is important when developing an extension. | This page gives a brief overview about what is important when developing an extension. | ||
| − | # Use the | + | # Use the '''.oxt''' file extension and provide [[Documentation/DevGuide/Extensions/description.xml | description.xml]]. Look [http://extensions.openoffice.org/servlets/ReadMsg?list=dev&msgNo=142 here] why you should use <code>.oxt</code>. |
| − | # Provide an [[Documentation/DevGuide/Extensions/Extension_Identifiers|extension identifier]] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|description.xml]] | + | # Provide an [[Documentation/DevGuide/Extensions/Extension_Identifiers|'''extension identifier''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|description.xml]] |
| − | # Provide a [[Documentation/DevGuide/Extensions/Extension_Versions|version]] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]]. | + | # Provide a [[Documentation/DevGuide/Extensions/Extension_Versions|'''version''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]]. |
| − | # Specify the [[Documentation/DevGuide/Extensions/Dependencies|dependencies]] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]]. For example, if your extension requires a 'minimal version' of OOo then use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency. | + | # Provide a [[Documentation/DevGuide/Extensions/Display_Name|'''display name''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|description.xml]]. |
| − | + | # Specify the [[Documentation/DevGuide/Extensions/Target Platform|'''target platforms''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|description.xml]]. | |
| − | + | # Specify the [[Documentation/DevGuide/Extensions/Dependencies|'''dependencies''']] in the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|description.xml]]. For example, if your extension requires a 'minimal version' of OOo then use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency. | |
| − | # | + | # 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]]. |
| − | + | # Provide an [[Documentation/DevGuide/Extensions/Options Dialog|'''options page''']] in case the extension needs to be configured. | |
| + | # 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). | ||
{{PDL1}} | {{PDL1}} | ||
[[Category: Extensions]] | [[Category: Extensions]] | ||
Revision as of 14:49, 23 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.
- 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).
| Content on this page is licensed under the Public Documentation License (PDL). |
