Extension guidelines: Difference between revisions

From MozillaZine Knowledge Base
Jump to navigationJump to search
m (spelling fix)
Line 1: Line 1:
Generally accepted guidlines to be used by extension authors.
Generally accepted guidelines to be used by extension authors.
<br>
<br>
:If you have a proposal for a new guideline, please add the prefix "Proposal:" at the front of the guideline itself. If the new guideline is acceptable to the community, this prefix can be removed after two weeks. If the guideline is not acceptable, it will be removed from the page, with a summary comment indicating why it was removed.
:If you have a proposal for a new guideline, please add the prefix "Proposal:" at the front of the guideline itself. If the new guideline is acceptable to the community, this prefix can be removed after two weeks. If the guideline is not acceptable, it will be removed from the page, with a summary comment indicating why it was removed.

Revision as of 15:49, 1 August 2005

Generally accepted guidelines to be used by extension authors.

If you have a proposal for a new guideline, please add the prefix "Proposal:" at the front of the guideline itself. If the new guideline is acceptable to the community, this prefix can be removed after two weeks. If the guideline is not acceptable, it will be removed from the page, with a summary comment indicating why it was removed.

Menu Items

  • No extension should add more than one menu item per major feature that it offers. If you need to add multiple items, add a submenu instead.
  • A menu item for "Options" is unnecessary as that is included in the Tools->Extensions window for your extension.
  • Proposal: Add a setting to remove the menu item with a GUI-accessible option.

Tools Menu

  • Add web development menu items after the "devToolsSeparator" separator and before the "prefSep" separator. Use insertafter="devToolsSeparator"
  • Add non-development menu items after the "prefSep" separator, and before the "menu_preferences" (Options) menuitem. Use insertafter="prefSep"
  • Proposal: Never add a menu item after the "Options" menu item. This means never simply add the menu item at the bottom of the Tools menu.

Context (Popup) Menu

Miscellaneous

  • Never make the user go through multiple steps to uninstall the Extension. If removal is complex, write your own uninstall script and tie it to a GUI-accessible button.