Difference between revisions of "Template:PropVals/List/doc"
From Salem Wiki
< Template:PropVals | List
(Initial setup) |
m (adding documentation) |
||
Line 1: | Line 1: | ||
==Description== | ==Description== | ||
− | :This template is used to. | + | :This template is used to output each '''''entry''''' of a '''''grouped-record''''' under a common group-heading when appropriate, as list-items <code><nowiki><li>...</li></nowiki></code>. |
− | + | :It is used as a wrapper to inject extra arguments into {{t|PropVals/Print Entry}}, to output each '''''entry'''''. | |
− | : | ||
− | |||
==Syntax== | ==Syntax== | ||
− | :Type the below code somewhere | + | :Type the below code somewhere inside your code: <code><nowiki>{{PropVals/List}}</nowiki></code> |
− | < | + | :It accepts the following parameters: |
+ | :*named-parameters: | ||
+ | :**'''heading''' | ||
+ | :**:Optional; Controls the display of a <nowiki>group-heading</nowiki> 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 {{t|PropVals/Print Entry}}. | ||
+ | :**:Defaults to a dot-colon '''';'''' | ||
+ | :**'''showamount''' | ||
+ | :**:Optional; Controls the display of the amount-field by {{t|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 {{t|PropVals/Print Entry}} one by one. (currently max. 10 supported) | ||
+ | :*:An entry has the following structure: '<nowiki/>''Objectname'''''sep'''''Amount''<nowiki/>' | ||
+ | :*:Using the default '''sep''' that could look like 'Board;10' | ||
==Examples== | ==Examples== | ||
# | # |
Revision as of 16:04, 26 June 2012
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".
- heading
- 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'
- named-parameters: