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) m (→Contents of the Template: specify what exactly is supposed to use the green) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude> | |||
==Usage Guide== | ==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. | 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. Unlike, say [[Template:Location]], you do not need to specify any parameters, though it is possible; see below. | ||
==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}}. | ||
== | |||
==Examples== | |||
<nowiki>{{Help}}</nowiki> | |||
{{Help}} | |||
<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. | ||
==Contents of the Template== | |||
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 the template to use a different kind of green.</noinclude> | |||
<onlyinclude><font color=green>'''{{{1|Help}}}'''</font></onlyinclude> | |||
<noinclude> | |||
[[Category:Decorative Templates]] | [[Category:Decorative Templates]] | ||
</noinclude> | |||
Latest revision as of 06:12, 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. Unlike, say Template:Location, you do not need to specify any parameters, though it is possible; see below.
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.
Examples
{{Help}}
Help
While on {{Help}} intent, you pass through people.
While on Help intent, you pass through people.
Contents of the Template
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 the template to use a different kind of green.
Help