Difference between revisions of "Template:Format item/doc"

From blackwiki
Jump to navigation Jump to search
imported>Petr Matas
(Created page with '{{Documentation subpage}} {{lua|Module:Item}} This template transforms a given Template:item using a given template. == Usage == {{((}}Format item | item...')
 
imported>Petr Matas
Line 4: Line 4:
  
 
== Usage ==
 
== Usage ==
  {{((}}Format item | item = ''[[Template:Item|Item]]'' | template = ''TransformationTemplate''}}
+
  {{((}}Format item | item = ''[[Template:Item|Item]]'' | template = ''TransformationTemplate'' | ... }}
<code>''TransformationTemplate''</code> is called with the arguments that the item has been created with.
+
{{code|''TransformationTemplate''}} is called with the arguments that the item has been created with plus any additional arguments passed to {{tl|Format item}}. Contents of the item takes precedence over additional arguments, unless the argument name is prepended with <code>important&nbsp;</code>. If the argument name collides with the arguments of {{tl|Format item}} itself, prepend it with <code>param&nbsp;</code>. There is no need to combine <code>param&nbsp;</code> and <code>important&nbsp;</code>, though.
  
 
{| class=wikitable
 
{| class=wikitable
|+ Example
+
|+ Examples
 
! Code !! Result
 
! Code !! Result
 
|-
 
|-
Line 18: Line 18:
 
| item = {{Item|name=Tom|animal=cat|legs=4}}
 
| item = {{Item|name=Tom|animal=cat|legs=4}}
 
| template = Show pet
 
| template = Show pet
 +
}}
 +
|-
 +
|<pre>{{Format item
 +
| item = {{Item|name=Tom|animal=cat}}
 +
| template = Show pet
 +
| legs = 3
 +
}}</pre>
 +
|{{Format item
 +
| item = {{Item|name=Tom|animal=cat}}
 +
| template = Show pet
 +
| legs = 3
 +
}}
 +
|-
 +
|<pre>{{Format item
 +
| item = {{Item|name=Tom|animal=cat}}
 +
| template = Show pet
 +
| param legs = 3
 +
}}</pre>
 +
|{{Format item
 +
| item = {{Item|name=Tom|animal=cat}}
 +
| template = Show pet
 +
| param legs = 3
 +
}}
 +
|-
 +
|<pre>{{Format item
 +
| item = {{Item|name=Tom|animal=cat|legs=4}}
 +
| template = Show pet
 +
| legs = 3
 +
}}</pre>
 +
|{{Format item
 +
| item = {{Item|name=Tom|animal=cat|legs=4}}
 +
| template = Show pet
 +
| legs = 3
 +
}}
 +
|-
 +
|<pre>{{Format item
 +
| item = {{Item|name=Tom|animal=cat|legs=4}}
 +
| template = Show pet
 +
| important legs = 3
 +
}}</pre>
 +
|{{Format item
 +
| item = {{Item|name=Tom|animal=cat|legs=4}}
 +
| template = Show pet
 +
| important legs = 3
 
}}
 
}}
 
|}
 
|}

Revision as of 05:54, 14 December 2015

This template transforms a given item using a given template.

Usage

{{Format item | item = Item | template = TransformationTemplate | ... }}

''TransformationTemplate'' is called with the arguments that the item has been created with plus any additional arguments passed to {{Format item}}. Contents of the item takes precedence over additional arguments, unless the argument name is prepended with important . If the argument name collides with the arguments of {{Format item}} itself, prepend it with param . There is no need to combine param  and important , though.

Examples
Code Result
{{Format item
| item = {{Item|name=Tom|animal=cat|legs=4}}
| template = Show pet
}}
Lua error: expandTemplate: template "Show pet" does not exist.
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| legs = 3
}}
Lua error: expandTemplate: template "Show pet" does not exist.
{{Format item
| item = {{Item|name=Tom|animal=cat}}
| template = Show pet
| param legs = 3
}}
Lua error: expandTemplate: template "Show pet" does not exist.
{{Format item
| item = {{Item|name=Tom|animal=cat|legs=4}}
| template = Show pet
| legs = 3
}}
Lua error: expandTemplate: template "Show pet" does not exist.
{{Format item
| item = {{Item|name=Tom|animal=cat|legs=4}}
| template = Show pet
| important legs = 3
}}
Lua error: expandTemplate: template "Show pet" does not exist.

See also