Module:Template parameter value/doc
![]() | 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. |
![]() | This Lua module is used on approximately 10,800,000 pages, or roughly 18% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
![]() | This module depends on the following other modules: |
Implements {{Template parameter value}} and {{HasTemplate}}, and can be used from other modules.
Module functions
[edit]getParameter
[edit]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_subtemplates
is 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
[edit]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
options from getParameter.
Helper functions
[edit]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
[edit]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
[edit]Testcases are available at Module talk:Template parameter value/testcases