Guidelines

From Apache OpenOffice Wiki
Jump to: navigation, search



For a smooth integration, a developer should be aware of the following guidelines:

Add-Ons Submenu

  • Since the Tools - Add-Ons menu is shared by all installed add-ons, an add-on should save space and use a submenu when it has more than two functions. The name of the add-on should be part of the menu item names or the submenu title.
  • If your add-on has many menu items, use additional submenus to enhance the overview. Use four to seven entries for a single menu. If you exceed this limit, start creating submenus.

Custom Top-Level Menu

  • Only frequently used add-ons or add-ons that offer very important functions in a user environment should use their own top-level menu.
  • Use submenus to enhance the overview. Use four to seven entries for a single menu. If you exceed this limit, start creating submenus.
  • Use the option to group related items by means of separator items.

Toolbar

Before version 2.0.3 of OpenOffice.org

  • Only important functions should be integrated into the toolbar.
  • Use the option to group functions by means of separator items.

Since version 2.0.3 of OpenOffice.org

  • Each extension may have its own toolbar. The toolbar may have a specific title.

Menu Bar and Tool Bar merging

Since version 2.3 of OpenOffice.org an extension may integrate commands into an existing menu or toolbar. See Wiki article Addon Menu Toolbar Merging.

Add-On Help menu

Before version 2.4 of OpenOffice.org

Every add-on should provide help to user. This help has to be made available through an entry in the OpenOffice.org Help menu. Every add-on should only use a single Help menu item.

If the add-on comes with its own dialogs, it should also offer Help buttons in the dialogs.

Since version 2.4 of OpenOffice.org

Extensions can contain help content and extend the OpenOffice.org's installed help content. Add-on Help is now legacy. See instead chapter Help Content.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages