Module:TemplateDataGenerator/doc

Module:TemplateDataGenerator – Module for generation of a skeleton for TemplateData from the parameter usage within template programming.

f

Trigger analysis of template around (base page).

• No parameters on #invoke.
• Yields block to be inserted by copy&paste.

The module is supposed to be wrapped for convenience into something like a template

{{#invoke:TemplateDataGenerator|f}}
Documentation

That template may be transcluded with one parameter: sort alias 1 – if that is provided with the value 1, parameter list will be sorted in alphabetical order.

When editing a template (documentation) page, users are supposed to insert the following line, where TemplateData shall appear:

{{subst:#invoke:TemplateDataGenerator|f}}

After click on [Preview], the generated lines are displayed and can be inserted by copy & paste to replace the temporary transclusion.

If forgotten to remove on saving, subst comes into effect and the plain lines are stored into source text. Next time someone will do the cleanup.

getBlock( about, ahead, alphabetical )

Trigger analysis of template like f but from Lua call.

• about – string; page title related to template code on base page
• ahead – string, number or nil; namespace (Template:)
• alphabetical – boolean or nil; sort parameter list