Difference between revisions of "Template:Recode/doc"
Jump to navigation
Jump to search
m |
m |
||
| Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
* <code>reason</code> Why and/or what exactly should be recoded. | * <code>reason</code> Why and/or what exactly should be recoded. | ||
| − | * <code>nocat</code> Setting this paramete to <code>true</code> prevents the page to be added to the [[Category:Pages to be recoded]]. This is useful on pages like this where you just want to display the template. | + | * <code>nocat</code> Setting this paramete to <code>true</code> prevents the page to be added to the [[:Category:Pages to be recoded]]. This is useful on pages like this where you just want to display the template. |
== Examples == | == Examples == | ||
Revision as of 14:24, 7 June 2022
Description
You can use the Needs Re-coded template to mark a page for future re-code. This will help developers have a high level overview of what templates, pages, and the like are to be re-coded and brought up to industry standards.
Usage
Place the following code snippet at the top of the page needing re-coded, before any other text on the page. Be sure to add the "noinclude" tags to make sure it doesn't break anything!
<noinclude>{{Recode|reason=}}</noinclude>
Parameters
reasonWhy and/or what exactly should be recoded.nocatSetting this paramete totrueprevents the page to be added to the Category:Pages to be recoded. This is useful on pages like this where you just want to display the template.
Examples
{{Recode}}
Results in:
 | This page has been suggested for recoding. Reason: Please provide a reason. You can help RimWorld Wiki by improving it. |
As you can see you should always provide a short reason or a description of what exactly should be recoded:
{{Recode|reason=The table is overly complicated}}
Results in:
| This page has been suggested for recoding. Reason: The table is overly complicated. You can help RimWorld Wiki by improving it. |