Template:Cost/doc

From DominionStrategy Wiki
(Difference between revisions)
Jump to: navigation, search
(Fixed the category link and added a mention to the new parsing functionalities for the Debt parameter.)
(Switching Template:Cost's documentation for a new version.)
Line 7: Line 7:
 
* <tt><nowiki>{{Cost|?}}</nowiki> →  {{Cost|?}}</tt>
 
* <tt><nowiki>{{Cost|?}}</nowiki> →  {{Cost|?}}</tt>
 
* <tt><nowiki>{{Cost|x}}</nowiki> →  {{Cost|x}}</tt>
 
* <tt><nowiki>{{Cost|x}}</nowiki> →  {{Cost|x}}</tt>
* <tt><nowiki>{{Cost|P}}</nowiki> →  {{Cost|P}}</tt>
+
* <tt><nowiki>{{Cost||||P}}</nowiki> →  {{Cost||||P}}</tt>
* <tt><nowiki>{{Cost|6P}}</nowiki> →  {{Cost|6P}}</tt>
+
* <tt><nowiki>{{Cost|6|||P}}</nowiki> →  {{Cost|6|||P}}</tt>
 
* <tt><nowiki>{{Cost|||8}}</nowiki> →  {{Cost|||8}}</tt>
 
* <tt><nowiki>{{Cost|||8}}</nowiki> →  {{Cost|||8}}</tt>
 
* <tt><nowiki>{{Cost|6||8}}</nowiki> →  {{Cost|6||8}}</tt>
 
* <tt><nowiki>{{Cost|6||8}}</nowiki> →  {{Cost|6||8}}</tt>
* <tt><nowiki>{{Cost|6P||8}}</nowiki> →  {{Cost|6P||8}}</tt>
+
* <tt><nowiki>{{Cost|-|||P}}</nowiki> →  {{Cost|-|||P}}</tt>
 +
* <tt><nowiki>{{Cost|6||8|P}}</nowiki> →  {{Cost|6||8|P}}</tt>
 +
* <tt><nowiki>{{Cost||m|-|P}}</nowiki> →  {{Cost||m|-|P}}</tt>
 
* <tt><nowiki>{{Cost|5|l}}</nowiki> →  {{Cost|5|l}}</tt>
 
* <tt><nowiki>{{Cost|5|l}}</nowiki> →  {{Cost|5|l}}</tt>
* <tt><nowiki>{{Cost|P|l}}</nowiki> →  {{Cost|P|l}}</tt>
+
* <tt><nowiki>{{Cost||l||P}}</nowiki> →  {{Cost||l||P}}</tt>
 
* <tt><nowiki>{{Cost||l|8}}</nowiki> →  {{Cost||l|8}}</tt>
 
* <tt><nowiki>{{Cost||l|8}}</nowiki> →  {{Cost||l|8}}</tt>
* <tt><nowiki>{{Cost|6P|l|8}}</nowiki> →  {{Cost|6P|l|8}}</tt>
+
* <tt><nowiki>{{Cost|-|l|-}}</nowiki> →  {{Cost|-|l|-}}</tt>
 +
* <tt><nowiki>{{Cost|6|l|8|P}}</nowiki> →  {{Cost|6|l|8|P}}</tt>
 
* <tt><nowiki>{{Cost|5|xl}}</nowiki> →  {{Cost|5|xl}}</tt>
 
* <tt><nowiki>{{Cost|5|xl}}</nowiki> →  {{Cost|5|xl}}</tt>
 +
* <tt><nowiki>{{Cost|-|xl|-|P}}</nowiki> →  {{Cost|-|xl|-|P}}</tt>
  
==New Syntax==
+
==Obsolete Syntax==
The old "P" syntax where P is found within the first parameter is being made obsolete in lieu of the new parameterized syntax where the P is separated into a new fourth parameter.<br/>
+
As of June 10th 2024 5:00pm UTC, the old "P" syntax where P is found within the first parameter has been made obsolete in lieu of the new parameterized syntax where the P is separated into a new fourth parameter.<br/>
Henceforth, any instances of the "P" syntax found should be replaced with the respective parameterized syntax.
+
As such, any instances of the "P" syntax are now broken, so they need to be replaced with the new parameterized syntax.
 
* <tt><nowiki>{{Cost|6P}}</nowiki> →  <nowiki>{{Cost|6|||P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|6P}}</nowiki> →  <nowiki>{{Cost|6|||P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|6P||8}}</nowiki> →  <nowiki>{{Cost|6||8|P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|6P||8}}</nowiki> →  <nowiki>{{Cost|6||8|P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|P|l}}</nowiki> →  <nowiki>{{Cost||l||P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|P|l}}</nowiki> →  <nowiki>{{Cost||l||P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|6P|l|8}}</nowiki> →  <nowiki>{{Cost|6|l|8|P}}</nowiki></tt>
 
* <tt><nowiki>{{Cost|6P|l|8}}</nowiki> →  <nowiki>{{Cost|6|l|8|P}}</nowiki></tt>
 
+
<!-- This section is only to be removed after some time has passed following the deprecation of the old "P" syntax to allow others time to fix any remaining broken instances. -->
If an instance of <tt><nowiki>{{Cost}}</nowiki></tt> uses the "P" syntax, it will display the following warning.<br/><p style="color:red; display:inline;"><b>[Warning: This Cost Template uses the old "P" syntax, please convert it to the [[Template:Cost#New_Syntax|new parameterized syntax]].]</b></p><p>An instance of the "P" syntax will also file the page it is in under the category titled [[:Category:Pages with old "P" syntax]].</p>
+
 
+
 
+
The syntactical changes also allow for new functionality with the ability to put "-" in the Coin and Debt parameters, allowing the empty Coin and Debt images to be displayed.
+
* <tt><nowiki>{{Cost|-|||P}}</nowiki> →  {{Cost|-|||P}}</tt>
+
* <tt><nowiki>{{Cost|||-|P}}</nowiki> →  {{Cost|||-|P}}</tt>
+
* <tt><nowiki>{{Cost|-||-}}</nowiki> →  {{Cost|-||-}}</tt>
+
* <tt><nowiki>{{Cost|-||-|P}}</nowiki> →  {{Cost|-||-|P}}</tt>
+
 
+
The changes also allow the Debt parameter to now have parsing for <tt>?</tt>, ''<tt>n</tt>''+, and ''<tt>n</tt>''* amounts.
+

Revision as of 13:00, 10 June 2024

This template allows translating text cost into graphical cost.

Usage

  • {{Cost}} → $
  • {{Cost|3}} → $3
  • {{Cost|0*}} → $0*
  • {{Cost|?}} → $?
  • {{Cost|x}} → $x
  • {{Cost||||P}} → P
  • {{Cost|6|||P}} → $6P
  • {{Cost|||8}} → 8D
  • {{Cost|6||8}} → $68D
  • {{Cost|-|||P}} → $P
  • {{Cost|6||8|P}} → $68DP
  • {{Cost||m|-|P}} → DP
  • {{Cost|5|l}} → $5
  • {{Cost||l||P}} → P
  • {{Cost||l|8}} → 8D
  • {{Cost|-|l|-}} → $D
  • {{Cost|6|l|8|P}} → $68DP
  • {{Cost|5|xl}} → $5
  • {{Cost|-|xl|-|P}} → $DP

Obsolete Syntax

As of June 10th 2024 5:00pm UTC, the old "P" syntax where P is found within the first parameter has been made obsolete in lieu of the new parameterized syntax where the P is separated into a new fourth parameter.
As such, any instances of the "P" syntax are now broken, so they need to be replaced with the new parameterized syntax.

  • {{Cost|6P}} → {{Cost|6|||P}}
  • {{Cost|6P||8}} → {{Cost|6||8|P}}
  • {{Cost|P|l}} → {{Cost||l||P}}
  • {{Cost|6P|l|8}} → {{Cost|6|l|8|P}}
Personal tools
Namespaces

Variants
Views
Actions
Navigation
Toolbox