Template:Quality/doc - Revision history

imported>Margotbean: /* Examples */

2023-02-14T04:05:11Z

Examples

← Older revision		Revision as of 04:05, 14 February 2023
Line 42:		Line 42:
	\|<code><nowiki>{{Quality\|Beer\|gold\|48}}</nowiki></code>		\|<code><nowiki>{{Quality\|Beer\|gold\|48}}</nowiki></code>
	\|{{Quality\|Beer\|gold\|48}}		\|{{Quality\|Beer\|gold\|48}}
			\|-
			\|<code><nowiki>{{Quality\|Large Goat Milk ES\|gold\|32\|center}}</nowiki></code>
			\|{{Quality\|Large Goat Milk ES\|gold\|32\|center}}
	\|-		\|-
	\|}<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		\|}<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean: update

2023-02-14T03:52:01Z

update

← Older revision		Revision as of 03:52, 14 February 2023
Line 1:		Line 1:
	This template ~~displays an image with~~ a ~~superimposed~~ quality star~~, ''i.e.,'' a star colored to match the item's quality~~ (~~Silver~~, ~~Gold~~, ~~Iridium~~).		==Description==
			This template overlays a quality star icon (silver, gold, or iridium) over an image.

	==~~Use~~==		==Parameters==
	=~~==Syntax===~~		{\|class="wikitable"
	~~Basic usage:~~		\|-
	~~<nowiki>{{</nowiki>'''Quality'''~~\|~~''item_name''\|''quality''<nowiki>}}</nowiki>~~		!Parameter
			!Notes
	~~Complete argument list:~~		\|-
	~~<nowiki>{{</nowiki>'''Quality'''~~\|~~''item_name''~~\|~~''quality''\| size=''px''<nowiki>}}</nowiki>~~		\|First (unnamed) parameter
			\|Name of background image (without extension such as .png)
	~~===Parameters===~~		\|-
	~~There are two unnamed, required parameters, ''item_name'' and ''quality''. All other parameters are named and optional. Default value for all arguments is empty, unless specified otherwise.~~		\|Second (unnamed) parameter
			\|Quality star to display<br />Valid values: normal, 0, silver, 1, gold, 2, iridium, 4
	* '''''item_name'''''		\|-
	** First unnamed parameter~~, required~~		\|Third (unnamed) parameter
	** The name of an item, or more specifically the name of ~~the~~ image (without .png)		\|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
	** Note that there must be no spaces following the item_name -~~- the "~~\|~~" symbol must come immediately afterwards, or the template will fail~~ (~~due to quirks of how mediawiki templates process arguments~~)		\|-
	** There is technically a default value, <samp>Blank_Icon</~~samp~~>, ~~solely to make the template not generate errors in the default display on other languages.~~		\|Fourth (unnamed) parameter
	** The template will automatically handle certain language-specific images. Namely in French, ~~Japanese~~, ~~Spanish~~, ~~and Portuguese~~, ~~all~~ 4 ~~Milk icons will be replaced with language~~-~~appropriate ones~~ (~~where the~~ "M" ~~for cow milk or "G" for goat milk are replaced with more appropriate letters~~)~~. The coding intentionally avoids using the expensive ifexist parser function because this template is frequently used dozens of times on a page. As a result, only specific known cases are recognized.~~		\|<samp>center</samp>, if the image is to be displayed in a table cell. Adding this parameter will center the image in the cell.
			\|-
	* '''''quality'''''		\|}
	** Second unnamed parameter, required
	** Possible values are <samp>Silver</~~samp~~>, ~~<samp>Gold</samp>~~, ~~<samp>Iridium</samp>. Not case-sensitive. All~~ other values ~~are ignored (''i.e.~~,~~'' no star is displayed~~)~~. If missing, no star is displayed.~~
	** On other languages, the translated terms are also recognized.

	* '''size=''px'''''
	** Size of icons in pixels. Default value is 24.
	** Standard values are <samp>24</samp>~~, <samp>32~~</samp>, ~~and <samp>48</samp>. Other values will work, but~~ the ~~size of the overlay region~~ is ~~always one of the standard values (''e~~.~~g.,'' there may be extra white space around~~ the image).
	** Only the ~~number should be provided (do not append "px")~~.~~<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>~~
	** For backwards compatibility, the size can also be provided as a third unnamed argument (''e.g.,'' <samp><nowiki>{{Quality\|~~Parsnip~~\|~~Silver\|24~~}~~}</nowiki></samp>).~~

	==Examples==		==Examples==
	<~~pre~~>{{Quality\|Parsnip\|~~silver~~}}</~~pre~~>		{\|class="wikitable"
	~~Result:~~ {{Quality\|Parsnip\|~~silver~~}}		\|-
	<~~pre~~>{{Quality\|~~Kale~~\|~~Gold~~\|32}}</~~pre~~>		!Template Call
	~~Result:~~ {{Quality\|~~Kale~~\|~~Gold~~\|32}}		!Result
	<~~pre~~>{{Quality\|~~Potato~~\|~~size=32~~}}</~~pre~~>		\|-
	~~Result:~~ {{Quality\|~~Potato~~\|~~size=32~~}}		\|<code><nowiki>{{Quality\|Parsnip\|iridium}}</nowiki></code>
	<~~pre~~>{{Quality\|~~Milk~~\|~~iridium~~\|~~size=24~~}}</~~pre~~>		\|{{Quality\|Parsnip\|iridium}}
	~~Result:~~ {{Quality\|~~Milk~~\|~~iridium~~\|~~size=24~~}}		\|-
			\|<code><nowiki>{{Quality\|Parsnip\|silver\|24\|center}}</nowiki></code>
	~~==Technical Details==~~		\|{{Quality\|Parsnip\|silver\|24\|center}}
	<~~references~~ />		\|-
	<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		\|<code><nowiki>{{Quality\|Sunfish\|normal\|36}}</nowiki></code>
			\|{{Quality\|Sunfish\|normal\|36}}
			\|-
			\|<code><nowiki>{{Quality\|Red Plate\|gold\|36\|center}}</nowiki></code>
			\|{{Quality\|Red Plate\|gold\|36\|center}}
			\|-
			\|<code><nowiki>{{Quality\|Beer\|gold\|48}}</nowiki></code>
			\|{{Quality\|Beer\|gold\|48}}
			\|-
			\|}<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean at 21:33, 8 January 2023

