User:Lily/Template documentation

Seitenanfang This is the documentation for the Module Template documentation The module Template documentation provides a documentation for templates that is compact, transparent, flexible and always up-to-date. The documentation is included from a subpage and is structured in the way as described following.

Header
The header provides links to the subpage and the template itself for editing, history, page infos and refresh page. A short description should follow, what is the purpose, what are the requirements, which namespace to use...

Parameter list
A list of an arbitrary numbers of parameters can be entered and is displayed as table.

Copy&paste
By entering the parameter list a text for copy&paste for usage in the transcluding page is triggered.

Usage examples
Per default the application of the template with parameter default values is shown. It is always a good idea to provide good default values for all parameters if possible. The template is expanded and the wikitext is displayed, alongside with the result of the transclution of the template. This behaviour can be suppressed by parameters.

Up to ten different application cases can displayed on the page, the cases are entered as aw1=parm1=;parm2=;parm3=... The separation character can be changed in case it is part of one of the parameters. The expanded and rendered wikitext is displayed.

Wikitext
The raw text of the template is displayed using the lua function  mw.text.nowiki(titel:getContent)

Subpages
A list of the existing subpages of the template is provided. Above this section links to template usage and documentation subpage are displayed.