Difference between revisions of "Template:Stub/doc"

From RimWorld Wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
+
__NOTOC__
 +
== Description ==
 
This template is used to mark pages as stubs, and categorizing them in [[:Category:Stubs]].
 
This template is used to mark pages as stubs, and categorizing them in [[:Category:Stubs]].
  
==Syntax==
+
== Parameters ==
Type <code>{{t|stub}}</code> on the page to be marked.
+
This template has no mandatory parameters, it is however good practice to always provide the "''reason''" parameter.
  
Additionally, the reason and section parameters can be set to denote specific area or information that needs to be improved.
+
=== "reason" parameter ===
==Sample==
+
You should always provide an explanation what information is missing - be it as obvious to you as it gets. This can be any text (e.g. <code><nowiki>{{Stub| reason = Description of the missing information}}</nowiki></code>).
<nowiki>{{stub}}</nowiki>
 
{{stub}}
 
  
<nowiki>{{stub|section = 1}}</nowiki>
+
=== "section" parameter ===
{{stub|section = 1}}
+
Setting this parameter to any value (e.g. <code><nowiki>{{Stub| section = 1}}</nowiki></code>) will change the message from "article" to "section" and suppresses adding the page to [[:Category:Stubs]]..
  
<nowiki>{{stub|reason = Template information missing}}</nowiki>
+
=== "nocat" parameter ===
{{stub|reason = Template information missing}}
+
Setting this parameter to any value (e.g. <code><nowiki>{{Stub| nocat = true}}</nowiki></code>) suppresses adding the page to [[:Category:Stubs]].
  
 +
Include this parameter when using the template for testing purposes, like on this page.
 +
 +
== Examples ==
 +
The template can be used with no arguments:
 +
<pre>{{Stub}}</pre>
 +
producing:
 +
{{Stub| nocat = true}}
 +
 +
As you can see the template complains if you don't provide a ''reason''. You should therefore always provide it:
 +
<pre>{{Stub| reason = Description of the missing information}}</pre>
 +
producing:
 +
{{Stub| reason = Description of the missing information | nocat = true}}
 +
 +
A specific section can be designated as a stub:
 +
<pre>{{Stub| reason = Description of the missing information | section = 1 }}</pre>
 +
producing:
 +
{{Stub| reason = Description of the missing information | section = 1 | nocat = true}}
 +
 +
== See also ==
 +
=== Maintenance ===
 +
* Incomplete pages/sections:
 +
** {{T|Documentation wanted}} for marking templates without documentation.
 +
** {{T|Image wanted}} for marking pages or sections that are missing images.
 +
** {{T|Stub}} for marking incomplete pages or sections.
 +
* Request major changes:
 +
** {{T|Disambig}} for marking pages that are ambiguous.
 +
** {{T|Merge}} for marking pages that should be merged.
 +
** {{T|Move}} for marking pages or sections that should be moved.
 +
** {{T|Rewrite}} for marking pages or sections that should be rewritten.
 +
** {{T|Recode}} for marking templates or pages that need to be recoded.
 +
* Deletion:
 +
** {{T|Delete}} for marking pages that should be deleted.
 +
** {{T|Obsolete}} for marking pages that are no longer relevant to the current game version.
 +
** {{T|Safe to delete}} for marking pages that are ready to be deleted.
 +
** {{T|SpeedyDelete}} for marking pages that should be deleted as fast as possible.
 +
 +
=== Content ===
 +
* {{T|Biotech}} for marking content from [[Biotech (DLC)]] {{BiotechIcon}}.
 +
* {{T|Ideology}} for marking content from [[Ideology (DLC)]] {{IdeologyIcon}}.
 +
* {{T|Royalty}} for marking content from [[Royalty (DLC)]] {{RoyaltyIcon}}.
 +
* {{T|Console}} for marking  content from the [[console edition]] {{ConsoleIcon}}.
 +
* {{T|Spoiler}} for marking potential spoilers.
 +
 +
<noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Notice templates]]</includeonly>
 
<includeonly>[[Category:Notice templates]]</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>
 

Latest revision as of 21:09, 21 August 2024

Description[edit]

This template is used to mark pages as stubs, and categorizing them in Category:Stubs.

Parameters[edit]

This template has no mandatory parameters, it is however good practice to always provide the "reason" parameter.

"reason" parameter[edit]

You should always provide an explanation what information is missing - be it as obvious to you as it gets. This can be any text (e.g. {{Stub| reason = Description of the missing information}}).

"section" parameter[edit]

Setting this parameter to any value (e.g. {{Stub| section = 1}}) will change the message from "article" to "section" and suppresses adding the page to Category:Stubs..

"nocat" parameter[edit]

Setting this parameter to any value (e.g. {{Stub| nocat = true}}) suppresses adding the page to Category:Stubs.

Include this parameter when using the template for testing purposes, like on this page.

Examples[edit]

The template can be used with no arguments:

{{Stub}}

producing:

As you can see the template complains if you don't provide a reason. You should therefore always provide it:

{{Stub| reason = Description of the missing information}}

producing:

A specific section can be designated as a stub:

{{Stub| reason = Description of the missing information | section = 1 }}

producing:

See also[edit]

Maintenance[edit]

  • Incomplete pages/sections:
    • {{Documentation wanted}} for marking templates without documentation.
    • {{Image wanted}} for marking pages or sections that are missing images.
    • {{Stub}} for marking incomplete pages or sections.
  • Request major changes:
    • {{Disambig}} for marking pages that are ambiguous.
    • {{Merge}} for marking pages that should be merged.
    • {{Move}} for marking pages or sections that should be moved.
    • {{Rewrite}} for marking pages or sections that should be rewritten.
    • {{Recode}} for marking templates or pages that need to be recoded.
  • Deletion:
    • {{Delete}} for marking pages that should be deleted.
    • {{Obsolete}} for marking pages that are no longer relevant to the current game version.
    • {{Safe to delete}} for marking pages that are ready to be deleted.
    • {{SpeedyDelete}} for marking pages that should be deleted as fast as possible.

Content[edit]