Template:Legacy variant table header/doc: Difference between revisions

Latest revision as of 17:00, 31 December 2022

This subpage provides documentation for Template:Legacy variant table header.

{{Legacy variant table header}} is used with {{legacy variant table row}} and {{legacy variant table end}} to display a table of an item's legacy variants.

Parameters

Header

{{Legacy variant table header}} takes the following parameters.

Parameter	Value	Optional	Description
`\|base=`	bool	✓	Whether to show a column header for base item type. Defaults to false.
`\|level=`	bool	✓	Whether to show a column header for required level. Defaults to false.

Row

{{Legacy variant table row}} takes the following parameters.

Parameter	Value	Optional	Description
`\|version=`	str	✗	The version this legacy variant was discontinued. Defaults to the value of the first unnamed parameter.
`\|implicit=`	str	✓	The implicit stat block of this legacy variant. Defaults to the value of the second unnamed parameter as long as `\|explicit=` or the third unnamed parameter is also set.
`\|explicit=`	str	✓	The explicit stat block of this legacy variant. Defaults to the value of the third unnamed parameter as long as `\|implicit=` or the second unnamed parameter is also set; otherwise it defaults to the value of the second unnamed parameter.
`\|base=`	str	✓	The base item type of this legacy variant.
`\|level=`	str	✓	The required level of this legacy variant.

End

There are no parameters for {{legacy variant table end}}.

Usage

When constructing the stat blocks of an item's legacy variant, compare the legacy variant to the current variant and format each stat line accordingly:

To show that a stat line has different values in the legacy variant, format the text using {{c|mod|…}}.
There is no need to format the text of stats that are unchanged from the legacy variant.

{{Legacy variant table header|base=yes|level=yes}}
{{Legacy variant table row|1.2.0|base=[[Cured Quiver]]|level=22|
* {{c|mod|Adds 2 to 4 Fire Damage to Attacks}}
|
* 10% increased Attack Speed
* {{c|mod|+20 to Evasion Rating}}
* +(10-30) to maximum Mana
* {{c|mod|(30-50)% of Physical Damage Converted to Fire Damage}}
}}
{{Legacy variant table end}}

Yields:

Version discontinued	Base item		Stats Compare each legacy variant to the current variant. Stat line – Same as current variant Stat line – Different from current variant
1.2.0	Cured Quiver	22	Adds 2 to 4 Fire Damage to Attacks 10% increased Attack Speed +20 to Evasion Rating +(10-30) to maximum Mana (30-50)% of Physical Damage Converted to Fire Damage

Cargo

Table	Declared by	Attached by
legacy_variants	{{Legacy variant table row/cargo/legacy variants/declare}}	{{Legacy variant table row/cargo/legacy variants/attach}}

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+{{Documentation subpage}}
-<section begin=documentation />
-Creates a table for [[legacy]] items. {{tlx|Legacy variant table header}} is used with {{tlx|Legacy variant table row}}.
+{{tl|Legacy variant table header}} is used with {{tl|legacy variant table row}} and {{tl|legacy variant table end}} to display a table of an item's [[legacy variant]]s.
 ==Parameters==
 ===Header===
-Parameters for {{tlx|Legacy variant table header}}.
+{{tl|Legacy variant table header}} takes the following parameters.
 {| class="wikitable sortable"
 ! Parameter
@@ Line 12: / Line 13: @@
 ! Description
 |-
-| base
+| <code><nowiki>|base=</nowiki></code>
 | bool
 | {{yes}}
-| Base item type
+| Whether to show a column header for base item type. Defaults to false.
 |-
-| level
+| <code><nowiki>|level=</nowiki></code>
 | bool
 | {{yes}}
-| Required level
+| Whether to show a column header for required level. Defaults to false.
 |}
 ===Row===
