Module:Template parameter value/doc: Difference between revisions
More actions
Created page with "{{documentation subpage}} {{lua|Module:Wikitext Parsing}} Implements {{tl|Template parameter value}} and {{tl|HasTemplate}}, and can be used from other modules. == Module functions == === getParameter === getParameter takes 4 arguments: The page name (string), the template/s (string or table of strings), the parameter (string), and an optional options table. It will return either <code>true</code> and the contents of the requested parameter or <code>false</code> and a r..." |
No edit summary |
||
| Line 30: | Line 30: | ||
== Testcases == | == Testcases == | ||
Testcases are available at [[Module talk:Template parameter value/testcases]] | Testcases are available at [[Module talk:Template parameter value/testcases]] | ||
<includeonly> | |||
[[Category:Modules]] | |||
</includeonly> | |||
<noinclude> | |||
[[Category:Module documentation pages]] | |||
</noinclude> | |||
Revision as of 04:41, 2 March 2025
 | This is a documentation subpage for Module:Template parameter value. It may contain usage information, categories and other content that is not part of the original module page. |
 | Uses Lua: |
Implements {{Template parameter value}} and {{HasTemplate}}, and can be used from other modules.
Module functions
getParameter
getParameter takes 4 arguments: The page name (string), the template/s (string or table of strings), the parameter (string), and an optional options table. It will return either true and the contents of the requested parameter or false and a reason for failure.
The following options are available:
- template_index: Which occurance of the template to look for the parameter in (default: 1)
- parameter_index: Which occurance of the parameter to look for (default: 1; only applies when
ignore_subtemplatesis false) - ignore_subtemplates: If parameters should only be searched for in the top-level template, ignoring the parameters in subtemplates (default: false)
- only_subtemplates: If parameters should only be searched for in subtemplates of the top-level template (default: false)
- ignore_blank: Whether or not blank values should count towards
parameter_index(default: false) - treat_as_regex: Whether or not the template string(s) should be treated as a lua regex (default: false)
getTemplate
getTemplate takes 3 arguments: The page name (string), the template/s (string or table of strings), and an optional options table. It will return either true and the text of the requested template or false and a reason for failure.
getTemplate supports the options template_index and treat_as_regex from getParameter.
Helper functions
The module exposes some of the helper functions used (matchAllTemplates, getParameters, and getAllParameters) for convenience. Each function has some comments above it in the code explaining its rough purpose.
Template functions
main implements {{Template parameter value}} and acts as a template wrapper for getParameter.
hasTemplate implements {{HasTemplate}} and somewhat acts as a wrapper for getTemplate (it only provides if the template was found, not the template text itself).
Testcases
Testcases are available at Module talk:Template parameter value/testcases