2023-01-08T21:33:33Z

← Older revision		Revision as of 21:33, 8 January 2023
Line 42:		Line 42:
	==Technical Details==		==Technical Details==
	<references />		<references />
	<includeonly>[[Category:~~Formatting templates~~]]~~{{Addlanglinks}}~~</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean: Text replacement - "==Usage==" to "==Use=="

2023-01-08T21:01:48Z

Text replacement - "==Usage==" to "==Use=="

← Older revision		Revision as of 21:01, 8 January 2023
Line 1:		Line 1:
	This template displays an image with a superimposed quality star, ''i.e.,'' a star colored to match the item's quality (Silver, Gold, Iridium).		This template displays an image with a superimposed quality star, ''i.e.,'' a star colored to match the item's quality (Silver, Gold, Iridium).

	==~~Usage~~==		==Use==
	===Syntax===		===Syntax===
	Basic usage:		Basic usage:

imported>Margotbean at 01:19, 8 November 2021

2021-11-08T01:19:30Z

← Older revision		Revision as of 01:19, 8 November 2021
Line 1:		Line 1:
	This template displays an image with a superimposed quality star, i.e., a star colored to match the item's quality (Silver, Gold, Iridium).		This template displays an image with a superimposed quality star, ''i.e.,'' a star colored to match the item's quality (Silver, Gold, Iridium).

	==Usage==		==Usage==
