Difference between revisions of "Template:Stub/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(rewritten)
m (Updated documentation.)
Line 13: Line 13:
  
 
=== "notoc" parameter ===
 
=== "notoc" parameter ===
Setting this parameter to ''true'' (e.g. <code><nowiki>{{Stub| nocat = true}}</nowiki></code>) suppresses adding the page to [[:Category:Stubs]].
+
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.
 
Include this parameter when using the template for testing purposes, like on this page.

Revision as of 14:11, 21 August 2024

Description

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

Parameters

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

"reason" parameter

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

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..

"notoc" parameter

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

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

Maintenance

  • 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