Editing Module:TemplateDataGenerator/doc

'''<code>Module:TemplateDataGenerator</code>''' – Module for generation of a skeleton for TemplateData from the parameter usage within template programming.
	
== From wikitext ==
; f
: Trigger analysis of template around (base page).
:* No parameters on <code>#invoke</code>.
:* Yields block to be inserted by copy&paste.

=== Template wrapping ===
The module is supposed to be wrapped for convenience into something like a template
 <nowiki>{{#invoke:TemplateDataGenerator|f}}</nowiki>
 Documentation
That template may be transcluded with one parameter: '''sort''' alias&nbsp;'''1'''&nbsp;– if that is provided with the value <code>1</code>, parameter list will be sorted in alphabetical order.

=== Productive usage ===
When editing a template (documentation) page, users are supposed to insert the following line, where TemplateData shall appear:
 <code><nowiki>{{subst:#invoke:TemplateDataGenerator|f}}</nowiki></code>
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, <code>subst</code> comes into effect and the plain lines are stored into source text. Next time someone will do the cleanup.

== Functions for Lua modules ==
; 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