Template:Property listing/doc

From Fallen London Wiki

Finds a list of relevant pages, creates an expandable list on the page with supporting text description and links. This is in the style of the Category Tree template, but using Semantic Mediawiki data instead. The displayed links use Semantic MediaWiki data to include the following information about each page:

The listed pages will be those linking to the Object page using the Property. The Property may include records or other Property Chains. And additional Property may be displayed by passing it in the Extra parameter.

If the Objects being selected are Records, then Record should be the name of the Record-type property, and Property should be the name of the field of the record. This is only necessary when Extra is a different field of the same record; otherwise, it is simpler to select the page directly by passing a Property Chain to Property.

The Description is required, and should completely the sentence "Look at this list of ___." This text is used in several places, including the anchor text of links, so it should not itself contain links. These uses include:

  • Text next to the expandable link.
  • Inside the expanding list, anchor text next to the "more results" link.
  • Default text for Header, if not provided.

This template will produce one or more links to Category-style pages of the selected links (using {{Property category}}). The header of that page will include Object's icon (via {{Right}}), and the text in Header. This text will default to Description if not provided, but may include links and may be longer.

Finds a list of relevant pages, creates an expandable list on the page with supporting text description and links. This is in the style of the Category Tree template, but using Semantic Mediawiki data instead.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
ObjectObject

The page being linked to. For most uses, this should be the pagename, or a cleaned-up version of it.

Example
Piece of Rostygold
Pagerequired
PropertyProperty

Pages included in the list will use this Property to link to the Object page. Note that this value should not use the "Property:" namespace qualifier.

Example
Gains
Pagerequired
DescriptionDescription

Describes what the pages represent. This text is used in several places. The description should complete the sentence "Look at this list of ___." Used in several places.

Example
actions that give this item
Linerequired
When emptyWhen empty

This text will be displayed if there are no relevant pages. If not set, then nothing will appear on the page.

Linesuggested
HeaderHeader

Text to be displayed above the Category-type page being linked to. May include links, template calls, etc. The page will automatically include the Object's icon, and a dividing line.

Default
Description
Example
actions that give Piece of Rostygold.
Contentsuggested
RecordRecord

If the object being selected is a record, then the name of the record. Only needed when another field of the same record is passed to Extra. Otherwise, simply pass a Property Chain to the Property parameter.

Example
Uses
Pageoptional
ExtraExtra

An additional Property of the page to be displayed in parentheses. If this is a field of a record, then also use the Record field.

Example
Use type
Pageoptional