Template:World Quality Highlight/doc

From Fallen London Wiki

Highlights or emphasises text based on the current value of one or more World Qualities.

Text given as the first argument will always be displayed, with conditional styling. The type of styling is supplied in the second argument, or as the Type parameter. To conditionally display/hide content rather than styling it, see {{World Quality Condition}}. Valid highlight types:

Bold (default)
Valid type parameters: Bold, bold, or b.
Text will be bolded when the World Qualities are appropriate.
Mark
Valid type parameters: Mark, mark, or m.
Text will be highlighted as if by a giant neon marker.
Table Cell
Value type parameters: Cell, cell, or c.
For use in tables only. Will apply the c"fl-cell-highlighted" class. Must be the first (or only) text in the relevant cell.

World Quality key-value pairs are passed as one or more arguments of the form "When [Quality] = [Value]." The [Quality] parameter must be the name of a World Quality. The [Value] parameter is a value, or list of values, that should cause the text to be highlighted.

Examples

{{World Quality Highlight|Bug Week|When Zoological Mania: = Insects}}
On regular weeks, will display as: Bug Week.
For the correct zoological manias, will display as: Bug Week.
{{World Quality Highlight|Runny Moon|Type=mark|When Phase of the Rat-Moon: = Runny}}
On regular weeks, will display as: Runny Moon.
For the correct moon phases, will display as: Runny Moon.

Highlights text based on the current value of one more World Qualities.

Template parameters

ParameterDescriptionTypeStatus
Text1

The text to display, which will be conditionally highlighted.

Example
Insects
Contentrequired
Highlight TypeType 2

The type of emphasis to be applied. Valid values are Bold, Mark, or Cell.

Default
Bold
Example
Mark
Lineoptional
World QualityWhen [Quality]

Matched pairs of "When [Quality] = [Value]." Highlighting is applied when all [Quality] have their current value as the corresponding [Value]. Uses substring matching, so [Value] may be a list of possible values.

Example
When Zoological Mania: = Insect
Unknownrequired