Difference between revisions of "Template:Recode/doc"
Jump to navigation
Jump to search
(→Usage) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Description== | + | == 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. | 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== | + | == 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! | 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! | ||
| − | + | <pre><noinclude>{{Recode|reason=}}</noinclude></pre> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | == Parameters == |
| − | {{ | + | * <code>reason</code> Why and/or what exactly should be recoded. |
| − | |nocat=true | + | * <code>section</code> Set this parameter to any value if you want to specify that only one section should be recoded. |
| − | | | + | * <code>nocat</code> Setting this parameter 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 == |
| + | <pre>{{Recode}}</pre> | ||
| + | Results in: | ||
| + | {{Recode|nocat=true}} | ||
| + | |||
| + | As you can see you should always provide a short reason or a description of what exactly should be recoded: | ||
| + | <pre>{{Recode|reason=The table is overly complicated}}</pre> | ||
| + | Results in: | ||
| + | {{Recode|reason=The table is overly complicated|nocat=true}} | ||
| + | |||
| + | If the page is used in a section, rather than the whole page: | ||
| + | <pre>{{Recode|section=1|reason=Very important ;)}}</pre> | ||
| + | Results in: | ||
| + | {{Recode|section=1|reason=Very important ;)|nocat=true}} | ||
<includeonly>[[Category:Notice templates]]</includeonly> | <includeonly>[[Category:Notice templates]]</includeonly> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||
Latest revision as of 11:42, 19 June 2022
Description[edit]
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[edit]
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[edit]
reasonWhy and/or what exactly should be recoded.sectionSet this parameter to any value if you want to specify that only one section should be recoded.nocatSetting this parameter 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[edit]
{{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. |
If the page is used in a section, rather than the whole page:
{{Recode|section=1|reason=Very important ;)}}
Results in:
| This section has been suggested for recoding. Reason: Very important ;). You can help RimWorld Wiki by improving it. |