Editing Template:Stub/doc

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
__NOTOC__
+
==Description==
== Description ==
+
This template is used to mark pages as stub, categorizing them in [[:Category:Page Stub]].
This template is used to mark pages as stubs, and categorizing them in [[:Category:Stubs]].
 
  
== Parameters ==
+
==Syntax==
This template has no mandatory parameters, it is however good practice to always provide the "''reason''" parameter.
+
Type <code>{{t|stub}}</code> on the page to be marked.
  
=== "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>).
+
{{stub}}
 
 
=== "section" parameter ===
 
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]]..
 
 
 
=== "notoc" parameter ===
 
Setting this parameter to ''true'' (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.
 
  
 +
<includeonly>[[Category:Notice templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>[[Category:Notice templates]]</includeonly>
 

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)