• Welcome to the Kancolle Wiki!
  • If you have any questions regarding site content, account registration, etc., please visit the KanColle Wiki Discord

Difference between revisions of "Template:EquipmentList/doc"

From Kancolle Wiki
Jump to navigation Jump to search
(Added template documentation.)
 
(Upgraded to support filtering for craftable/improvable.)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
==Usage==
 
==Usage==
 
This template takes in one to two arguments.<br>
 
This template takes in one to two arguments.<br>
The first argument determines if the list will display Kanmusu, Abyssal, or all equipment in the table.
+
The first argument determines if the list will display kanmusu, abyssal, or all equipment in the table.
 
To designate the display data, use the following code to invoke the function:<br>
 
To designate the display data, use the following code to invoke the function:<br>
<code><nowiki>{{EquipmentList|<Kanmusu/Abyssal/all>}}</nowiki></code>.<br>
+
<code><nowiki>{{EquipmentList|<kanmusu/abyssal/all>}}</nowiki></code>.<br>
If no argument is passed to the template, Kanmusu is used by default.
+
If no argument is passed to the template, Kanmusu is used by default.<br>
  
The second argument that the template takes filers the table list by specific type of equipment to display.
+
The second argument that the template takes filers the table list.<br>
To designate the display data, use the following code to invoke the function:<br>
+
The equipment list can be filtered by:
<code><nowiki>{{EquipmentList|<Kanmusu/Abyssal/all>|<exact equipment type>}}</nowiki></code>.<br>
+
*<code>craftable</code> - Only list equipment that can be constructed
 +
*<code>improvable</code> - Only list equipment that can be improved
 +
*<code><specific weapon type></code> - Only list equipment of a specific weapon type.<br>
 +
To designate the table filter, use the following code to invoke the function:<br>
 +
<code><nowiki>{{EquipmentList|<kanmusu/abyssal/all>|<craftable/improvable/weapon type>}}</nowiki></code>.<br>
 
If the first argument is not provided, but second is, the template will default to <code>Kanmusu</code>.
 
If the first argument is not provided, but second is, the template will default to <code>Kanmusu</code>.
 
If no argument is passed to the template, no filter is applied.
 
If no argument is passed to the template, no filter is applied.
 +
 +
==See also==
 +
*[[Module:EquipmentModule]] - The module this template invokes from.

Latest revision as of 21:36, 2 June 2017

This template is used to generate an equipment list depending on the provided arguments.

Usage

This template takes in one to two arguments.
The first argument determines if the list will display kanmusu, abyssal, or all equipment in the table. To designate the display data, use the following code to invoke the function:
{{EquipmentList|<kanmusu/abyssal/all>}}.
If no argument is passed to the template, Kanmusu is used by default.

The second argument that the template takes filers the table list.
The equipment list can be filtered by:

  • craftable - Only list equipment that can be constructed
  • improvable - Only list equipment that can be improved
  • <specific weapon type> - Only list equipment of a specific weapon type.

To designate the table filter, use the following code to invoke the function:
{{EquipmentList|<kanmusu/abyssal/all>|<craftable/improvable/weapon type>}}.
If the first argument is not provided, but second is, the template will default to Kanmusu. If no argument is passed to the template, no filter is applied.

See also