Template:Season/doc - Revision history

imported>Margotbean at 21:28, 8 January 2023

2023-01-08T21:28:50Z

← Older revision		Revision as of 21:28, 8 January 2023
Line 23:		Line 23:
	{{Season\|Summer\|24}}<br />		{{Season\|Summer\|24}}<br />

	<includeonly>[[Category:~~Formatting templates~~]]~~{{Addlanglinks}}~~</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean at 17:40, 11 May 2022

2022-05-11T17:40:56Z

← Older revision		Revision as of 17:40, 11 May 2022
Line 1:		Line 1:
	==Description==		==Description==
	This template displays the icon for the requested season, plus the season as a link to its associated article.		This template displays the icon for the requested season, plus the season as a link to its associated article.

	~~The icon and text are enclosed in a nowrap span, so that they are always displayed on the same line.~~

	==Notes==		==Notes==

imported>Margotbean at 21:26, 7 May 2022

2022-05-07T21:26:29Z

← Older revision		Revision as of 21:26, 7 May 2022
Line 8:		Line 8:

	==Use==		==Use==
	<pre>{{Season\|~~''season''}}</pre>~~		<pre>{{Season\|name of season\|day (optional)\|width (optional)}}</pre>

	~~==Parameters==~~
	~~<pre>~~
	~~season =~~ name of season ~~(in English or native language)~~
	~~day =~~ day ~~of season, shown before the name of the season~~ (optional)
	~~width =~~ width ~~of image in pixels~~ (optional)
	</pre>

	===Examples===		===Examples===

imported>Margotbean at 21:23, 7 May 2022

2022-05-07T21:23:53Z

← Older revision		Revision as of 21:23, 7 May 2022
Line 1:		Line 1:
			==Description==
	This template displays the icon for the requested season, plus the season as a link to its associated article.		This template displays the icon for the requested season, plus the season as a link to its associated article.

Line 6:		Line 7:
	The template recognizes two special values of season, <samp>Marriage</samp> and <samp>Deviations</samp>, for the sake of NPC schedule pages (see [[Template:ScheduleHeader]]).		The template recognizes two special values of season, <samp>Marriage</samp> and <samp>Deviations</samp>, for the sake of NPC schedule pages (see [[Template:ScheduleHeader]]).

	==~~Usage~~==		==Use==
	~~===Syntax===~~		<pre>{{Season\|''season''}}</pre>
	~~Basic usage:~~
	<~~nowiki~~>{{~~</nowiki>[[Template:~~Season~~\|Season]]~~ \| ''season'' ~~<nowiki>~~}}</~~nowiki~~>

	~~Complete argument list:~~		==Parameters==
	~~<nowiki>{{</nowiki>[[Template:Season\|Season]] \| ''season'' \| ''day''~~		<pre>
	~~\| size~~=~~''px'' \| width~~=~~''widthpluspx'' \| all~~=~~''text_for_all'' \| sortkey~~=~~true \| space=''value''~~		season = name of season (in English or native language)
	~~\| text_only=true \| no_translate=true~~ <~~nowiki>}}</nowiki~~>		day = day of season, shown before the name of the season (optional)
			width = width of image in pixels (optional)
	=~~==Parameters===~~		</pre>
	There is one unnamed required parameter, ''season'', and one unnamed optional parameter, ''day''. All other parameters are named and optional. Default value for all arguments is empty, unless specified otherwise.

	* '''''season'''''
	** First unnamed parameter, required
	** The name of the season to be displayed, recognized values: <samp>Spring, Summer, Fall, Winter, All Seasons, Marriage, Deviations</samp>. <samp>All</samp> and <samp>Any</samp> are recognized as synonyms for <samp>All Seasons</samp>.
	** If an unrecognized season ~~name is provided, the template will simply print out that name~~ (~~no link, no icon).~~
	** The seasons should be provided as plain text (unlinked). If the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.,'' <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.

	* '''''day~~'''''~~
	** Second unnamed parameter, optional
	** The day of ~~the~~ season, ~~for example to generate formatted villager birthdays.~~
	** Any provided value is displayed in front of the ~~season~~ name ~~(but after the icon), to match the format used in-game for birthdays.~~

	* '''size=''px'''''
	** Size of ~~icon in pixels. Default value is 24~~
	** Only the ~~number should be provided~~ (~~do not append "px"~~).

	* '''width=~~''widthpluspx'''''~~
	** Size of ~~icons~~ in pixels ~~''with px''~~ (~~''e.g.,'' <nowiki>width=24px</nowiki>).~~
	** This is redundant with <samp>size</samp> and inconsistent (expects a different format); only one (preferably <samp>size</samp>) ~~should be used.~~
	** This parameter is included solely for backwards compatibility and is deprecated

	* '''all=''text_for_all'''''
	** Relevant only if <samp>''season''</samp> is <samp>All Seasons</samp> (or a synonym): when <samp>all</samp> is set, the specified text will be displayed instead of <samp>All</samp>. Default value is <samp>All</samp>.

	* '''sortkey=true'''
	** If set, a hidden span containing a numeric sortkey will be added to the output, to improve table sorting. The sortkey will causes seasons to be sorted in order Spring, Summer, Fall, Winter, instead of being sorted alphabetically. Plus any provided <samp>day</~~samp~~> ~~will be included in the sortkey.~~

	===Examples===		===Examples===
