Template:GM/box/doc: Difference between revisions

Latest revision as of 11:08, 12 September 2024

General "menu path to feature" template.

Currently supporting up to 6 parameters. (anonymous type)

Use a leading '$' character to target a string character.

Targeted character gets enclosed by a Key/box template call.

(Only intended, and tested, with one '$' instance per string.)

(Only intended to be used from "GM"/"GM/sub" template.)

{{GM/box|String1|String2|..|String6}}

{{GM/box| $Menu Item 1 | Menu $Item 2 | Menu Ite$m 3 | Menu Item $4| Menu Item 5}}

Output:

Menu Item 1 > Menu Item 2 > Menu Item 3 > Menu Item 4 > Menu Item 5

or

{{GM/box

| $Menu Item 1

| Menu $Item 2

| Menu Ite$m 3

| Menu Item $4

| Menu Item 5

}}

Output:

Menu Item 1 > Menu Item 2 > Menu Item 3 > Menu Item 4 > Menu Item 5

Leading and trailing string spaces in examples are optional.

@@ Line 1: / Line 1: @@
 <includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 ===Info===
+:General "menu path to feature" template.
+:Currently supporting up to 6 parameters. (anonymous type)
+:Use a leading '$' character to target a string character.
+:Targeted character gets enclosed by a [[template:Key/box|Key/box]] template call.
+:(''Only intended, and tested, with one '$' instance per string.'')
+:'''(''Only intended to be used from "GM"/"GM/sub" template.'')'''
-:General "menu path to feature" box ...
+===Usage===
-:Currently supporting 6 parameters (anonymous type).
+:<code>{{t|GM/box|String1|String2|..|String6}}</code>
-:Uses Key_ws template.
+===Example===
+:<nowiki>{{GM/box|</nowiki> '''$'''Menu Item 1 | Menu '''$'''Item 2 | Menu Ite'''$'''m 3 | Menu Item '''$'''4| Menu Item 5}}
+:Output: {{GM/box| $Menu Item 1 | Menu $Item 2 | Menu Ite$m 3 | Menu Item $4 | Menu Item 5}}
+:or
+:<nowiki>{{GM/box</nowiki>
+:| '''$'''Menu Item 1
+:| Menu '''$'''Item 2
+:| Menu Ite'''$'''m 3
+:| Menu Item '''$'''4
+:| Menu Item 5
+:}}
+:Output: {{GM/box
+| $Menu Item 1
+| Menu $Item 2
+| Menu Ite$m 3
+| Menu Item $4
+| Menu Item 5
+}}
+:''Leading and trailing string spaces in examples are optional.''
+===Used templates===
+:[[Template:GM/keys|GM/keys]]
+:[[Template:Str_us2sp|Str_us2sp]]
+:[[Template:Str_sp2us|Str_sp2us]]