-Parameters for {{tlx|Legacy variant table row}}.
+{{tl|Legacy variant table row}} takes the following parameters.
 {| class="wikitable sortable"
 ! Parameter
@@ Line 31: / Line 33: @@
 ! Description
 |-
-| 1
+| <code><nowiki>|version=</nowiki></code>
 | str
 | {{no}}
-| [[Version]] when the item was discontinued.
+| The version this legacy variant was discontinued. Defaults to the value of the first unnamed parameter.
 |-
-| 2
+| <code><nowiki>|implicit=</nowiki></code>
 | str
-| {{no}}
+| {{yes}}
-| [[Implicit]] or [[explicit]] modifier text, depending on if <nowiki>{{{3}}}</nowiki> also is set.
+| The implicit stat block of this legacy variant. Defaults to the value of the second unnamed parameter as long as <code><nowiki>|explicit=</nowiki></code> or the third unnamed parameter is also set.
-Bright text indicates a modifier that is different in a legacy variant.&#10;Strike-through text indicates a modifier that does not exist in a legacy variant.
-* Bright text: <code><nowiki>{{c|mod|sample text}}</nowiki></code> → {{c|mod|sample text}}
-* Strike-through text: <code><nowiki>{{c|not|sample text}}</nowiki></code> → {{c|not|Sample text}}
 |-
-| 3
+| <code><nowiki>|explicit=</nowiki></code>
 | str
 | {{yes}}
-| [[Explicit]] modifier text.
+| The explicit stat block of this legacy variant. Defaults to the value of the third unnamed parameter as long as <code><nowiki>|implicit=</nowiki></code> or the second unnamed parameter is also set; otherwise it defaults to the value of the second unnamed parameter.
-Bright text indicates a modifier that is different in a legacy variant.&#10;Strike-through text indicates a modifier that does not exist in a legacy variant.
-* Bright text: <code><nowiki>{{c|mod|sample text}}</nowiki></code> → {{c|mod|sample text}}
-* Strike-through text: <code><nowiki>{{c|not|sample text}}</nowiki></code> → {{c|not|Sample text}}
 |-
-| base
+| <code><nowiki>|base=</nowiki></code>
 | str
 | {{yes}}
-| Base item type
+| The base item type of this legacy variant.
 |-
-| level
+| <code><nowiki>|level=</nowiki></code>
 | str
 | {{yes}}
-| Required level
+| The required level of this legacy variant.
 |}
-==Examples==
+===End===
+There are no parameters for {{tl|legacy variant table end}}.
+==Usage==
+When constructing the stat blocks of an item's legacy variant, compare the legacy variant to the current variant and format each stat line accordingly:
+* To show that a stat line has different values in the legacy variant, format the text using {{tlx|c|mod|&hellip;}}.
+* There is no need to format the text of stats that are unchanged from the legacy variant.
 <pre>
-{{legacy variant table header|base=yes|level=yes}}
+{{Legacy variant table header|base=yes|level=yes}}
-{{legacy variant table row|1.2.0|base=[[Cured Quiver]]|level=22|{{c|mod|Adds 2 to 4 Fire Damage to Attacks}}|10% increased Attack Speed<br />{{c|mod|+20 to Evasion Rating}}<br />+(10-30) to maximum Mana<br />{{c|mod|(30-50)% of Physical Damage Converted to Fire Damage}}<br />{{c|not|Adds 5 to 10 Fire Damage to Attacks with Bows}}}}
+{{Legacy variant table row|1.2.0|base=[[Cured Quiver]]|level=22|
-|}
+* {{c|mod|Adds 2 to 4 Fire Damage to Attacks}}
+|
+* 10% increased Attack Speed
+* {{c|mod|+20 to Evasion Rating}}
+* +(10-30) to maximum Mana
+* {{c|mod|(30-50)% of Physical Damage Converted to Fire Damage}}
+}}
+{{Legacy variant table end}}
 </pre>
-yields:
-{{legacy variant table header|base=yes|level=yes}}
+Yields:
-{{legacy variant table row|1.2.0|base=[[Cured Quiver]]|level=22|{{c|mod|Adds 2 to 4 Fire Damage to Attacks}}|10% increased Attack Speed<br />{{c|mod|+20 to Evasion Rating}}<br />+(10-30) to maximum Mana<br />{{c|mod|(30-50)% of Physical Damage Converted to Fire Damage}}<br />{{c|not|Adds 5 to 10 Fire Damage to Attacks with Bows}}}}
+{{Legacy variant table header|base=yes|level=yes}}
+{{Legacy variant table row|1.2.0|base=[[Cured Quiver]]|level=22|
+* {{c|mod|Adds 2 to 4 Fire Damage to Attacks}}
+|
+* 10% increased Attack Speed
+* {{c|mod|+20 to Evasion Rating}}
+* +(10-30) to maximum Mana
+* {{c|mod|(30-50)% of Physical Damage Converted to Fire Damage}}
+}}
+{{Legacy variant table end}}
+==Cargo==
+{| class="wikitable"
+! Table !! Declared by !! Attached by
+|-
+| [[Special:CargoTables/legacy_variants|legacy_variants]]
+| {{tl|Legacy variant table row/cargo/legacy variants/declare}}
+| {{tl|Legacy variant table row/cargo/legacy variants/attach}}
 |}
-<section end=documentation />
-<includeonly>
+{{Documentation categories|
-[[Category:Templates]]
+<!-- Categories and interwikis go here. -->
-</includeonly>
+[[Category:Item templates]]
+}}