Module:Dok/doc

The documentation of templates is as much automated as possible with the module Dok.

The template itself is generally hidden and is shown only on including pages. With this module this approach is no restriction because the documentation shows the outcome of the template along with other things.

The documentation module standardizes the documentation, so every template documentation looks similar and it is easier to understand the effects of the template.

The first item is a description of the template, what it does, when it should be used etc. Next is a list with the parameters, description, effects and default values. The list has to be entered manually, there is no easier way to do that. The next section is a copy&paste section with a list of the template with all parameters described in the list before.

The documentation shows the effects of the templates with arbitrary parameters, this part is updated automated when the templated is edited. The default values of the templates should be chosen that the outcome makes sense when no parameter value is entered. The template can be optional expanded as wikitext and rendered optional.

The next thing the documentation shows is the source code of the template, so you do not have to edit the template in order to look into the source.

A list of all subpages and usage of the template is provided.

This documentation does not need additional templates, two icons are necessary   and