Difference between revisions of "Template:Format item/doc"
imported>Petr Matas |
imported>Pppery (+ new param) |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
| − | {{((}}Format item | item = ''[[Template:Item|Item]]'' | template = ''TransformationTemplate'' | ... }} | + | {{((}}Format item | item = ''[[Template:Item|Item]]'' | template = ''TransformationTemplate'' | blanks = '''yes/no'''... }} |
| − | <code>''TransformationTemplate''</code> is called with the parameters that the item has been created with, plus any additional parameters passed to {{tl|Format item}}. Contents of the item take precedence over the additional parameters, unless the parameter name is prepended with {{nowrap|<code>{{nodisplay|"}}important {{nodisplay|"}}</code>.}} If the parameter name collides with the parameters of {{tl|Format item}} itself, prepend it with {{nowrap|<code>{{nodisplay|"}}param {{nodisplay|"}}</code>.}} There is no need to combine {{pre-wrap|{{nowrap|<code>{{nodisplay|"}}param {{nodisplay|"}}</code>}} {{nodisplay| }}}}and <code>{{nodisplay|"}}important {{nodisplay|"}}</code>, though. | + | <code>''TransformationTemplate''</code> is called with the parameters that the item has been created with, plus any additional parameters passed to {{tl|Format item}}. Contents of the item take precedence over the additional parameters, unless the parameter name is prepended with {{nowrap|<code>{{nodisplay|"}}important {{nodisplay|"}}</code>.}} If the parameter name collides with the parameters of {{tl|Format item}} itself, prepend it with {{nowrap|<code>{{nodisplay|"}}param {{nodisplay|"}}</code>.}} There is no need to combine {{pre-wrap|{{nowrap|<code>{{nodisplay|"}}param {{nodisplay|"}}</code>}} {{nodisplay| }}}}and <code>{{nodisplay|"}}important {{nodisplay|"}}</code>, though. The optional {{para|blanks}} parameter specifies what to do with items specifying nothing. If set to yes (the default), then they are treated as usual. If set to "no", then any blank parameters from items are dropped, and if no parameters remain the template returns nothing. |
It is also possible to [[Template:Item#Format each item using a template|transform multiple items at once]], but not with this template. | It is also possible to [[Template:Item#Format each item using a template|transform multiple items at once]], but not with this template. | ||
Revision as of 23:41, 2 March 2018
| This is a documentation subpage for Template:Format item. It contains usage information, categories and other content that is not part of the original template page. |
| This template uses Lua: |
This template transforms a given item using a given template.
Usage
{{Format item | item = Item | template = TransformationTemplate | blanks = yes/no... }}
TransformationTemplate is called with the parameters that the item has been created with, plus any additional parameters passed to {{Format item}}. Contents of the item take precedence over the additional parameters, unless the parameter name is prepended with Template:Nodisplayimportant Template:Nodisplay. If the parameter name collides with the parameters of {{Format item}} itself, prepend it with Template:Nodisplayparam Template:Nodisplay. There is no need to combine Template:Pre-wrapand Template:Nodisplayimportant Template:Nodisplay, though. The optional |blanks= parameter specifies what to do with items specifying nothing. If set to yes (the default), then they are treated as usual. If set to "no", then any blank parameters from items are dropped, and if no parameters remain the template returns nothing.
It is also possible to transform multiple items at once, but not with this template.
Examples
| Markup | Renders as |
|---|---|
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
}}
|
Lua error: expandTemplate: template "Show pet" does not exist. |
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| legs = 4
}}
|
Lua error: expandTemplate: template "Show pet" does not exist. |
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| param legs = 4
}}
|
Lua error: expandTemplate: template "Show pet" does not exist. |
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| animal = dog
}}
|
Lua error: expandTemplate: template "Show pet" does not exist. |
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| important animal = dog
}}
|
Lua error: expandTemplate: template "Show pet" does not exist. |