Line 21:		Line 21:
	* '''''quality'''''		* '''''quality'''''
	** Second unnamed parameter, required		** Second unnamed parameter, required
	** Possible values are <samp>Silver</samp>, <samp>Gold</samp>, <samp>Iridium</samp>. Not case-sensitive. All other values are ignored (i.e., no star is displayed). If missing, no star is displayed.		** Possible values are <samp>Silver</samp>, <samp>Gold</samp>, <samp>Iridium</samp>. Not case-sensitive. All other values are ignored (''i.e.,'' no star is displayed). If missing, no star is displayed.
	** On other languages, the translated terms are also recognized.		** On other languages, the translated terms are also recognized.

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:40:46Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:40, 8 November 2021
Line 26:		Line 26:
	* '''size=''px'''''		* '''size=''px'''''
	** Size of icons in pixels. Default value is 24.		** Size of icons in pixels. Default value is 24.
	** Standard values are <samp>24</samp>, <samp>32</samp>, and <samp>48</samp>. Other values will work, but the size of the overlay region is always one of the standard values (''e.g.'', there may be extra white space around the image).		** Standard values are <samp>24</samp>, <samp>32</samp>, and <samp>48</samp>. Other values will work, but the size of the overlay region is always one of the standard values (''e.g.,'' there may be extra white space around the image).
	** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>		** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>
	** For backwards compatibility, the size can also be provided as a third unnamed argument (''e.g.'', <samp><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></samp>).		** For backwards compatibility, the size can also be provided as a third unnamed argument (''e.g.,'' <samp><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></samp>).

	==Examples==		==Examples==

imported>Margotbean: Text replacement - "e.g.," to "''e.g.'',"

2021-11-07T23:43:48Z

Text replacement - "e.g.," to "''e.g.'',"

← Older revision		Revision as of 23:43, 7 November 2021
Line 26:		Line 26:
	* '''size=''px'''''		* '''size=''px'''''
	** Size of icons in pixels. Default value is 24.		** Size of icons in pixels. Default value is 24.
	** Standard values are <samp>24</samp>, <samp>32</samp>, and <samp>48</samp>. Other values will work, but the size of the overlay region is always one of the standard values (e.g., there may be extra white space around the image).		** Standard values are <samp>24</samp>, <samp>32</samp>, and <samp>48</samp>. Other values will work, but the size of the overlay region is always one of the standard values (''e.g.'', there may be extra white space around the image).
	** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>		** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>
	** For backwards compatibility, the size can also be provided as a third unnamed argument (e.g., <samp><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></samp>).		** For backwards compatibility, the size can also be provided as a third unnamed argument (''e.g.'', <samp><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></samp>).

	==Examples==		==Examples==

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:46:57Z

Text replacement - "tt>" to "samp>"

imported>Margotbean: update

2021-05-09T17:52:18Z

update

← Older revision		Revision as of 17:52, 9 May 2021
Line 7:		Line 7:

	Complete argument list:		Complete argument list:
	<nowiki>{{</nowiki>'''Quality'''\|''item_name''\|''quality''\| size=''px~~'' \| link=''link'' \| alt=''alt~~'' <nowiki>}}</nowiki>		<nowiki>{{</nowiki>'''Quality'''\|''item_name''\|''quality''\| size=''px''<nowiki>}}</nowiki>

	===Parameters===		===Parameters===
Line 29:		Line 29:
	** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>		** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>
	** For backwards compatibility, the size can also be provided as a third unnamed argument (e.g., <tt><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></tt>).		** For backwards compatibility, the size can also be provided as a third unnamed argument (e.g., <tt><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></tt>).

	* '''link=''link'''''
	** Name of page (without square brackets) that item icon should link to.
	** By default, link is automatically set to ''item_name''.
	** Setting link to an empty value (<tt>\|link=\|</tt>) disables the image link (clicking on the item does nothing).

	* '''alt=''alt'''''
	** Alt text for item icon. Default value is ''link'' or ''item_name''.
	** This is not normally directly displayed on the page, but may be used by screen readers or accessibility-aware browsers.
	** Setting alt to an empty value (<tt>\|alt=\|</tt>) disables the alt text. Appropriate whenever image is immediately followed by item name to prevent name from being read twice in a row.

	==Examples==		==Examples==
	<pre>{{Quality\|Parsnip\|silver}}</pre>		<pre>{{Quality\|Parsnip\|silver}}</pre>
	Result: {{Quality\|Parsnip\|silver}}		Result: {{Quality\|Parsnip\|silver}}
	<pre>{{Quality\|Kale\|Gold\|32~~\|link=Vegetables~~}}</pre>		<pre>{{Quality\|Kale\|Gold\|32}}</pre>
	Result: {{Quality\|Kale\|Gold\|32~~\|link=Vegetables~~}}		Result: {{Quality\|Kale\|Gold\|32}}
	<pre>{{Quality\|Potato\|size=32~~\|link=~~}}</pre>		<pre>{{Quality\|Potato\|size=32}}</pre>
	Result: {{Quality\|Potato\|size=32~~\|link=~~}}		Result: {{Quality\|Potato\|size=32}}
	<pre>{{Quality\|Milk\|iridium\|size=24~~\|link=\|alt=~~}}</pre>		<pre>{{Quality\|Milk\|iridium\|size=24}}</pre>
	Result: {{Quality\|Milk\|iridium\|size=24~~\|link=\|alt=~~}}		Result: {{Quality\|Milk\|iridium\|size=24}}

	==Technical Details==		==Technical Details==
	<references />		<references />
	<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean at 23:31, 24 February 2021

