Template:GM/sub/doc: Difference between revisions

From Ring of Brodgar
Jump to navigation Jump to search
(Undo revision 74487 by MvGulik (talk) - oops, wrong template.)
Tag: Undo
(Adjust doc to always use "GM" call.)
Line 2: Line 2:
><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
===Info===
===Info===
:Main Game-Menu(GM) bar template.
:Main Game-Menu('''GM''') bar template.
:Currently supporting up to 6 parameters. (anonymous type)
:Currently supporting up to 6 parameters. (anonymous type)
:Use a leading $ character to target the used menu short-cut key.
:Use a leading $ character to target the used menu short-cut key.
Line 8: Line 8:


===Usage===
===Usage===
:<code>{{t|Menu_usage_box|String1|String2|..|String6}}</code>
:or with the preferred shorter name:
:<code>{{t|GM|String1|String2|..|String6}}</code>
:<code>{{t|GM|String1|String2|..|String6}}</code>
:(''Don't call this "Menu usage box" templates directly on main pages. Ie: Always use GM for that.'')


===Example===
===Example===
<!--
<!--
Note: Using Key_box instead of GM in actual calls here, to not get the template added as a Menu_Usage property.
Note: Not using GM/"Menu usage box" in example calls here, to not get the template added as a Menu_Usage property. (should not be a problem btw, due to "annotations namespace restrictions" here.)
-->
-->
:''Leading and trailing string spaces in examples are optional.''
:''Leading and trailing string spaces in examples are optional.''

Revision as of 06:09, 21 December 2020

Info

Main Game-Menu(GM) bar template.
Currently supporting up to 6 parameters. (anonymous type)
Use a leading $ character to target the used menu short-cut key.
(Only intended, and tested, with one '$' instance per string.)

Usage

{{GM|String1|String2|..|String6}}
(Don't call this "Menu usage box" templates directly on main pages. Ie: Always use GM for that.)

Example

Leading and trailing string spaces in examples are optional.
{{GM| $Menu Item 1 | Menu $Item 2 | Menu Ite$m 3 | Menu Item $4| Menu Item 5}}
Output: Template:Key box
or
{{GM
| $Menu Item 1
| Menu $Item 2
| Menu Ite$m 3
| Menu Item $4
| Menu Item 5
}}
Output: Template:Key box


Used templates

Menu_usage-set_prop .. Property assignments.
Menu_usage-set_catg .. Category assignments.
Menu_usage-set_prop-Legacy .. Property assignments. (Legacy specific)
Menu_usage-set_catg-Legacy .. Category assignments. (Legacy specific)
Key_box .. Graphics.
Key_ws .. Short-cut-key part.
Str_us2sp
Str_sp2us