Template:Season/doc

From Stardew Valley Wiki
< Template:Season
Revision as of 15:59, 5 September 2020 by Nebulous Maestress (talk | contribs) (remove bullets (realized they could be misinterpreted as part of output))
Jump to navigation Jump to search

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, Marriage and Deviations, for the sake of NPC schedule pages (see Template:ScheduleHeader).

Usage

Syntax

Basic usage:

{{Season | season }}

Complete argument list:

{{Season | season | size=px | width=widthpluspx | do_short=true
         | text_only=true | no_translate=true }}

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: Spring, Summer, Fall, Winter, All Seasons, Marriage, Deviations. All and Any are recognized as synonyms for All Seasons.
    • 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 [[Spring]] will work. Also, if the season 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., {{Season|Spring}}.
  • 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., width=24px).
    • This is redundant with size and inconsistent (expects a different format); only one (preferably size) should be used.
    • This parameter is included solely for backwards compatibility and is deprecated
  • do_short=true
    • Relevant only if season is All Seasons (or a synonym): when do_short is set, All will be displayed instead of All Seasons
  • 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 text_only return value is provided in English, instead of the wiki-specific language
    • Only relevant if text_only is set.

Examples

{{Season|Spring}}
{{Season|Summer, Fall, Winter}}
{{Season|Marriage}}
{{Season|Deviations}}
{{Season|All|do_short=true}}
{{Season|All|size=48}}

Results:
Spring.png Spring
Summer, Fall, Winter
Mermaid's Pendant.png Marriage
Deviations
All Seasons Icon.png All
All Seasons Icon.png All