Editing Module:Template wrapper/doc (section)

== Usage ==

<code><nowiki>{{#invoke:</nowiki>{{BASEPAGENAME}}|wrap|_template={{var|working template}}|_exclude={{var|named parameter}}, {{var|named parameter}}, ...|_reuse={{var|named parameter}}, {{var|named parameter}}, ...|_alias-map={{var|alias parameter}}:{{var|canonical parameter}}|_include-positional=yes|&lt;{{var|default parameter}}>|&lt;{{var|default parameter}}>|...}}</code>

;Control parameters
:{{para|_template}} – (required) the name, without namespace, of the working template (the template that is wrapped); see §[[#template|_template]] below
:{{para|_exclude}} – comma-separated list of parameter names used by the wrapper template that are not to be passed to the working template; see §[[#exclude|_exclude]] below
:{{para|_reuse}} – comma-separated list of canonical names that have meaning to both the wrapper template and to the working template; see §[[#reuse|_reuse]] below
:{{para|_alias-map}} – comma-separated list of wrapper-template parameter names that are to be treated as aliases of specified working template canonical parameters; see §[[#alias-map|_alias-map]] below
:{{para|_include-positional}} – pass all positional parameters to the working template; see §[[#include-positional|_include-positional]] below

;Definitions
:canonical parameter – a parameter supported and used by the working template
:wrapper parameter – a parameter used by the wrapper template; may provide data for canonical parameters or control other aspects of the wrapper template
:alias parameter – a wrapper parameter that is contextually meaningful to the wrapper template but must be renamed to a canonical parameter for use by the working template
:reused parameter – a parameter that is shared by both wrapper and working templates and has been modified by wrapper template
:default parameter – a canonical parameter given a default value in the wrapper template

{| class="nowrap" style="font-family:monospace"
|+parameter processing
!style="border:1px solid black"|wrapper<br />template !! !!style="border:1px solid black" colspan="11"|Module:Template wrapper !! !! style="border:1px solid black"|working<br />template
|-
| style="border: 1px solid black;"|{{para|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="5"|filter<br />exclued<br />parameters|| ||style="border: 2px solid black;" rowspan="10"|working<br />template
|-
| style="border: 1px solid black;"|{{para|plain=yes|{{var|wrapper parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;|| || style="border: 1px solid black;"|{{para|plain=yes|[[#exclude|_exclude]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||&nbsp;→&nbsp;
|-
|&nbsp;|| || style="border: 1px solid black;"|{{para|plain=yes|[[#include-positional|_include-positional]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;|| || style="border: 1px solid black;"|{{para|plain=yes|[[#alias-map|_alias-map]]}}||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="3"|convert alias<br />parameters to<br />canonical<br />parameters||&nbsp;→&nbsp;||style="border: 1px solid black;" rowspan="2"|{{para|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;|| ||&nbsp;→&nbsp;
|-
|&nbsp;|| || || ||&nbsp;→&nbsp;||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="4"|modify<br />reused<br />canonical<br />parameters
|-
| style="border: 1px solid black;"|{{para|plain=yes|{{var|alias parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;|| || || ||&nbsp;→&nbsp;||style="border: 1px solid black;"|{{para|plain=yes|{{var|reused parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––→||&nbsp;→&nbsp;
|-
|&nbsp;|| || style="border: 1px solid black;"|{{para|plain=yes|[[#reuse|_reuse]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
| style="border: 1px solid black;"|{{para|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;|| || style="border: 1px solid black;"|{{para|plain=yes|{{var|default parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––→||&nbsp;→&nbsp;
|}