Jump to content

Module:Template parameter value/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
{{high risk}}
Move from template doc page
Line 3: Line 3:
Implements {{tl|Template parameter value}}
Implements {{tl|Template parameter value}}


== Module usage ==
Testcases available at [[Module talk:Template parameter value/testcases]]
The module can be used directly for other modules through the function <code>getValue(page, templates, parameters, options)</code>, which will return a success boolean and either the resulting parameter value or why it failed.

<code>page</code>, <code>templates</code>, and <code>parameters</code> are all required arguments. <code>options</code> is an optional table which can have the parameters <code>template_index</code>, <code>parameter_index</code>, <code>ignore_subtemplates</code>, <code>only_subtemplates</code>, and <code>ignore_blank</code>. More info on what these parameters do can be found in the template's [[Template:Template parameter value#Template data|template data]].

== Testcases ==
Testcases are available at [[Module talk:Template parameter value/testcases]]

Revision as of 12:01, 3 May 2023

Implements {{Template parameter value}}

Module usage

The module can be used directly for other modules through the function getValue(page, templates, parameters, options), which will return a success boolean and either the resulting parameter value or why it failed.

page, templates, and parameters are all required arguments. options is an optional table which can have the parameters template_index, parameter_index, ignore_subtemplates, only_subtemplates, and ignore_blank. More info on what these parameters do can be found in the template's template data.

Testcases

Testcases are available at Module talk:Template parameter value/testcases