Difference between revisions of "Template:PropVals/doc"
From Salem Wiki
m (→Syntax: adding showamount, yes i still need to list parameters that can be used.....) |
m (→Functional logic: fixed amount display...) |
||
| Line 17: | Line 17: | ||
*{{t|PropVals}} is used as a wrapper to inject extra arguments into {{t|PropVals/List}}, using the output of {{t|PropVals/getGroupedRecords}}. | *{{t|PropVals}} is used as a wrapper to inject extra arguments into {{t|PropVals/List}}, using the output of {{t|PropVals/getGroupedRecords}}. | ||
*#{{t|PropVals/List}} is used as a wrapper to inject extra arguments into {{t|PropVals/Print Entry}}, to output each '''''entry''''' of a '''''grouped-record''''' under a common group-heading when appropriate, as list-items <code><nowiki><li>...</li></nowiki></code>. | *#{{t|PropVals/List}} is used as a wrapper to inject extra arguments into {{t|PropVals/Print Entry}}, to output each '''''entry''''' of a '''''grouped-record''''' under a common group-heading when appropriate, as list-items <code><nowiki><li>...</li></nowiki></code>. | ||
| − | *#*{{t|PropVals/Print Entry}} is used to display each '''''entry''''' in a visually appealing way, by outputting an icon-image followed by a link to the page of the object followed by the amount. | + | *#*{{t|PropVals/Print Entry}} is used to display each '''''entry''''' in a visually appealing way, by outputting an icon-image followed by a link to the page of the object followed by the amount when requested. |
*#*:It uses {{t|PropVals/Split}} to extract the name- and amount-fields from the '''''entry'''''. | *#*:It uses {{t|PropVals/Split}} to extract the name- and amount-fields from the '''''entry'''''. | ||
| − | |||
*#{{t|PropVals/getGroupedRecords}} is used as a wrapper to inject extra arguments into {{t|PropVals/Group}}, using the output of {{t|PropVals/getRecords}} as input, to output '''''grouped-records''''', for further processing by {{t|PropVals}}. | *#{{t|PropVals/getGroupedRecords}} is used as a wrapper to inject extra arguments into {{t|PropVals/Group}}, using the output of {{t|PropVals/getRecords}} as input, to output '''''grouped-records''''', for further processing by {{t|PropVals}}. | ||
*##{{t|PropVals/Group}} is used as a wrapper to inject extra arguments into {{t|PropVals/Group/NextPart}}, using '''''records''''' as input, to output '''''grouped-records'''''. | *##{{t|PropVals/Group}} is used as a wrapper to inject extra arguments into {{t|PropVals/Group/NextPart}}, using '''''records''''' as input, to output '''''grouped-records'''''. | ||
| Line 25: | Line 24: | ||
*##*:It uses {{t|PropVals/Split}} to separate the ''group-heading'' (heading-field), from the ''Objectname'' and ''Amount'' in the '''''record'''''. | *##*:It uses {{t|PropVals/Split}} to separate the ''group-heading'' (heading-field), from the ''Objectname'' and ''Amount'' in the '''''record'''''. | ||
*##{{t|PropVals/getRecords}} is used to retrieve all the values of a property of a page, and output them as '''''records''''' for further processing by {{t|PropVals/getGroupedRecords}}. | *##{{t|PropVals/getRecords}} is used to retrieve all the values of a property of a page, and output them as '''''records''''' for further processing by {{t|PropVals/getGroupedRecords}}. | ||
| + | |||
==Syntax== | ==Syntax== | ||
:Type the below code somewhere inside {{t|Infobox}} or a page: | :Type the below code somewhere inside {{t|Infobox}} or a page: | ||
Revision as of 11:47, 26 June 2012
Description
- This is the main-entry-point of a complex template-class
- It is used to automatically list all the values of a property of a page as an un-ordered list.
- This generated-output will be used in {{Infobox}} to automatically show relevant info.
- See these pages for documentation on functions used:
- Other pages with relevant info are:
Functional logic
- {{PropVals}} is used as a wrapper to inject extra arguments into {{PropVals/List}}, using the output of {{PropVals/getGroupedRecords}}.
- {{PropVals/List}} is used as a wrapper to inject extra arguments into {{PropVals/Print Entry}}, to output each entry of a grouped-record under a common group-heading when appropriate, as list-items
<li>...</li>.- {{PropVals/Print Entry}} is used to display each entry in a visually appealing way, by outputting an icon-image followed by a link to the page of the object followed by the amount when requested.
- It uses {{PropVals/Split}} to extract the name- and amount-fields from the entry.
- {{PropVals/Print Entry}} is used to display each entry in a visually appealing way, by outputting an icon-image followed by a link to the page of the object followed by the amount when requested.
- {{PropVals/getGroupedRecords}} is used as a wrapper to inject extra arguments into {{PropVals/Group}}, using the output of {{PropVals/getRecords}} as input, to output grouped-records, for further processing by {{PropVals}}.
- {{PropVals/Group}} is used as a wrapper to inject extra arguments into {{PropVals/Group/NextPart}}, using records as input, to output grouped-records.
- {{PropVals/Group/NextPart}} is used as a helper-template, to output a grouped-record that starts with the group-heading followed by entries, with their heading-field removed, that have the same heading-field as the previous entry.
- It uses {{PropVals/Split}} to separate the group-heading (heading-field), from the Objectname and Amount in the record.
- {{PropVals/Group/NextPart}} is used as a helper-template, to output a grouped-record that starts with the group-heading followed by entries, with their heading-field removed, that have the same heading-field as the previous entry.
- {{PropVals/getRecords}} is used to retrieve all the values of a property of a page, and output them as records for further processing by {{PropVals/getGroupedRecords}}.
- {{PropVals/Group}} is used as a wrapper to inject extra arguments into {{PropVals/Group/NextPart}}, using records as input, to output grouped-records.
- {{PropVals/List}} is used as a wrapper to inject extra arguments into {{PropVals/Print Entry}}, to output each entry of a grouped-record under a common group-heading when appropriate, as list-items
Syntax
- Type the below code somewhere inside {{Infobox}} or a page:
{{PropVals |prop=RequiresObj |page={{FULLPAGENAME}} |sep={{{sep|;}}} |grpsep={{{grpsep|/\}}} |showamount={{{showamount|no}}} }}
Examples
- {{PropVals|prop=RequiresObj|page=User:©TriMoon™/PropVals testdata|showamount=y}} gives:
- {{PropVals|prop=RequiresObj|page=User:©TriMoon™/PropVals testdata|showamount=y|debug=y}} gives:
Sub-templates
- Test data used in examples: PropVals testdata
- {{PropVals/Group}}
- {{PropVals/Group/NextPart}}
- {{PropVals/Group/heading}}
- {{PropVals/List}}
- {{PropVals/Print Entry}}
- {{PropVals/Split}}
- {{PropVals/getGroupedRecords}}
- {{PropVals/getRecords}}
