Changes

Jump to navigation Jump to search
579 bytes added ,  21:09, 28 March 2016
Documented my changes to the template. See template and discussion for details.
Line 9: Line 9:  
<pre>{{name|''item name''|''amount''}}</pre>
 
<pre>{{name|''item name''|''amount''}}</pre>
 
===Optional Parameters===
 
===Optional Parameters===
 +
All Optional Parameters if used together with "quantity" should be placed after the quantity value!
 
*size: the image size to be displayed (example: size=48)
 
*size: the image size to be displayed (example: size=48)
 
*image: an alternative image to display (example: image=Angler.png)
 
*image: an alternative image to display (example: image=Angler.png)
 
*link: replace the name with a link to another page
 
*link: replace the name with a link to another page
 +
*class: alternative classes. Currently there is only '''inline''' to suppress line break (example: class=inline)
 
==Examples==
 
==Examples==
<pre>
+
<pre>{{name|Complete Breakfast|30}}</pre>
{{name|Complete Breakfast|30}}
+
 
</pre>
   
When used the parameters are not identified by name, but by order.  Example use of this template;
 
When used the parameters are not identified by name, but by order.  Example use of this template;
 
<pre>{{name|Corn|30}}</pre>
 
<pre>{{name|Corn|30}}</pre>
Line 21: Line 22:  
<pre>{{name|Preserves Jar|3}}</pre>
 
<pre>{{name|Preserves Jar|3}}</pre>
 
Result: {{name|Preserves Jar|3}}
 
Result: {{name|Preserves Jar|3}}
 +
 +
'''Optional parameter examples:'''
 +
<pre>Crafting recipe unlocked at {{name|Mining|Level 9|class=inline}}.</pre>
 +
Result: Crafting recipe unlocked at {{name|Mining|Level 9|class=inline}}.
 +
 
Size can be defined by using the named parameter "size":
 
Size can be defined by using the named parameter "size":
 
<pre>{{name|Apple|size=48}}</pre>
 
<pre>{{name|Apple|size=48}}</pre>
 
Result: {{name|Apple|size=48}}
 
Result: {{name|Apple|size=48}}
 +
 
If the size parameter is used together with quantity it should be placed after the quantity number:
 
If the size parameter is used together with quantity it should be placed after the quantity number:
 
<pre>{{name|Melon|3|size=48}}</pre>
 
<pre>{{name|Melon|3|size=48}}</pre>
 
Result: {{name|Melon|3|size=48}}
 
Result: {{name|Melon|3|size=48}}
 +
 
If the image parameter is used together with quantity it should be placed after the quantity number:
 
If the image parameter is used together with quantity it should be placed after the quantity number:
 
<pre>{{name|Grape|3|image=Hops.png}}</pre>
 
<pre>{{name|Grape|3|image=Hops.png}}</pre>
 
Result: {{name|Grape|3|image=Hops.png}}
 
Result: {{name|Grape|3|image=Hops.png}}
 +
 
If the link parameter is used together with quantity it should be placed after the quantity number:
 
If the link parameter is used together with quantity it should be placed after the quantity number:
 
<pre>{{name|Corn|3|link=Grape}}</pre>
 
<pre>{{name|Corn|3|link=Grape}}</pre>
 
Result: {{name|Corn|3|link=Grape}}
 
Result: {{name|Corn|3|link=Grape}}
 +
 +
It's also possible to use multiple optional parameters:
 +
<pre>{{name|Grape|3|image=Hops.png|size=64|class=inline}}.</pre>
 +
{{name|Grape|3|image=Hops.png|size=64|class=inline}}.
 
<includeonly>[[Category:Transclusion templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Transclusion templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
141

edits

Navigation menu