Difference between revisions of "Template:PropVals/getRecords/doc"

From Salem Wiki
Jump to: navigation, search
m (adding documentation)
m (Protected "Template:PropVals/getRecords/doc": Documentation of key-feature ([edit=sysop] (indefinite) [move=sysop] (indefinite)))
 
(One intermediate revision by the same user not shown)
Line 18: Line 18:
 
:*:Optional; The <u>name</u> of the page to consult the property from.
 
:*:Optional; The <u>name</u> of the page to consult the property from.
 
==Examples==
 
==Examples==
#{{t|PropVals/getRecords|prop<nowiki>=</nowiki>RequiresObj|page<nowiki>=</nowiki>Stone Hedge }} gives:<br/>{{PropVals/getRecords|prop=RequiresObj|page=Stone Hedge}}
+
#{{t|PropVals/getRecords|prop<nowiki>=</nowiki>RequiresObj|page<nowiki>=</nowiki>User:©TriMoon™/PropVals testdata }} gives:<br/>{{PropVals/getRecords|prop=RequiresObj|page=User:©TriMoon™/PropVals testdata}}
 
<includeonly>[[Category:Templates|{{PAGENAME}}]]<!-- Any categories for the template itself -->
 
<includeonly>[[Category:Templates|{{PAGENAME}}]]<!-- Any categories for the template itself -->
 
[[Category:Templates/©TriMoon™|{{SUBPAGENAME}}]]
 
[[Category:Templates/©TriMoon™|{{SUBPAGENAME}}]]
 
</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 18:16, 25 July 2012

Description

This template is used to retrieve all records for the property of the page asked for, using an SMW-inline-query.
{{PropVals/getGroupedRecords}} will use the generated-output of this template to inject extra arguments into {{PropVals/Group}}.
See these pages for documentation on functions used:

Syntax

Type the below code somewhere in your code:
{{PropVals/getRecords
|prop={{{prop|RequiresObj}}}
|page={{{page|{{FULLPAGENAME}} }}}
}}
It accepts 2-named parameters to control the SMW-Query:
  • prop
    Mandatory; The name of the property to retrieve.
  • page
    Optional; The name of the page to consult the property from.

Examples

  1. {{PropVals/getRecords|prop=RequiresObj|page=User:©TriMoon™/PropVals testdata }} gives: