Difference between revisions of "Template:Recode/doc"

From RimWorld Wiki
Jump to navigation Jump to search
 
(4 intermediate revisions by one other user not shown)
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>test</code> Setting this parameter 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>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 ==
 
== Examples ==
 
<pre>{{Recode}}</pre>
 
<pre>{{Recode}}</pre>
 
Results in:
 
Results in:
{{Recode|test=1}}
+
{{Recode|nocat=true}}
  
 
As you can see you should always provide a short reason or a description of what exactly should be recoded:
 
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>
 
<pre>{{Recode|reason=The table is overly complicated}}</pre>
 
Results in:
 
Results in:
{{Recode|reason=The table is overly complicated|test=1}}
+
{{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]

  • 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: