Module:Template wrapper/doc

Usage

{{#invoke:Template wrapper|wrap|_template=working template|_exclude=named parameter, named parameter, ...|_include-positional=}}

This module is to be used in wrapper templates to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.

This module requires one parameter: |_template=, the name (without namespace) of the working template (the template that is wrapped).

When writing a wrapper template, give this module all of the normally required default parameters necessary to use the template in its base form. Editors then use the wrapper template as is or may supply additional parameters. Any of the normal parameters supported by the working template may be added to the wrapper template or supplied by editors in article space. When an editor supplies a parameter that has a default value in the wrapper template, the editor-supplied value overrides the default. When it is necessary to remove a default parameter, editors may set the parameter value to the special keyword unset which will cause this wrapper module to erase the wrapper template's default value for that parameter. This module discards empty named parameters.

Positional parameter are not normally passed on to the working template. Setting |_include-positional=yes will pass all positional parameters to the working template. Positional parameters are not excludable; positional parameter may be unset.

Parameters that are used only by the wrapper should be either positional ({{{n}}}) or listed in |_exclude= (a comma-separated list of named parameters). This module will not pass _excluded parameters to the working template.