Difference between revisions of "Template:Recode"
Jump to navigation
Jump to search
m (Harakoni moved page Template:Modal needs recoded to Template:Recode: Keep naming style consistent) |
Revision as of 00:21, 9 November 2020
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
reason
Why and/or what exactly should be recoded.section
Set this parameter to any value if you want to specify that only one section should be recoded.nocat
Setting this parameter totrue
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
{{Recode}}
Results in:
This page has been suggested for recoding. 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. |
If the page is used in a section, rather than the whole page:
{{Recode|section=1|reason=Very important ;)}}
Results in:
This page has been suggested for recoding. Reason: Very important ;). You can help RimWorld Wiki by improving it. |
The above documentation is transcluded from Template:Recode/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |