Template:Card List/doc: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{Documentation/Header}} {{Lua}} Creates a list of {{T|Card}}. ==Syntax== * {{F|1}} — List of items. ** {{F|*((amount))}} — Indicate amount exclusive to the item. ** {{F|/((note))}} — Indicate note exclusive to the item (currently does nothing) ** {{F|!((rank))}} — Set the rank for this item where {{F|((rank))}} is one of <code>C</code>, <code>B</code>, <code>A</code>, <code>S</code> *** So <code>!S</code> is a shorter way of doing <code>{rank: S..." |
No edit summary |
||
| Line 7: | Line 7: | ||
** {{F|*((amount))}} — Indicate amount exclusive to the item. | ** {{F|*((amount))}} — Indicate amount exclusive to the item. | ||
** {{F|/((note))}} — Indicate note exclusive to the item (currently does nothing) | ** {{F|/((note))}} — Indicate note exclusive to the item (currently does nothing) | ||
** {{F|!((flag))}} — Add a parameter exclusive to the item (where the parameter's value will be set to <code>1</code>) | ** {{F|!((flag))}} — Add a parameter exclusive to the item (where the parameter's value will be set to <code>1</code>) | ||
** {{F|1={((param1)): ((value1)), ((param2)): ((value2)), ((value 3))} }} — indicate parameters exclusive to the item, allows unnamed parameters. | ** {{F|1={((param1)): ((value1)), ((param2)): ((value2)), ((value 3))} }} — indicate parameters exclusive to the item, allows unnamed parameters. | ||
Latest revision as of 13:01, 11 June 2025
This is the documentation page for Card List. It contains usage information, categories, and other content not part of the original template page. | ||
|---|---|---|
| Main | Documentation | Usage |
This template uses Module:Card List, a script written in Lua.
Creates a list of {{Card}}.
Syntax
- 1 — List of items.
- *amount — Indicate amount exclusive to the item.
- /note — Indicate note exclusive to the item (currently does nothing)
- !flag — Add a parameter exclusive to the item (where the parameter's value will be set to
1) - {param1: value1, param2: value2, value 3} — indicate parameters exclusive to the item, allows unnamed parameters.
- Both commas and dollar signs can be used to separate parameters. The delimeter can be changed with the param_delim parameter.
- Default values
- amount — Default amount of items if not stated. Default none.
- Delimiters
- delim — Delimiter of the list in 1. Default ;.
- amount_delim — Delimiter of amount in 1. Default *.
- note_delim — Delimiter of the notes in 1. Default /.
- param_delim — Delimiter of the parameters in 1. Default {',', '$'}.
- The following arguments of {{Card}} can be set to apply to all items by including them as normal parameters.
Examples
{{Card List|Satchel*50;Satchel*50}}
50
50
Template Data
Creates a list of {{Card}}.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Input List | 1 | "delim" delimited list of items. Within each item, delimited by "amount_delim", "note_delim", and "param_delim". | String | required |
| Default Amount | amount | Default amount of items if not stated.
| Number | optional |
| Input Delimiter | delim | Character(s) to split input items by.
| String | optional |
| Amount Delimiter | amount_delim | Character(s) to separate item name from amount.
| String | optional |
| Note Delimiter | note_delim | Character(s) to separate item from note.
| String | optional |
| Parameter Delimiter | param_delim | Character(s) to split item from Card parameters.
| String | optional |
| Show Caption | show_caption | Set to 1 to show caption. | Boolean | suggested |