Module:Icon/keys/doc
From ARC Raiders Wiki
More actions
< Module:Icon | keys
This is the documentation page for Module:Icon/keys
Renders a reference table of all keys and icons for a named dataset. Used in template documentation pages to list the valid keys accepted by a wrapper template, alongside the icon each key resolves to and its source filename.
Template documentation pages invoke this module directly:
{{#invoke:Icon/keys|main|dataset=<dataset>}}
The output is a wikitable with three columns: the rendered icon, the key name, and the source filename. Keys are sorted alphabetically. Entries missing an icon field are silently skipped.
Arguments
dataset(required): name of the dataset atModule:Icon/data/<dataset>. Lowercased before resolution; callers may pass the name in any case.
Errors
Raises an error when:
- No
datasetis supplied. - The named dataset does not exist.
All errors are caught by Keys.main, rendered as an inline <span class="error">, and tracked via Category:Pages with icon errors.
See also
- Module:Icon: the icon engine; handles rendering and index resolution.
- Module:Icon/data: dataset documentation for the icon system.
- Module:Icon/index: maps icon filenames to their respective datasets.