2021-02-24T23:31:29Z

← Older revision		Revision as of 23:31, 24 February 2021
Line 52:		Line 52:
	==Technical Details==		==Technical Details==
	<references />		<references />
	<includeonly>[[Category:Formatting templates]]{{~~AddLangLinks~~}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

← Older revision		Revision as of 18:46, 4 November 2021
Line 16:		Line 16:
	** The name of an item, or more specifically the name of the image (without .png)		** The name of an item, or more specifically the name of the image (without .png)
	** Note that there must be no spaces following the item_name -- the "\|" symbol must come immediately afterwards, or the template will fail (due to quirks of how mediawiki templates process arguments)		** Note that there must be no spaces following the item_name -- the "\|" symbol must come immediately afterwards, or the template will fail (due to quirks of how mediawiki templates process arguments)
	** There is technically a default value, <tt>Blank_Icon</tt>, solely to make the template not generate errors in the default display on other languages.		** There is technically a default value, <samp>Blank_Icon</samp>, solely to make the template not generate errors in the default display on other languages.
	** The template will automatically handle certain language-specific images. Namely in French, Japanese, Spanish, and Portuguese, all 4 Milk icons will be replaced with language-appropriate ones (where the "M" for cow milk or "G" for goat milk are replaced with more appropriate letters). The coding intentionally avoids using the expensive ifexist parser function because this template is frequently used dozens of times on a page. As a result, only specific known cases are recognized.		** The template will automatically handle certain language-specific images. Namely in French, Japanese, Spanish, and Portuguese, all 4 Milk icons will be replaced with language-appropriate ones (where the "M" for cow milk or "G" for goat milk are replaced with more appropriate letters). The coding intentionally avoids using the expensive ifexist parser function because this template is frequently used dozens of times on a page. As a result, only specific known cases are recognized.

	* '''''quality'''''		* '''''quality'''''
	** Second unnamed parameter, required		** Second unnamed parameter, required
	** Possible values are <tt>Silver</tt>, <tt>Gold</tt>, <tt>Iridium</tt>. Not case-sensitive. All other values are ignored (i.e., no star is displayed). If missing, no star is displayed.		** Possible values are <samp>Silver</samp>, <samp>Gold</samp>, <samp>Iridium</samp>. Not case-sensitive. All other values are ignored (i.e., no star is displayed). If missing, no star is displayed.
	** On other languages, the translated terms are also recognized.		** On other languages, the translated terms are also recognized.

	* '''size=''px'''''		* '''size=''px'''''
	** Size of icons in pixels. Default value is 24.		** Size of icons in pixels. Default value is 24.
	** Standard values are <tt>24</tt>, <tt>32</tt>, and <tt>48</tt>. Other values will work, but the size of the overlay region is always one of the standard values (e.g., there may be extra white space around the image).		** Standard values are <samp>24</samp>, <samp>32</samp>, and <samp>48</samp>. Other values will work, but the size of the overlay region is always one of the standard values (e.g., there may be extra white space around the image).
	** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>		** Only the number should be provided (do not append "px").<ref name="px">Technically, the template will strip any extra "px" from a provided size, but this usage is not recommended.</ref>
	** For backwards compatibility, the size can also be provided as a third unnamed argument (e.g., <tt><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></tt>).		** For backwards compatibility, the size can also be provided as a third unnamed argument (e.g., <samp><nowiki>{{Quality\|Parsnip\|Silver\|24}}</nowiki></samp>).

	==Examples==		==Examples==