Line 49:		Line 21:
	{{Season\|Marriage}}		{{Season\|Marriage}}
	{{Season\|Deviations}}		{{Season\|Deviations}}
	{{Season\|All\|~~size~~=48}}		{{Season\|All\|width=48}}
	{{Season\|Summer\|24}}		{{Season\|Summer\|24}}
	</pre>		</pre>
Line 57:		Line 29:
	{{Season\|Marriage}}<br />		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br />		{{Season\|Deviations}}<br />
	{{Season\|All\|~~size~~=48}}<br />		{{Season\|All\|width=48}}<br />
	{{Season\|Summer\|24}}<br />		{{Season\|Summer\|24}}<br />

	<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 20:41, 6 May 2022

2022-05-06T20:41:14Z

← Older revision		Revision as of 20:41, 6 May 2022
Line 47:		Line 47:
	===Examples===		===Examples===
	<pre>{{Season\|Spring}}		<pre>{{Season\|Spring}}
	~~{{Season\|Summer, Fall, Winter}}~~
	{{Season\|Marriage}}		{{Season\|Marriage}}
	{{Season\|Deviations}}		{{Season\|Deviations}}
Line 56:		Line 55:
	Results:<br />		Results:<br />
	{{Season\|Spring}}<br />		{{Season\|Spring}}<br />
	~~{{Season\|Summer, Fall, Winter}}<br />~~
	{{Season\|Marriage}}<br />		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br />		{{Season\|Deviations}}<br />

imported>Margotbean at 18:46, 6 May 2022

2022-05-06T18:46:47Z

← Older revision		Revision as of 18:46, 6 May 2022
Line 1:		Line 1:
	This template displays the icon for the requested season, plus the season as a link to its associated article~~. One or more seasons may be specified, separated by commas~~.		This template displays the icon for the requested season, plus the season as a link to its associated article.

	The icon and text are enclosed in a nowrap span, so that they are always displayed on the same line.		The icon and text are enclosed in a nowrap span, so that they are always displayed on the same line.
Line 22:		Line 22:
	** First unnamed parameter, required		** First unnamed parameter, required
	** The name of the season to be displayed, recognized values: <samp>Spring, Summer, Fall, Winter, All Seasons, Marriage, Deviations</samp>. <samp>All</samp> and <samp>Any</samp> are recognized as synonyms for <samp>All Seasons</samp>.		** The name of the season to be displayed, recognized values: <samp>Spring, Summer, Fall, Winter, All Seasons, Marriage, Deviations</samp>. <samp>All</samp> and <samp>Any</samp> are recognized as synonyms for <samp>All Seasons</samp>.
	** Multiple seasons can be specified, separated by commas
	** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).		** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).
	** The seasons should be provided as plain text (unlinked). ~~However, to allow the template to work regardless of user input choices, links such as <samp><nowiki>[[Spring]]</nowiki></samp> will work. Also, if~~ the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.,'' <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.		** The seasons should be provided as plain text (unlinked). If the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.,'' <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.

	* '''''day'''''		* '''''day'''''
