Difference between revisions of "Template:Recode"

From RimWorld Wiki
Jump to navigation Jump to search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{rwbox
+
<includeonly>{{Rwbox
|nocat=true
+
| name = recode
| type = cleanup
+
| type = manual
| text  = This {{#if:{{{section|}}}|section|page}} has been suggested for [[:Category: Pages to be recoded|recoding]]. {{#if:{{{reason|}}}|Reason: {{{reason|}}}.|}} You can help {{SITENAME}} by '''[{{fullurl:{{#titleparts: {{FULLPAGENAME}}|1}} |action=edit}} improving]''' it.
+
| color = #f28500
}}[[Category:Pages to be recoded]]</includeonly><noinclude>
+
| small = {{{small|no}}}
{{Documentation}}
+
| image = [[File:AncientTerminal east.png|40px|link=Category:Pages to be recoded]]
<!-- Add categories and interwikis to the /doc subpage, not here! -->
+
| Ancient terminal.png
</noinclude>
+
| text  = This {{#if:{{{section|}}}|section|page}} has been suggested for [[:Category: Pages to be recoded|recoding]]. '''Reason:''' ''{{{reason|{{Error|Please provide a reason}}}}}''. You can help {{SITENAME}} by '''[{{fullurl:{{#titleparts: {{FULLPAGENAME}}|1}} |action=edit}} improving]''' it.
 +
}}{{#set: Maintenance Reason = Recode: {{{reason|}}}}}{{#ifeq:{{{nocat|}}}|true||[[Category:Pages to be recoded]]}}</includeonly>
 +
<noinclude>{{Documentation}}</noinclude>

Latest revision as of 02:29, 16 November 2023

Documentation icon Template documentation[view] [edit] [history] [purge]

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]

  • 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 to true 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[edit]

{{Recode}}

Results in:


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:


If the page is used in a section, rather than the whole page:

{{Recode|section=1|reason=Very important ;)}}

Results in: