Module:GetParameters/doc
This is the documentation page for Module:GetParameters
This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
Usage
[mali mi di yibu sheena n-niŋ]getParameters
[mali mi di yibu sheena n-niŋ]Takes 2 required arguments, frame_args
and arg_list
. Parses a frame's arguments, returning either the provided named arguments in arg_list
if found or the positional parameters instead if not. This is designed to work around the stripping of values that takes place for defined parameters which could be important.
As an example, the calls getParameters({"a", "b", "c"}, {"x", "y"})
and getParameters({x="a", y="b", z="c"}, {"x", "y"})
would both give back {x="a", y="b"}
.
getBoolean
[mali mi di yibu sheena n-niŋ]Takes 1 required argument boolean_str
. Turns the input into a true/false boolean value based on the input. Will error if given anything other than a string or boolean value.
defined
[mali mi di yibu sheena n-niŋ]To be invoked from inside a template instead of a module. Determines if a certain parameter is defined in the parent frame's arguments.