Changes

2,865 bytes added ,  15:56, 5 September 2020
full documentation
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.
 +
 +
The icon and text are enclosed in a nowrap span, so that they are always displayed on the same line.
 +
 +
==Notes==
 +
The template recognizes two special values of season, <tt>Marriage</tt> and <tt>Deviations</tt>, for the sake of NPC schedule pages (see [[Template:ScheduleHeader]]).
 +
 
==Usage==
 
==Usage==
<pre>{{Season|Spring}}
+
===Syntax===
{{Season|Summer}}
+
Basic usage:
{{Season|Fall}}
+
<nowiki>{{</nowiki>[[Template:Season|Season]] | ''season'' <nowiki>}}</nowiki>
{{Season|Winter}}
+
 
{{Season|Marriage}}
+
Complete argument list:
{{Season|Deviations}}
+
<nowiki>{{</nowiki>[[Template:Season|Season]] | ''season'' | size=''px'' | width=''widthpluspx'' | do_short=true
{{Season|All}}</pre>
+
          | text_only=true | no_translate=true <nowiki>}}</nowiki>
 +
 
 +
===Parameters===
 +
There is one unnamed, required parameter, ''season''.  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: <tt>Spring, Summer, Fall, Winter, All Seasons, Marriage, Deviations</tt>.  <tt>All</tt> and <tt>Any</tt> are recognized as synonyms for <tt>All Seasons</tt>.
 +
** 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).
 +
** The seasons should be provided as plain text (unlinked). However, to allow the template to work regardless of user input choices, links such as <tt><nowiki>[[Spring]]</nowiki></tt> will work. Also, if the <tt>''season''</tt> 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., <tt><nowiki>{{Season|Spring}}</nowiki></tt>.
 +
 
 +
* '''size=''px'''''
 +
** Size of icon in pixels.  Default value is 24
 +
** Only the number should be provided (do not append "px").
   −
{{Season|Spring}}
+
* '''width=''widthpluspx'''''
 +
** Size of icons in pixels ''with px'' (e.g., <nowiki>width=24px</nowiki>).
 +
** This is redundant with <tt>size</tt> and inconsistent (expects a different format); only one (preferably <tt>size</tt>) should be used.
 +
** This parameter is included solely for backwards compatibility and is deprecated
   −
{{Season|Summer}}
+
* '''do_short=true'''
 +
** Relevant only if <tt>''season''</tt> is <tt>All Seasons</tt> (or a synonym): when <tt>do_short</tt> is set, <tt>All</tt> will be displayed instead of <tt>All Seasons</tt>
   −
{{Season|Fall}}
+
* '''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).
   −
{{Season|Winter}}
+
* '''no_translate=true'''
 +
** When set, any <tt>text_only</tt> return value is provided in English, instead of the wiki-specific language
 +
** Only relevant if <tt>text_only</tt> is set.
    +
===Examples===
 +
<pre>{{Season|Spring}}
 +
{{Season|Summer, Fall, Winter}}
 
{{Season|Marriage}}
 
{{Season|Marriage}}
   
{{Season|Deviations}}
 
{{Season|Deviations}}
 +
{{Season|All|do_short=true}}
 +
{{Season|All|size=48}}</pre>
   −
{{Season|All}}
+
* {{Season|Spring}}
 +
* {{Season|Summer, Fall, Winter}}
 +
* {{Season|Marriage}}
 +
* {{Season|Deviations}}
 +
* {{Season|All|do_short=true}}
 +
* {{Season|All|size=48}}
   −
==Notes==
  −
Note that Season Marriage and Season Deviations were added for inclusion into [[Template:ScheduleHeader]]
   
<includeonly>[[Category:Formatting templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Formatting templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>{{Addlanglinks}}</includeonly>