Template:Unlock/doc

From Fallen London Wiki (Staging)

This template is for the in-line inclusion of qualities on pages where the quality is used for locking or unlocking storylets/branches.

In addition to formatting the quality to display with an image and a link, correct categories are also added to the page.

This template uses the same arguments as {{IL}} - please refer to that page for detailed documentation.

  • {{Unlock|Shard of Glim}} - This adds the normal category for the quality. This is equivalent to {{IL|Shard of Glim}}{{Noembed|[[Category:Shard of Glim]]}}.

This template is for the in-line inclusion of qualities on pages where the quality is used for locking or unlocking storylets/branches. In addition to formatting the quality to display with an image and a link, correct categories are also added to the page.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Quality name1

The name of the quality being linked used.

Example
Shard of Glim
Pagerequired
Quantity2

If present, the quantity will be unlinked, in-between the image icon and the quality link.

Example
30 x
Lineoptional
Image file nameImage

The filename of the image used to decorate the link.

Default
The image name is looked up in the mapping in Module:IL/images. If not present, displays question.png.
Example
Door.png
Fileoptional
Image sizeSize

The size of the displayed image.

Default
20px
Example
30px
Stringoptional
Image linkLink

If present, the image will link to the specified page rather than the quality.

Default
If this parameter is not present, the image will link to the quality name.
Example
File:Bloodhand.png
Pageoptional
Link appearanceAppearance

If present, will change the anchor text of the link.

Default
If this parameter is not present, then the anchor text will be the quality name.
Example
''Sneaky''
Lineoptional
ShortShort

If present, will shorten the default anchor text by removing everything before the first colon. Overridden by the Appearance parameter.

Example
yes
Lineoptional
Hiddenhidden

Set to yes if the requirement is not displayed. If yes, will invoke Template:Hidden

Example
yes
Unknownoptional