Difference between revisions of "Template:Stub"

From RimWorld Wiki
Jump to navigation Jump to search
m (larger image)
(Simple recoding: As the only reason "nocat" would be used at all is to exclude it from setting the stub categories, now it does that if defined to any non-empty value.)
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
<includeonly>{{Rwbox
 
<includeonly>{{Rwbox
| name = stub
+
  | name = stub
| type = manual
+
  | type = manual
| color = #1e90ff
+
  | color = #1e90ff
| small = {{{small|no}}}
+
  | small = {{{small|no}}}
| image = [[File:StumpChoppedA (cropped).png|40px]]
+
  | image = [[File:StumpChoppedA (cropped).png|40px|link=Category:Stubs]]
| nocat = true
+
  | text = '''This {{#if:{{{section|}}}|section|article}} is a [[:Category:Stubs|stub]].''' You can help {{SITENAME}} by '''[{{fullurl:{{#titleparts:{{FULLPAGENAME}}|1}}|action=edit}} expanding it]. Reason:''' ''{{{reason|{{Error|Please add a reason}} {{#if: {{{nocat|}}} ||[[Category:Stub without reason]]}} }}}.''
| text = '''Chopped Stump'''
+
}} {{#if: {{{nocat|}}} || [[Category:Stubs]] {{#set: Maintenance Reason = {{#if:{{{section|}}}|Section stub|Stub}}: {{{reason|}}} }} }}</includeonly><noinclude>{{Documentation}}</noinclude>
<br/>This {{#if:{{{section|}}}|section|article}} is a '''[[:Category:Stubs|stub]]'''. You can help {{SITENAME}} by '''[{{fullurl:{{#titleparts:{{FULLPAGENAME}}|1}}|action=edit}} expanding it]. Reason:''' ''{{{reason|{{Error|Please add a reason}}}}}.''}}{{#set: Maintenance Reason = {{{reason|}}} }}{{#ifeq:{{{nocat|}}}|true||[[Category:Stubs]]}}
 
</includeonly><noinclude>
 
{{documentation}}</noinclude>
 

Latest revision as of 14:10, 21 August 2024

Documentation icon Template documentation[view] [edit] [history] [purge]

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]