Difference between revisions of "Template:SpecUIElement/Menu"
From Apache OpenOffice Wiki
(13 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | <includeonly>{{SpecUIElement/MenuHeading}} | |
+ | {{SpecUIElement/MenuRow|text={{{text|<span style="color:#ff0000;">invalid - en-US label must be specified</span>}}}|sub-item={{{sub-item|}}}|sub-sub-item={{{sub-sub-item|}}}|kbd={{{kbd|}}}|icon={{{icon|}}}|comment={{{comment|}}}}} | ||
+ | |}</includeonly> | ||
+ | |||
+ | <noinclude>Use this template to create, within a specification document, a table describing your menu items. | ||
+ | |||
+ | === Looks Like === | ||
+ | {{SpecUIElement/Menu}} | ||
+ | |||
+ | === Parameters === | ||
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse; width: 100%" | {| 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;" | |- style="background-color:#dddddd;" | ||
− | || ''' | + | || '''Parameter Name''' || '''Parameter meaning''' |
|- | |- | ||
− | | | + | || <code>text</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>comment</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 <code>text</code>, which must be specified - if it isn't, a warning will be displayed. | ||
+ | |||
+ | === Example === | ||
+ | {{SpecUIElement/Menu|text=File|comment=This is the top level entry point, in the main menu bar, for all file related actions.}} | ||
+ | was produced by this code: | ||
+ | <pre>{{SpecUIElement/Menu|text=File|comment=This is the top level entry point, in the main menu bar, for all file related actions.}}</pre> | ||
+ | |||
+ | === See Also === | ||
+ | * [[Template:SpecUIElement/MenuHeading]] | ||
+ | * [[Template:SpecUIElement/MenuRow]] | ||
+ | |||
+ | [[Category:Specification Particle Templates]] | ||
+ | |||
+ | </noinclude> |
Latest revision as of 20:58, 28 November 2007
Use this template to create, within a specification document, a table describing your menu items.
Looks Like
Menu Item(s)
Item | Sub Item | Sub Item | KBD Shortcut | Icon | Comment |
invalid - en-US label must be specified |
Parameters
Parameter Name | Parameter meaning |
text |
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 |
comment |
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 text
, 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 |
File | This is the top level entry point, in the main menu bar, for all file related actions. |
was produced by this code:
{{SpecUIElement/Menu|text=File|comment=This is the top level entry point, in the main menu bar, for all file related actions.}}
See Also