Open main menu
Home
Random
Donate
Recent changes
Special pages
Community portal
Preferences
About Stockhub
Disclaimers
Search
User menu
Talk
Contributions
Create account
Log in
Editing
Module:Template wrapper/doc
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== 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|<{{var|default parameter}}>|<{{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" |+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}}}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||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}}}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β |- | || || style="border: 1px solid black;"|{{para|plain=yes|[[#_exclude|_exclude]]}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β || β |- | || || style="border: 1px solid black;"|{{para|plain=yes|[[#_include-positional|_include-positional]]}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β |- | || || style="border: 1px solid black;"|{{para|plain=yes|[[#_alias-map|_alias-map]]}}|| β ||style="border: 2px solid black;" rowspan="3"|convert alias<br />parameters to<br />canonical<br />parameters|| β ||style="border: 1px solid black;" rowspan="2"|{{para|plain=yes|{{var|canonical parameters}}}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β || || β |- | || || || || β || β ||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}}}}|| β ||style="text-align: center;"|ββββββββ|| β || || || || β ||style="border: 1px solid black;"|{{para|plain=yes|{{var|reused parameters}}}}|| β ||style="text-align: center;"|ββββ|| β |- | || || style="border: 1px solid black;"|{{para|plain=yes|[[#_reuse|_reuse]]}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β |- | style="border: 1px solid black;"|{{para|plain=yes|{{var|canonical parameters}}}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β |- | || || style="border: 1px solid black;"|{{para|plain=yes|{{var|default parameters}}}}|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββββββ|| β ||style="text-align: center;"|ββββ|| β |}
Summary:
Please note that all contributions to Stockhub may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Stockhub:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)