Difference between revisions of "Template:Help"

From Space Station 13 Wiki
Jump to navigation Jump to search
m (Divvying up templates into subcategories for ease of use)
(Add documentation. Got advice when to use it, a bit on "parameters", an example, and the raw markup for copy-and-pasting)
Line 1: Line 1:
==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===
<nowiki>{{Help}}</nowiki>
===Output===
<onlyinclude><font color=green>'''{{{1|Help}}}'''</font></onlyinclude>
<onlyinclude><font color=green>'''{{{1|Help}}}'''</font></onlyinclude>
==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}}.
==Example==
<nowiki>While on {{Help}} intent, you pass through people.</nowiki>
While on {{Help}} intent, you pass through people.
[[Category:Decorative Templates]]
[[Category:Decorative Templates]]

Revision as of 04:55, 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.