Module:Template wrapper/doc
 | This is a documentation subpage for Module:Template wrapper. It may contain usage information, categories and other content that is not part of the original module page. |
 | It is requested that the deleted page history of Module:Citation/CS1/Wrapper/doc be restored and merged into the history of this page. This action must be performed by an administrator or importer (compare pages).
Consider placing Administrators: Before merging the page histories, read the instructions at Wikipedia:How to fix cut-and-paste moves carefully. An incorrect history merge is very difficult to undo. Also check Wikipedia:Requests for history merge for possible explanation of complex cases. |
Usage
{{#invoke:Template wrapper|wrap|_template=wrapped template|_exclude=named parameter, named parameter, ...}}
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 template.
This module requires one parameter: |_template=, the name (without namespace) of 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 wrapped 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 parameters.
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 these types of parameters to the wrapped template.