Line 45:		Line 44:
	* '''sortkey=true'''		* '''sortkey=true'''
	** If set, a hidden span containing a numeric sortkey will be added to the output, to improve table sorting. The sortkey will causes seasons to be sorted in order Spring, Summer, Fall, Winter, instead of being sorted alphabetically. Plus any provided <samp>day</samp> will be included in the sortkey.		** If set, a hidden span containing a numeric sortkey will be added to the output, to improve table sorting. The sortkey will causes seasons to be sorted in order Spring, Summer, Fall, Winter, instead of being sorted alphabetically. Plus any provided <samp>day</samp> will be included in the sortkey.

	* '''space=''value'''
	** Provide the text that will separate multiple seasons. Default value is " • ".

	* '''text_only=true'''
	** When set, return value is just the name of the season (no icon, no link), in wiki-specific language
	** Allows other templates to use Template:Season for processing of generic season input data (especially on non-english wikis where translation capabilities may be wanted).

	* '''no_translate=true'''
	** When set, any <samp>text_only</samp> return value is provided in English, instead of the wiki-specific language
	** Only relevant if <samp>text_only</samp> is set.

	===Examples===		===Examples===
Line 62:		Line 50:
	{{Season\|Marriage}}		{{Season\|Marriage}}
	{{Season\|Deviations}}		{{Season\|Deviations}}
	~~{{Season\|All\|do_short=true}}~~
	{{Season\|All\|size=48}}		{{Season\|All\|size=48}}
	{{Season\|Summer\|24}}		{{Season\|Summer\|24}}
	~~{{Season\|Spring,Summer\|space=/\|sortkey=true}}~~
	</pre>		</pre>

Line 73:		Line 59:
	{{Season\|Marriage}}<br />		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br />		{{Season\|Deviations}}<br />
	~~{{Season\|All\|do_short=true}}<br />~~
	{{Season\|All\|size=48}}<br />		{{Season\|All\|size=48}}<br />
	{{Season\|Summer\|24}}<br />		{{Season\|Summer\|24}}<br />
	~~{{Season\|Spring,Summer\|space= / \|sortkey=true}}~~

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

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

2021-11-08T00:39:51Z

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

← Older revision		Revision as of 00:39, 8 November 2021
Line 24:		Line 24:
	** Multiple seasons can be specified, separated by commas		** Multiple seasons can be specified, separated by commas
	** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).		** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).
	** The seasons should be provided as plain text (unlinked). However, to allow the template to work regardless of user input choices, links such as <samp><nowiki>[[Spring]]</nowiki></samp> will work. Also, if the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.'', <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.		** The seasons should be provided as plain text (unlinked). However, to allow the template to work regardless of user input choices, links such as <samp><nowiki>[[Spring]]</nowiki></samp> will work. Also, if the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.,'' <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.

	* '''''day'''''		* '''''day'''''
Line 36:		Line 36:

	* '''width=''widthpluspx'''''		* '''width=''widthpluspx'''''
	** Size of icons in pixels ''with px'' (''e.g.'', <nowiki>width=24px</nowiki>).		** Size of icons in pixels ''with px'' (''e.g.,'' <nowiki>width=24px</nowiki>).
	** This is redundant with <samp>size</samp> and inconsistent (expects a different format); only one (preferably <samp>size</samp>) should be used.		** This is redundant with <samp>size</samp> and inconsistent (expects a different format); only one (preferably <samp>size</samp>) should be used.
	** This parameter is included solely for backwards compatibility and is deprecated		** This parameter is included solely for backwards compatibility and is deprecated

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

2021-11-07T23:43:45Z

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

