Willow: the mass documenting

2026-06-20T11:54:56Z

the mass documenting

@@ Line 1: / Line 1: @@
-This is a basic module for processing args. Usage:
+'''Module:ArgsUtil is a tiny helper that other modules use to collect a template's arguments, merged with any defaults set directly in the {{#invoke:}} call.'''
 <syntaxhighlight lang="lua">
@@ Line 5: / Line 24: @@
 local p = {}
 function p.main(frame)
-   local args = util_args.merge() -- it is not necessary to pass a `frame` object; `merge` will generate its own
+   local args = util_args.merge() -- no need to pass `frame`; merge() finds it
-  mw.logObject(args)
+   -- `args` = invoke defaults overridden by whatever the template was given
 end
 return p
 </syntaxhighlight>
-== Extending this module ==
+For example, {{ml|Template link}} begins with <code>local getArgs = require('Module:ArgsUtil').merge</code> and calls <code>getArgs()</code> in its <code>p.main</code>.
-By design, {{ml|ArgsUtil}} is shipped with only a single function and no customization available; this simplifies documentation and covers nearly all use cases. An extended version of this module is available at [[support:Module:ArgsUtil|Module:ArgsUtil on the support wiki]] if you want additional functionality; and you can of course feel free to modify this module on your own wiki as needed.
+* '''Precedence:''' template (parent) values win over invoke values. (This is the opposite of {{ml|Infobox}}'s internal <code>h.overwrite</code> helper, which deliberately lets the invoke override the template — keep that distinction in mind if you compare the two.)

imported>RheingoldRiver: Adding default set of pages

2024-06-12T08:44:11Z

Adding default set of pages

New page

This is a basic module for processing args. Usage:

<syntaxhighlight lang="lua">
local util_args = require('Module:ArgsUtil')

local p = {}

function p.main(frame)
local args = util_args.merge() -- it is not necessary to pass a `frame` object; `merge` will generate its own
mw.logObject(args)
-- `args` now contains args passed via the template merged with defaults provided directly via the invoke.
-- anything the user sent via the template will be given priority.
end

return p
</syntaxhighlight>

== Extending this module ==

By design, {{ml|ArgsUtil}} is shipped with only a single function and no customization available; this simplifies documentation and covers nearly all use cases. An extended version of this module is available at [[support:Module:ArgsUtil|Module:ArgsUtil on the support wiki]] if you want additional functionality; and you can of course feel free to modify this module on your own wiki as needed.

Module:ArgsUtil/doc - Revision history

Willow: the mass documenting

imported>RheingoldRiver: Adding default set of pages