Difference between revisions of "Template:Help"
Studenterhue (talk | contribs) (Add documentation. Got advice when to use it, a bit on "parameters", an example, and the raw markup for copy-and-pasting) |
Studenterhue (talk | contribs) (Set aside a clear(er) place for the markup of the template itself) |
||
| Line 6: | Line 6: | ||
<nowiki>{{Help}}</nowiki> | <nowiki>{{Help}}</nowiki> | ||
===Output=== | ===Output=== | ||
{{Help}} | |||
==Parameter Definitions== | ===Parameter Definitions=== | ||
When using the template, you can, optionally, put a | after "Help" to use a custom piece of text in place of the word Help, e.g. <code><nowiki>{{Help|Help mode}}</nowiki></code> to get {{Help|Help mode}}. | When using the template, you can, optionally, put a | after "Help" to use a custom piece of text in place of the word Help, e.g. <code><nowiki>{{Help|Help mode}}</nowiki></code> to get {{Help|Help mode}}. | ||
==Example== | ==Example== | ||
<nowiki>While on {{Help}} intent, you pass through people.</nowiki> | <nowiki>While on {{Help}} intent, you pass through people.</nowiki> | ||
While on {{Help}} intent, you pass through people. | While on {{Help}} intent, you pass through people. | ||
==Template Formatting== | |||
This part contains the markup used to create the template. Edit this part for if you want to change the template itself rather than the documentation here, e.g. if you want to use a different kind of green. | |||
<onlyinclude><font color=green>'''{{{1|Help}}}'''</font></onlyinclude> | |||
[[Category:Decorative Templates]] | [[Category:Decorative Templates]] | ||
Revision as of 05:33, 2 July 2021
Usage Guide
Use this template whenever you mention an interaction involving the Help intent, e.g. "click on person while on Help intent" or "on Help intent, the device does..." This is not meant for something like "help the Engineers rebuild areas" or "Need more help? Check out this guide", where "help" refers to something besides the intent.
Format
Raw Markup
{{Help}}
Output
Help
Parameter Definitions
When using the template, you can, optionally, put a | after "Help" to use a custom piece of text in place of the word Help, e.g. {{Help|Help mode}} to get Help mode.
Example
While on {{Help}} intent, you pass through people.
While on Help intent, you pass through people.
Template Formatting
This part contains the markup used to create the template. Edit this part for if you want to change the template itself rather than the documentation here, e.g. if you want to use a different kind of green.
Help