Template:GuideFor/doc

From Fallen London Wiki

This template should be placed on Guides, and will cause content elsewhere on the Wiki to link to that guide with {{HasGuide}}. Arguments passed to the template will identify which Wiki pages should have those guide links added.

The arguments are used to construct a Semantic Mediawiki query for pages of interest. The guide will then link to those pages with the Property:Is guide for Property, which is inspected by common templates such as {{Item}}, {{Action}}, etc.

Usage notes[edit]

  • This template may be used several times if a guide covers multiple swathes of content. It is OK if the same page is identified by multiple queries.
  • Some queries may not cover all edge cases. It may be simpler to manually add links using to use the Pages parameter. Use '#' (number sign) to separate pages within this parameter if needed.
  • You need not cover every relevant property. More links is better, but something is better than nothing!

Identifying pages[edit]

Many guides cover content in a single location, or sometimes even actions in a single storylet. Use the Location or Storylet arguments to identify the associated actions, storylets, or cards. In some cases, the relevant tracking qualities can be identified from a "clean-up" action which clears them. If so, pass the name of this action in the Cleanup argument.

If small, disconnected amounts of links are needed, or if a few pages are not easily covered by other means, they can also be added manually, using the Pages parameter.

More complex pieces of content may need more complex logic. The unnamed first argument may contain arbitrary SMW selection logic. Alternatively, the Category parameter may contain either a Category or smw:Concept page for the relevant content. Concept or Category pages should include their namespace. Concept pages are recommended for extremely complex pieces of content, and due to query complexity restrictions, may be the only way of representing some content.

All queries are implicitly restricted to the Main namespace.

Sets the Semantic MediaWiki property "Is guide for" identifying the content covered by a guide. The covered content will automatically link to the guide where this template is placed.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
LocationLocation

The name of the Location covered by the guide.

Example
Far Beyond the Cordon
Pageoptional
StoryletStorylet

The name of the Storylet covered by the guide.

Example
A Kitchen for Artists
Pageoptional
Cleanup ActionCleanup

The "Cleanup" action for content covered by this guide, which identifies relevant qualities or items.

Example
Tidy up
Pageoptional
CategoryCategory Concept

The Category or SMW Concept page identifying the covered content. Not always updated immediately.

Example
Concept:A Trade in Reputations
Pageoptional
PagesPages

The name(s) of the (additional) pages covered by the guide. Use ‘#’ (number sign) to separate the pages should there be more than one.

Example
Call it to mind#Shard of Glim
Pageoptional
No PagesNoPages

The name(s) of the page(s) to be excluded from the given concept/category. Use ‘#’ (number sign) to separate the pages should there be more than one. Only works when the Category or Concept parameter is used!

Example
Taking dinner alone#Aeolian Scream
Pageoptional
Query1

Arbitrary SMW selection query for covered pages.

Example
[[Equips in slot::Companion]][[Has effect::?;<0]]
Stringoptional