Module:Emotes/doc
Jump to navigation
Jump to search
This is the documentation page for Module:Emotes
Module:Emotes
Renders a sortable wikitable of emotes defined in Module:Emotes/data with translatable display strings from MessageBundle:Emotes and other relevant MessageBundles.
This module provides the following function(s):
list- renders all emotes, or a subset filtered by source, as a wikitable.
Usage
List all emotes
By default, all emotes are shown, sorted by display name.
{{#invoke:Emotes|list}}
Filter by source
A source name can be provided to show only emotes matching that source. The Source column is omitted from the output, since it would be redundant once filtered.
{{#invoke:Emotes|list|Lost Harvest}}
Emotes that are available by default (Emotes:default in the dataset) are filtered the same way:
{{#invoke:Emotes|list|Default}}
The filter value is slugified before matching, so it does not need to exactly match the casing/formatting used in Module:Emotes/data.
Parameters
list
- 1 (optional)
- string
- Source name to filter by. Slugified before matching against the
sourcetoken's slug half in Module:Emotes/data. - Returns an error message if no emotes match.
Notes
list
- Display strings (name and description) are resolved via MessageBundle:Emotes using the page's current language, keyed by each emote's
id(as<ID>-nameand<ID>-description). - Column headers are also resolved via MessageBundle:Emotes (as label-icon, label-name, label-description, label-source).
- Source values are rendered as wikilinks to their English-titled page, except
Emotes:default, which is shown as plain text since it has no corresponding page.