Template:Recipe/doc: Difference between revisions

Latest revision as of 21:24, 10 February 2023

Description

This template overlays a recipe icon over an image. The background image will be rendered semi-transparent.

Parameters

Parameter	Notes
First (unnamed) parameter	Name of background image (without extension such as .png)
Second (unnamed) parameter	Desired display width of background image (do not include "px") Valid values: 48, 36, 32, 24 (other values will be accepted, but may produce undesired results) Default value: 24
Third (unnamed) parameter	`center`, if the image is to be displayed in a table cell. Adding this parameter will center the image in the cell.

Examples

Template Call	Result
`{{Recipe\|Bread}}`
`{{Recipe\|Complete Breakfast\|48}}`
`{{Recipe\|Barrel Brazier\|36\|center}}`
`{{Recipe\|Wicked Statue\|32\|center}}`

@@ Line 1: / Line 1: @@
 ==Description==
-This template is used to insert a overlay a recipe icon on an image. It will default to a 48 px image, but can be adjusted with parameters.
+This template overlays a recipe icon over an image. The background image will be rendered semi-transparent.
-==Use==
+==Parameters==
-This template can be used by entering the following onto a relevant page.
+{|class="wikitable"
+|-
-<pre>
+!Parameter
-{{Recipe
+!Notes
-|image=Image name assuming the image is a .png (image)
+|-
-|size=size of the image (24/32/48)
+|First (unnamed) parameter
-}}
+|Name of background image (without extension such as .png)
-</pre>
+|-
+|Second (unnamed) parameter
+|Desired display width of background image (do not include "px")<br />Valid values: 48, 36, 32, 24 (other values will be accepted, but may produce undesired results)<br />Default value: 24
+|-
+|Third (unnamed) parameter
+|<samp>center</samp>, if the image is to be displayed in a table cell. Adding this parameter will center the image in the cell.
+|-
+|}
 ==Examples==
-<pre>{{Recipe|Bread}}</pre>
+{|class="wikitable"
-Result: {{Recipe|Bread}}
+|-
-<pre>{{Recipe|Complete Breakfast|48}}</pre>
+!Template Call
-Result: {{Recipe|Complete Breakfast|48}}
+!Result
+|-
-<includeonly>[[Category:Formatting templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
+|<code><nowiki>{{Recipe|Bread}}</nowiki></code>
-<includeonly>{{Addlanglinks}}</includeonly>
+|{{Recipe|Bread}}
+|-
+|<code><nowiki>{{Recipe|Complete Breakfast|48}}</nowiki></code>
+|{{Recipe|Complete Breakfast|48}}
+|-
+|<code><nowiki>{{Recipe|Barrel Brazier|36|center}}</nowiki></code>
+|{{Recipe|Barrel Brazier|36|center}}
+|-
+|<code><nowiki>{{Recipe|Wicked Statue|32|center}}</nowiki></code>
+|{{Recipe|Wicked Statue|32|center}}
+|-
+|}<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Template Call	Result
`{{Recipe\|Bread}}`
`{{Recipe\|Complete Breakfast\|48}}`
`{{Recipe\|Barrel Brazier\|36\|center}}`
`{{Recipe\|Wicked Statue\|32\|center}}`