Difference between revisions of "Template:Good/doc"

From RimWorld Wiki
Jump to navigation Jump to search
Line 1: Line 1:
{{Documentation wanted}}
+
Because the effects of stats, effects, and other changes can be somewhat obscure, beneficial and detrimental effects on this wiki are displayed as green and red respectively. When dealing with number additions and subtractions, [[Template:+]], [[Template:++]], [[Template:--]], and [[Template:---]] are useful, however, they add a symbol before the text which isn't always appropriate. This template, along side [[Template:Bad]], add the option to format text similarly without the symbol.
 +
 
 +
For ease of use, it also formats any '''leading''' "-" and "x" into "−" and "×" respectively. This can be suppressed by the noFormat argument.
 +
 
 +
== Example ==
 +
 
 
<pre>{{Good|Good thing}}</pre>
 
<pre>{{Good|Good thing}}</pre>
 
produces: {{Good|Good thing}} as a result.
 
produces: {{Good|Good thing}} as a result.
Line 28: Line 33:
  
 
==See Also==
 
==See Also==
 
+
* [[Template:Bad]]
*[[Template:++]]
+
* [[Template:+]]
*[[Template:--]]
+
* [[Template:++]]
*[[Template:---]]
+
* [[Template:--]]
 +
* [[Template:---]]
  
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 22:18, 15 February 2023

Because the effects of stats, effects, and other changes can be somewhat obscure, beneficial and detrimental effects on this wiki are displayed as green and red respectively. When dealing with number additions and subtractions, Template:+, Template:++, Template:--, and Template:--- are useful, however, they add a symbol before the text which isn't always appropriate. This template, along side Template:Bad, add the option to format text similarly without the symbol.

For ease of use, it also formats any leading "-" and "x" into "−" and "×" respectively. This can be suppressed by the noFormat argument.

Example

{{Good|Good thing}}

produces: Good thing as a result.

{{Good|x5}}

produces: ×5 as a result.

{{Good|-5}}

produces: −5 as a result.

{{Good|x5|noFormat=1}}

produces: x5 as a result.

{{Good|-5|noFormat=1}}

produces: -5 as a result.

{{Good|5x5}}

produces: 5x5 as a result.

{{Good|5x5|noFormat=1}}

produces: 5x5 as a result.

{{Good|5-5}}

produces: 5−5 as a result.

{{Good|5-5|noFormat=1}}

produces: 5-5 as a result.

See Also