Difference between revisions of "Template:Stub/doc"
Jump to navigation
Jump to search
(updated format and content) |
|||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Description== | + | __NOTOC__ |
| − | This template is used to mark pages as | + | == 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 === |
| − | <noinclude>[[Category:Template | + | 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>). |
| + | |||
| + | === "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]].. | ||
| + | |||
| + | === "nocat" parameter === | ||
| + | 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> | ||
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:
 | This article is a stub. You can help RimWorld Wiki by expanding it. Reason: Please add a reason . |
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:
| This article is a stub. You can help RimWorld Wiki by expanding it. Reason: Description of the missing information. |
A specific section can be designated as a stub:
{{Stub| reason = Description of the missing information | section = 1 }}
producing:
| This section is a stub. You can help RimWorld Wiki by expanding it. Reason: Description of the missing information. |
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:
- 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]
- {{Biotech}} for marking content from Biotech (DLC)
. - {{Ideology}} for marking content from Ideology (DLC)
. - {{Royalty}} for marking content from Royalty (DLC)
. - {{Console}} for marking content from the console edition
. - {{Spoiler}} for marking potential spoilers.