Template:Overlayimg/doc - Revision history

imported>Margotbean: /* Parameters */ +dried fruit

2024-07-19T20:25:21Z

Parameters: +dried fruit

← Older revision		Revision as of 20:25, 19 July 2024
Line 15:		Line 15:
	\|type		\|type
	\|Yes		\|Yes
	\|Type of foreground image.<br />Valid values: Aged Roe, Honey, Jelly, Juice, Pickles, Recipe, Star, Wine<br />All values other than <samp>star</samp> are used to produce an image, and are '''case-sensitive'''.		\|Type of foreground image.<br />Valid values: Aged Roe, Dried Fruit, Honey, Jelly, Juice, Pickles, Recipe, Star, Wine<br />All values other than <samp>star</samp> are used to produce an image, and are '''case-sensitive'''.
	\|-		\|-
	\|width		\|width

imported>Margotbean at 21:34, 16 March 2023

2023-03-16T21:34:18Z

← Older revision		Revision as of 21:34, 16 March 2023
Line 15:		Line 15:
	\|type		\|type
	\|Yes		\|Yes
	\|Recipe or Star (case ~~insensitive)~~		\|Type of foreground image.<br />Valid values: Aged Roe, Honey, Jelly, Juice, Pickles, Recipe, Star, Wine<br />All values other than <samp>star</samp> are used to produce an image, and are '''case-sensitive'''.
	\|-		\|-
	\|width		\|width
Line 23:		Line 23:
	\|quality		\|quality
	\|No		\|No
	\|If <samp>type=star</samp>, this parameter specifies the quality star to use.<br />Valid values: 4, Iridium, 2, Gold, 1, Silver, 0. (Case insensitive)<br />If <samp>type=star</samp> and this parameter is omitted, quality is assumed to be normal/base (no-star) quality.<br />This parameter should ~~not~~ be ~~used if~~ <samp>type~~=recipe~~</samp>.		\|If <samp>type=star</samp>, this parameter specifies the quality star to use.<br />Valid values: 4, Iridium, 2, Gold, 1, Silver, 0. (Case insensitive)<br />If <samp>type=star</samp> and this parameter is omitted, quality is assumed to be normal/base (no-star) quality.<br />This parameter should be omitted for any <samp>type</samp> other than <samp>star</samp>.
	\|-		\|-
	\|center		\|center
Line 43:		Line 43:
	\|{{Overlayimg\|Parsnip\|type=star\|quality=gold\|width=36\|center=true}}		\|{{Overlayimg\|Parsnip\|type=star\|quality=gold\|width=36\|center=true}}
	\|-		\|-
	\|<code><nowiki>{{Overlayimg\|Fish Stew\|type=~~recipe~~}}</nowiki></code>		\|<code><nowiki>{{Overlayimg\|Fish Stew\|type=Recipe}}</nowiki></code>
	\|{{Overlayimg\|Fish Stew\|type=~~recipe~~}}		\|{{Overlayimg\|Fish Stew\|type=Recipe}}
	\|-		\|-
	\|<code><nowiki>{{Overlayimg\|Autumn's Bounty\|type=~~recipe~~\|width=48\|center=true}}</nowiki></code>		\|<code><nowiki>{{Overlayimg\|Autumn's Bounty\|type=Recipe\|width=48\|center=true}}</nowiki></code>
	\|{{Overlayimg\|Autumn's Bounty\|type=~~recipe~~\|width=48\|center=true}}		\|{{Overlayimg\|Autumn's Bounty\|type=Recipe\|width=48\|center=true}}
	\|-		\|-
	\|<code><nowiki>{{Overlayimg\|Wicked Statue\|type=~~recipe~~\|width=36\|center=true}}</nowiki></code>		\|<code><nowiki>{{Overlayimg\|Wicked Statue\|type=Recipe\|width=36\|center=true}}</nowiki></code>
	\|{{Overlayimg\|Wicked Statue\|type=~~recipe~~\|width=36\|center=true}}		\|{{Overlayimg\|Wicked Statue\|type=Recipe\|width=36\|center=true}}
	\|-		\|-
	\|}		\|}
	<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean: new

2023-02-09T19:10:59Z

new

New page

==Description==
This template overlays one image on top of another. It can be called directly, but is also used by [[Template:Recipe]] and [[Template:Quality]].

==Parameters==
{|class="wikitable sortable"
|-
!Parameter
!Required
!Notes
|-
|First (unnamed) parameter
|Yes
|Name of background image (without extension such as .png)
|-
|type
|Yes
|Recipe or Star (case insensitive)
|-
|width
|No
|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
|-
|quality
|No
|If <samp>type=star</samp>, this parameter specifies the quality star to use. Valid values: 4, Iridium, 2, Gold, 1, Silver, 0. (Case insensitive) If <samp>type=star</samp> and this parameter is omitted, quality is assumed to be normal/base (no-star) quality. This parameter should not be used if <samp>type=recipe</samp>.
|-
|center
|No
|If the image is to be displayed in a table cell, then setting <samp>center=true</samp> will center the image inside the cell.
|-
|}

==Examples==
{|class="wikitable"
|-
!Template Call
!Result
|-
|<code><nowiki>{{Overlayimg|Parsnip|type=star|quality=silver|width=36}}</nowiki></code>
|{{Overlayimg|Parsnip|type=star|quality=silver|width=36}}
|-
|<code><nowiki>{{Overlayimg|Parsnip|type=star|quality=gold|width=36|center=true}}</nowiki></code>
|{{Overlayimg|Parsnip|type=star|quality=gold|width=36|center=true}}
|-
|<code><nowiki>{{Overlayimg|Fish Stew|type=recipe}}</nowiki></code>
|{{Overlayimg|Fish Stew|type=recipe}}
|-
|<code><nowiki>{{Overlayimg|Autumn's Bounty|type=recipe|width=48|center=true}}</nowiki></code>
|{{Overlayimg|Autumn's Bounty|type=recipe|width=48|center=true}}
|-
|<code><nowiki>{{Overlayimg|Wicked Statue|type=recipe|width=36|center=true}}</nowiki></code>
|{{Overlayimg|Wicked Statue|type=recipe|width=36|center=true}}
|-
|}
<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>