Difference between revisions of "Template:Help"
m (adding noCat parameter) |
m (Mostly just fixing some blatant spelling errors & some styling errors.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 13: | Line 13: | ||
#ifeq:{{{Wiki}}}|*|[[Category:Help/Wiki{{{prefix|}}}|{{#var:Name}}]]|}}{{ | #ifeq:{{{Wiki}}}|*|[[Category:Help/Wiki{{{prefix|}}}|{{#var:Name}}]]|}}{{ | ||
#ifeq:{{{Glossary}}}|*|[[Category:Glossary{{{prefix|}}}|{{#var:Name}}]]|}}{{ | #ifeq:{{{Glossary}}}|*|[[Category:Glossary{{{prefix|}}}|{{#var:Name}}]]|}}{{ | ||
#ifeq:{{{OldInfo}}}|*| | #ifeq:{{{OldInfo}}}|*|{{Help/Old_Info}}|}}</includeonly><noinclude> | ||
This template is supposed to be used at articles related to the [[Help Portal]]. It includes [[Template:Multi-lang]] as well as the [[Template:Help Header]] and registers pages to certain help categories. Every article is automatically added to [[:Category:Help Portal]]. Critical articles can use a disclaimer to ensure that users know that the provided content is Resident created and might contain mistakes or out-of-date information. | This template is supposed to be used at articles related to the [[Help Portal]]. It includes [[Template:Multi-lang]] as well as the [[Template:Help Header]] and registers pages to certain help categories. Every article is automatically added to [[:Category:Help Portal]]. Critical articles can use a disclaimer to ensure that users know that the provided content is Resident created and might contain mistakes or out-of-date information. | ||
==Documentation== | ==Documentation== | ||
Categories can be "switched on" be placing an asterisk (*) behind the equal (=) signs of the related category. The optional disclaimer can be switched on the same way. | Categories can be "switched on" be placing an asterisk (*) behind the equal (=) signs of the related category. The optional disclaimer can be switched on the same way. Alternatively, an URL can be provided for the disclaimer which automatically places a link to a related entry on the Knowledge Base (KB) (or elsewhere) where more reliable information is stored. The variable <code>OldInfo</code> adds [[Template:Help/Old Info|a warning box]] and registers a page to the [[:Category:Articles in need of updating]]. Additional boxes in the same style can be added with [[Template:Help/Box]], which uses the syntax <nowiki>{{Help/Box|Title|Text}}</nowiki>. | ||
'''Min spec:'''<br> | |||
Min spec:<br> | |||
<nowiki>{{Help}}</nowiki> | <nowiki>{{Help}}</nowiki> | ||
'''Full spec:'''<br> | |||
Full spec:<br> | |||
<nowiki>{{Help</nowiki><br> | <nowiki>{{Help</nowiki><br> | ||
<nowiki>|Avatar=</nowiki><br> | <nowiki>|Avatar=</nowiki><br> | ||
Latest revision as of 12:58, 11 August 2022
This template is supposed to be used at articles related to the Help Portal. It includes Template:Multi-lang as well as the Template:Help Header and registers pages to certain help categories. Every article is automatically added to Category:Help Portal. Critical articles can use a disclaimer to ensure that users know that the provided content is Resident created and might contain mistakes or out-of-date information.
Documentation
Categories can be "switched on" be placing an asterisk (*) behind the equal (=) signs of the related category. The optional disclaimer can be switched on the same way. Alternatively, an URL can be provided for the disclaimer which automatically places a link to a related entry on the Knowledge Base (KB) (or elsewhere) where more reliable information is stored. The variable OldInfo adds a warning box and registers a page to the Category:Articles in need of updating. Additional boxes in the same style can be added with Template:Help/Box, which uses the syntax {{Help/Box|Title|Text}}.
Min spec:
{{Help}}
Full spec:
{{Help
|Avatar=
|Object=
|LandSim=
|Viewer=
|Community=
|Communication=
|Multimedia=
|Navigation=
|Wiki=
|Glossary=
|Misc=
|BugFixes=
|Disclaimer=
|OldInfo=
}}
Template developer info: The template also accepts the variables TVT_c and noMultiLang and sends them to Template:Help Header.
Dependencies
This Template Uses:
- Template:!
- Template:!!
- Template:Help Header
- Template:Languages/Lang
- Template:Multi-lang
- Template:Help/Disclaimer
- Template:Help/Old Info