Template:Set gallery/doc
This is a documentation subpage for Template:Set gallery. It contains usage information, categories and other content that is not part of the original template page. |
This template is meant to be used to generate set galleries, through Module:Set gallery.
Usage
{{Set gallery|region=|set=|abbr=|rarity=|alt=|debug=| }}
Parameters
region
- Optional parameter. Used to pass a region index (e.g.,
EN
,NA
,AE
, etc.). set
- Optional parameter. Used to pass a set name.
abbr
- Optional parameter. Used to pass a set abbreviation code. If this parameter is used, the first part of the row will be interpreted as the card name, instead of as the card number (card numbers won't be displayed). It's overwritten by locally passing an abbreviation (card numbers still won't be displayed).
rarity
- Optional parameter. Used to pass a card rarity value. This rarity would apply to all the entries, unless a specific rarity is passed for the individual entry or for a group of entries. Defaults to Common.
alt
- Optional parameter. Used to pass an
alt
code for the file path. This code would apply to all the entries, unless a specific code is passed for the individual entry.
Building a row
Each gallery entry goes in one row.
Rows are composed of card number; card name; rarity; alt parameter; // options
.
The options part is optional and is separated by inserting //
and then the options keys, separated by ;
. These are:
file::<value>
- Overrides the file path with whatever value is entered here.
extension::<value>
- Uses the value entered here as the extension for the image. Default is PNG (
.png
). name::<value>
- Overrides the card name with whatever value is entered here.
name-local::<value>
- Overrides the localized card name with whatever value is entered here.
description::<value>
- Adds a file description after the standard caption.
Building a group
Groups of rows can be assembled. Ideally, they should be separated by headers (e.g., the "Ultimate Rares" section).
Groups are generated by entering !:
at the beginning of the line, preceding the following options, each separated by ;
:
header::<value>
- Adds a header. The header text is whatever value entered here.
abbr::<value>
- Defines a set abbreviation for all entries in this group, unless a particular one was entered. Just like the use of
abbr
, the first value of the row will be interpreted as the card name and it hides card numbers for this group. rarity::<value>
- Defines a rarity for all entries in this group, unless a particular one was entered.
alt::<value>
- Defines an
alt
code for the files path in this group.
Examples
- Set Card Galleries:Hobby League participation cards (TCG-EN-UE)
- Set Card Galleries:Yu-Gi-Oh! ZEXAL manga promotional cards (OCG-JP)
- Set Card Galleries:Yugi's Legendary Decks (TCG-EN-UE)
Tracking categories
See also
- {{Strategy gallery}}
- {{Set list}}