Module:TemplateDataGenerator/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 02:55, 23 February 2019

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

Functions for Templates

f

Trigger analysis of template around (base page).

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

Template wrapping

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

<onlyinclude><includeonly>{{#invoke:{{ns:10}}:TemplateDataGenerator|f}}</includeonly></onlyinclude>
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.

Productive usage

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

{{subst:TemplateDataGenerator}}

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.

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

Usage

Template:TemplateDataGenerator

Dependencies

None.

Vorlage:TemplateDataGenerator/en

@@ Line 1: / Line 1: @@
+{{LuaModuleDoc}}
-==Basic usage==
+<onlyinclude>'''<code>{{ns:10}}:TemplateDataGenerator</code>''' – Module for generation of a skeleton for TemplateData from the parameter usage within template programming.
+== {{Anker|{{ns:10}}}} Functions for Templates ==
+; f
+: Trigger analysis of template around (base page).
+:* No parameters on <code>#invoke</code>.
+:* Yields block to be inserted by copy&paste.
+=== Template wrapping ===
-Include:
+The module is supposed to be wrapped for convenience into something like a template
-<pre>{{subst:#invoke:TemplateDataGenerator|f}}</pre>
+ <nowiki><onlyinclude><includeonly>{{#invoke:{{ns:10}}:TemplateDataGenerator|f}}</includeonly></onlyinclude></nowiki>
-in the template's documentation page. Save and edit again to fill in details.
+ 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 ===
-==Further details==
+When editing a template (documentation) page, users are supposed to insert the following line, where TemplateData shall appear:
+ <code><nowiki>{{subst:TemplateDataGenerator}}</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.
-*[[:de:Wikipedia:Lua/Modul/Vorlage:TemplateDataGenerator/en]]
+== {{Anker|Lua}} Functions for Lua modules ==
-<includeonly>
+; getBlock( about, ahead, alphabetical )
-[[Category:VisualEditor]]
+: Trigger analysis of template like '''f''' but from Lua call.
-[[Category:Templates using TemplateData‎]]
+:* ''about'' – string; page title related to template code on base page
-</includeonly>
+:* ''ahead'' – string, number or nil; namespace (Template:)
+:* ''alphabetical'' – boolean or nil; sort parameter list
+== Usage ==
+* [[{{ns:10}}:TemplateDataGenerator]]
+== Dependencies ==
+None.
+[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|Vorlage:TemplateDataGenerator/en]]