Editing Template:Recode/doc

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
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>
+
<pre>
 +
<noinclude>
 +
  {{Recode}}
 +
</noinclude>
 +
</pre>
  
== Parameters ==
+
==Sample Output ==
* <code>reason</code> Why and/or what exactly should be recoded.
+
{{rwbox
* <code>section</code> Set this parameter to any value if you want to specify that only one section should be recoded.
+
|nocat=true
* <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.
+
| type  = cleanup
 
+
| text  = This 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.
== 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>

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)