Template:Variants/doc

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
This is the documentation subpage of Template:Variants. It contains usage information that is not part of the underlying template.
This template uses Lua:
{{Variants
| icon1 = ...
| context1 = ...
| description1 = ...
| notes1 = ...

| icon2 = ...
| icon3 = ...
}}

This template displays a table of alternate in-game icons associated with the current page.

In addition to the table, variants are also represented as SMW subobjects, and each subobject is assigned the semantic properties required for use with {{Game icon}}. This means that the variant icons can be used on other pages, not only the page's primary icon.

Parameters

This template can be used to display an arbitrary number of variants. Parameters are duplicated for each variant, with the N in the parameter name replaced with a number that counts up for each variant. See the examples for additional help. N should start from 1, and variants are displayed in order of N rather than parameter order.

iconN
Icon file used for the variant N. File: namespace part is optional; file extension is required. Sets Property:Has game icon on the variant's subobject.
contextN
Variant identifier used by variant N. This can be any string. This value is used after a # character to invoke the variant icon via {{Game icon}}. Used as the ID of the variant's subobject
descriptionN
In-game description of variant N. Sets Property:Has game description on the variant's subobject.
notesN
Notes for variant N. Does not set any semantic property; only used for display in the table.