Difference between revisions of "Documentation/DevGuide/WritingUNO/AddOns/Guidelines"
From Apache OpenOffice Wiki
< Documentation | DevGuide
OOoWikiBot (Talk | contribs) m (FINAL VERSION FOR L10N) |
(Indicating features introduced with 2.x.) |
||
| Line 11: | Line 11: | ||
For a smooth integration, a developer should be aware of the following guidelines: | 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. | * 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. | * 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. | * Only frequently used add-ons or add-ons that offer very important functions in a user environment should use their own top-level menu. | ||
| Line 22: | Line 22: | ||
* Use the option to group related items by means of separator items. | * Use the option to group related items by means of separator items. | ||
| − | + | == Toolbar == | |
| − | + | === Before version 2.0.3 of {{OOo}} === | |
* Only important functions should be integrated into the toolbar. | * Only important functions should be integrated into the toolbar. | ||
* Use the option to group functions by means of separator items. | * Use the option to group functions by means of separator items. | ||
| + | === Since version 2.0.3 of {{OOo}} === | ||
| + | * 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 {{OOo}} an extension may integrate commands into an existing menu or toolbar. See Wiki article [http://wiki.services.openoffice.org/wiki/Framework/Article/Addon_Menu_Toolbar_Merging Addon Menu Toolbar Merging]. | ||
| + | |||
| + | == Add-On Help menu == | ||
| + | === Before version 2.4 of {{OOo}} === | ||
Every add-on should provide help to user. This help has to be made available through an entry in the {{PRODUCTNAME}} '''Help''' menu. Every add-on should only use a single '''Help''' menu item. | Every add-on should provide help to user. This help has to be made available through an entry in the {{PRODUCTNAME}} '''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. | If the add-on comes with its own dialogs, it should also offer '''Help''' buttons in the dialogs. | ||
| − | + | === Since version 2.4 of {{OOo}} === | |
| + | Extensions can contain help content and extend the OpenOffice.org's installed help content. Add-on Help is now legacy. See instead chapter [[Documentation/DevGuide/Extensions/Help_Content|Help Content]]. | ||
{{PDL1}} | {{PDL1}} | ||
[[Category:Documentation/Developer's Guide/Writing UNO Components]] | [[Category:Documentation/Developer's Guide/Writing UNO Components]] | ||
Revision as of 10:17, 2 October 2009
- Guidelines
- Configuration
For a smooth integration, a developer should be aware of the following guidelines:
- 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 Apache OpenOffice
- 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 Apache OpenOffice
- 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 Apache OpenOffice an extension may integrate commands into an existing menu or toolbar. See Wiki article Addon Menu Toolbar Merging.
Before version 2.4 of Apache OpenOffice
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 Apache OpenOffice
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). |
