Difference between revisions of "Documentation/DevGuide/Extensions/Checklist for Writing Extensions"
From Apache OpenOffice Wiki
< Documentation | DevGuide
(added icon and improved readability) |
|||
| Line 9: | Line 9: | ||
# 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>. | # 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''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]] | # Provide an [[Documentation/DevGuide/Extensions/Extension_Identifiers|'''extension identifier''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]] | ||
| − | |||
# Provide a [[Documentation/DevGuide/Extensions/Extension_Versions|'''version''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]] | # Provide a [[Documentation/DevGuide/Extensions/Extension_Versions|'''version''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]] | ||
| − | |||
# Provide a [[Documentation/DevGuide/Extensions/Display_Name|'''display name''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name| [go to XML description]]] | # Provide a [[Documentation/DevGuide/Extensions/Display_Name|'''display name''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name| [go to XML description]]] | ||
| − | |||
# Provide an [[Documentation/DevGuide/Extensions/Icon|'''icon''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]] | # Provide an [[Documentation/DevGuide/Extensions/Icon|'''icon''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]] | ||
| − | |||
# Specify the [[Documentation/DevGuide/Extensions/Target Platform|'''target platforms''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]] | # Specify the [[Documentation/DevGuide/Extensions/Target Platform|'''target platforms''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]] | ||
| − | |||
# You may provide [[Documentation/DevGuide/Extensions/Dependencies|'''dependencies''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]. 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 provide [[Documentation/DevGuide/Extensions/Dependencies|'''dependencies''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]. 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 | + | # You may provide a [[Documentation/DevGuide/Extensions/Simple_License|'''license''']]. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration| [go to XML description]]] |
| − | # You may customize the [[Documentation/DevGuide/Extensions/Online Update of Extensions | ''''online update'''']] of your extension unless the update facility of the [http://extensions.services.openoffice.org OOo extension repository] does not fit your needs. | + | # You may customize the [[Documentation/DevGuide/Extensions/Online Update of Extensions | ''''online update'''']] of your extension unless the update facility of the [http://extensions.services.openoffice.org OOo extension repository] does not fit your needs. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]. |
| − | + | # You may provide [[Documentation/DevGuide/Extensions/Options Dialog|'''options pages''']] in case the extension needs to be configured. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]. | |
| − | # | + | #Provide '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher information]]'''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]]. |
| − | #Provide '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher information]]''' | + | |
# Provide links to '''release notes''' (TODO: more documentation) in the description.xml. Currently only used within the 'update dialog'. When using the [http://extensions.services.openoffice.org 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. | # Provide links to '''release notes''' (TODO: more documentation) in the description.xml. Currently only used within the 'update dialog'. When using the [http://extensions.services.openoffice.org 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. | ||
# 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 11:33, 30 June 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. [go to XML description]
- Provide a version. [go to XML description]
- Provide a display name. [go to XML description]
- Provide an icon. [go to XML description]
- Specify the target platforms. [go to XML description]
- You may provide dependencies. [go to XML description]. For example, if your extension requires a 'minimal version' of OOo then use the OpenOffice.org-minimal-version dependency.
- You may provide a license. [go to XML description]
- You may customize the 'online update' of your extension unless the update facility of the OOo extension repository does not fit your needs. [go to XML description].
- You may provide options pages in case the extension needs to be configured. [go to XML description].
- Provide publisher information. [go to XML description].
- 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.
- Provide content for help system if necessary.
| Content on this page is licensed under the Public Documentation License (PDL). |
