Template:Overlayimg/doc: Difference between revisions
imported>Margotbean new |
imported>Margotbean No edit summary |
||
| Line 15: | Line 15: | ||
|type | |type | ||
|Yes | |Yes | ||
|Recipe | |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 | |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= | |<code><nowiki>{{Overlayimg|Fish Stew|type=Recipe}}</nowiki></code> | ||
|{{Overlayimg|Fish Stew|type= | |{{Overlayimg|Fish Stew|type=Recipe}} | ||
|- | |- | ||
|<code><nowiki>{{Overlayimg|Autumn's Bounty|type= | |<code><nowiki>{{Overlayimg|Autumn's Bounty|type=Recipe|width=48|center=true}}</nowiki></code> | ||
|{{Overlayimg|Autumn's Bounty|type= | |{{Overlayimg|Autumn's Bounty|type=Recipe|width=48|center=true}} | ||
|- | |- | ||
|<code><nowiki>{{Overlayimg|Wicked Statue|type= | |<code><nowiki>{{Overlayimg|Wicked Statue|type=Recipe|width=36|center=true}}</nowiki></code> | ||
|{{Overlayimg|Wicked Statue|type= | |{{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> | ||
Revision as of 21:34, 16 March 2023
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
| Parameter | Required | Notes |
|---|---|---|
| First (unnamed) parameter | Yes | Name of background image (without extension such as .png) |
| type | Yes | Type of foreground image. Valid values: Aged Roe, Honey, Jelly, Juice, Pickles, Recipe, Star, Wine All values other than star are used to produce an image, and are case-sensitive. |
| 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 type=star, this parameter specifies the quality star to use. Valid values: 4, Iridium, 2, Gold, 1, Silver, 0. (Case insensitive) If type=star and this parameter is omitted, quality is assumed to be normal/base (no-star) quality. This parameter should be omitted for any type other than star. |
| center | No | If the image is to be displayed in a table cell, then setting center=true will center the image inside the cell. |
Examples
| Template Call | Result |
|---|---|
{{Overlayimg|Parsnip|type=star|quality=silver|width=36}}
|
  |
{{Overlayimg|Parsnip|type=star|quality=gold|width=36|center=true}}
|
 |
{{Overlayimg|Fish Stew|type=Recipe}}
|
  |
{{Overlayimg|Autumn's Bounty|type=Recipe|width=48|center=true}}
|
  |
{{Overlayimg|Wicked Statue|type=Recipe|width=36|center=true}}
|
  |