← Older revision		Revision as of 23:43, 7 November 2021
Line 36:		Line 36:

	* '''width=''widthpluspx'''''		* '''width=''widthpluspx'''''
	** Size of icons in pixels ''with px'' (e.g., <nowiki>width=24px</nowiki>).		** Size of icons in pixels ''with px'' (''e.g.'', <nowiki>width=24px</nowiki>).
	** This is redundant with <samp>size</samp> and inconsistent (expects a different format); only one (preferably <samp>size</samp>) should be used.		** This is redundant with <samp>size</samp> and inconsistent (expects a different format); only one (preferably <samp>size</samp>) should be used.
	** This parameter is included solely for backwards compatibility and is deprecated		** This parameter is included solely for backwards compatibility and is deprecated

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

2021-11-07T23:29:01Z

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

← Older revision		Revision as of 23:29, 7 November 2021
Line 24:		Line 24:
	** Multiple seasons can be specified, separated by commas		** Multiple seasons can be specified, separated by commas
	** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).		** If an unrecognized season name is provided, the template will simply print out that name (no link, no icon).
	** The seasons should be provided as plain text (unlinked). However, to allow the template to work regardless of user input choices, links such as <samp><nowiki>[[Spring]]</nowiki></samp> will work. Also, if the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, e.g., <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.		** The seasons should be provided as plain text (unlinked). However, to allow the template to work regardless of user input choices, links such as <samp><nowiki>[[Spring]]</nowiki></samp> will work. Also, if the <samp>''season''</samp> already contains any type of image link, the template will just return the input value unaltered (in case user input already included the season call, ''e.g.'', <samp><nowiki>{{Season\|Spring}}</nowiki></samp>.

	* '''''day'''''		* '''''day'''''

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

2021-11-04T22:06:45Z

Text replacement - "<br/>" to "<br />"

← Older revision		Revision as of 22:06, 4 November 2021
Line 68:		Line 68:
	</pre>		</pre>

	Results:<br/>		Results:<br />
	{{Season\|Spring}}<br/>		{{Season\|Spring}}<br />
	{{Season\|Summer, Fall, Winter}}<br/>		{{Season\|Summer, Fall, Winter}}<br />
	{{Season\|Marriage}}<br/>		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br/>		{{Season\|Deviations}}<br />
	{{Season\|All\|do_short=true}}<br/>		{{Season\|All\|do_short=true}}<br />
	{{Season\|All\|size=48}}<br/>		{{Season\|All\|size=48}}<br />
	{{Season\|Summer\|24}}<br/>		{{Season\|Summer\|24}}<br />
	{{Season\|Spring,Summer\|space= / \|sortkey=true}}		{{Season\|Spring,Summer\|space= / \|sortkey=true}}

	<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 20:41, 6 May 2022
Line 47:		Line 47:
	===Examples===		===Examples===
	<pre>{{Season\|Spring}}		<pre>{{Season\|Spring}}
	~~{{Season\|Summer, Fall, Winter}}~~
	{{Season\|Marriage}}		{{Season\|Marriage}}
	{{Season\|Deviations}}		{{Season\|Deviations}}
Line 56:		Line 55:
	Results:<br />		Results:<br />
	{{Season\|Spring}}<br />		{{Season\|Spring}}<br />
	~~{{Season\|Summer, Fall, Winter}}<br />~~
	{{Season\|Marriage}}<br />		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br />		{{Season\|Deviations}}<br />

← Older revision		Revision as of 22:06, 4 November 2021
Line 68:		Line 68:
	</pre>		</pre>

	Results:<br/>		Results:<br />
	{{Season\|Spring}}<br/>		{{Season\|Spring}}<br />
	{{Season\|Summer, Fall, Winter}}<br/>		{{Season\|Summer, Fall, Winter}}<br />
	{{Season\|Marriage}}<br/>		{{Season\|Marriage}}<br />
	{{Season\|Deviations}}<br/>		{{Season\|Deviations}}<br />
	{{Season\|All\|do_short=true}}<br/>		{{Season\|All\|do_short=true}}<br />
	{{Season\|All\|size=48}}<br/>		{{Season\|All\|size=48}}<br />
	{{Season\|Summer\|24}}<br/>		{{Season\|Summer\|24}}<br />
	{{Season\|Spring,Summer\|space= / \|sortkey=true}}		{{Season\|Spring,Summer\|space= / \|sortkey=true}}

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