Template:PropVals/List/doc

From Salem Wiki
Jump to: navigation, search

Description

This template is used to output each entry of a grouped-record under a common group-heading when appropriate, as list-items <li>...</li>.
It is used as a wrapper to inject extra arguments into {{PropVals/Print Entry}}, to output each entry.

Syntax

Type the below code somewhere inside your code: {{PropVals/List}}
It accepts the following parameters:
  • named-parameters:
    • heading
      Optional; Controls the display of a group-heading when provided.
      Defaults to being empty, thus not grouping entries under a group-heading.
    • sep
      Optional; The separator to use for splitting the fields inside the entry by {{PropVals/Print Entry}}.
      Defaults to a dot-colon ';'
    • showamount
      Optional; Controls the display of the amount-field by {{PropVals/Print Entry}}.
      Any value that differs from "no" will make it display the amount-field.
      Defaults to "no".
  • Any amount of entries as unnamed-parameters:
    These unnamed-parameters will be injected into {{PropVals/Print Entry}} one by one. (currently max. 10 supported)
    An entry has the following structure: 'ObjectnamesepAmount'
    Using the default sep that could look like 'Board;10'

Examples

  1. <ul>
    {{PropVals/List|sep=;|showamount=no|Anvil;|Flint;1|Stone;3}}
    {{PropVals/List|sep=;|showamount=y|heading=Startpost|Lime;15|Flint;15|Stone;30}}
    {{PropVals/List|sep=;|showamount=yes|heading=|Board;10|Nails;4}}
    </ul>
    gives: