Difference between revisions of "Template:SpecUIElement/Menu"
From Apache OpenOffice Wiki
Line 5: | Line 5: | ||
<noinclude> | <noinclude> | ||
Use this template to create, within a specification document, a table describing your menu items. | Use this template to create, within a specification document, a table describing your menu items. | ||
+ | |||
+ | === Structure === | ||
+ | {{SpecUIElement/Menu}} | ||
+ | |||
+ | === Parameters === | ||
+ | {| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse; width: 100%" | ||
+ | |- style="background-color:#dddddd;" | ||
+ | || '''Parameter Name''' || '''Parameter meaning''' | ||
+ | |- | ||
+ | || <code>en-US</code> || the label (for locale en-US) of the menu item | ||
+ | |- | ||
+ | || <code>sub-item</code> || the label (for locale en-US) of the first-level sub item | ||
+ | |- | ||
+ | || <code>sub-sub-item</code> || the label (for locale en-US) of the second-level sub item | ||
+ | |- | ||
+ | || <code>kbd</code> || the keyboard shortcut for the menu item | ||
+ | |- | ||
+ | || <code>icon</code> || the icon to be used for the menu item | ||
+ | |- | ||
+ | || <code>comments</code> || comments on the menu item, usually directed to translators | ||
+ | |} | ||
+ | |||
+ | If any of the items is not present, it is defaulted to an empty string. Exception is en-US, which must be specified - if it isn't, a warning will be displayed. | ||
=== Example === | === Example === |
Revision as of 14:27, 28 November 2007
Use this template to create, within a specification document, a table describing your menu items.
Structure
Menu Item(s)
Item | Sub Item | Sub Item | KBD Shortcut | Icon | Comment |
Parameters
Parameter Name | Parameter meaning |
en-US |
the label (for locale en-US) of the menu item |
sub-item |
the label (for locale en-US) of the first-level sub item |
sub-sub-item |
the label (for locale en-US) of the second-level sub item |
kbd |
the keyboard shortcut for the menu item |
icon |
the icon to be used for the menu item |
comments |
comments on the menu item, usually directed to translators |
If any of the items is not present, it is defaulted to an empty string. Exception is en-US, which must be specified - if it isn't, a warning will be displayed.
Example
Menu Item(s)
Item | Sub Item | Sub Item | KBD Shortcut | Icon | Comment |
This is the top level entry point, in the main menu bar, for all file related actions. |
was produced by this code:
{{SpecUIElement/Menu|en-US=File|comment=This is the top level entry point, in the main menu bar, for all file related actions.}}
See Also