Difference between revisions of "Template:Weather inline/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
m (Text replacement - "{{Weather inline|Snowy}}" to "{{Weather inline|Snow}}")
(update)
Line 1: Line 1:
[[Template:Weather inline|Weather inline]] displays the icon for the requested weather, plus the weather name as a link to the weather article. One or more types of weather may be specified, separated by commas.
+
==Description==
 
+
This template displays the icon for the type of weather, plus a link to the associated wiki page.
The icon and text are enclosed in a nowrap span, so that they are always displayed on the same line.
 
 
 
==Notes==
 
* Parameters can be entered with or without "y" at the end (''e.g.,'' Sunny or Sun, Rainy or rain, etc.).  Capitalization does not matter.
 
* There are two different icons for wind, Pollen ([[File:Pollen fall.png]]) and Springwind ([[File:Pollen spring.png]]). Both are displayed using the label Wind.
 
 
 
==Usage==
 
===Syntax===
 
Basic usage:
 
<nowiki>{{</nowiki>[[Template:Weather inline|Weather inline]] | ''weather'' <nowiki>}}</nowiki>
 
 
 
Complete argument list:
 
<nowiki>{{</nowiki>[[Template:Weather inline|Weather inline]] | ''weather''
 
          | size=''px'' | width=''widthpluspx'' | all=''text_for_all'' | sortkey=true | space=''value''
 
          | text_only=true | no_translate=true <nowiki>}}</nowiki>
 
 
 
===Parameters===
 
There is one unnamed required parameter, ''weather''.  All other parameters are named and optional.  Default value for all arguments is empty, unless specified otherwise.
 
 
 
All parameters other than ''weather'' are identical in meaning to [[Template:Season]]; see Season for documentation.
 
  
 
==Use==
 
==Use==
 +
<pre>{{Weather inline|type of weather|width (optional)}}</pre>
  
<pre>*{{Weather inline|sunny}}
+
==Valid Parameters==
*{{Weather inline|rain}}
+
There are 9 valid types of weather. All are case-insensitive.
*{{Weather inline|POLLEN}} or {{Weather inline|wind}}
+
*All / Any = {{Weather inline|All}}
*{{Weather inline|springwind}}
+
*Sun = {{Weather inline|Sun}}
*{{Weather inline|stormy}}
+
*Springwind = {{Weather inline|Springwind}}
*{{Weather inline|Snow}}
+
*Fallwind = {{Weather inline|Fallwind}}
*{{Weather inline|Festival}}</pre>
+
*Rain = {{Weather inline|Rain}}
 
+
*Storm = {{Weather inline|Storm}}
*{{Weather inline|sunny}}
+
*Snow = {{Weather inline|Snow}}
*{{Weather inline|rain}}
+
*Festival = {{Weather inline|Festival}}
*{{Weather inline|POLLEN}}
 
*{{Weather inline|springwind}}
 
*{{Weather inline|stormy}}
 
*{{Weather inline|Snow}}
 
*{{Weather inline|Festival}}
 
  
<pre>{{Weather inline|sUN, Rainy|space=&#32;/&#32;}}</pre>
+
==Width==
{{Weather inline|sUN, Rainy|space=&#32;/&#32;}}
+
Specify the width in pixels, and include "px".
 +
<pre>{{Weather inline|Snow|width=24px}}</pre>
 +
{{Weather inline|Snow|width=24px}}
 
<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 18:52, 18 May 2022

Description

This template displays the icon for the type of weather, plus a link to the associated wiki page.

Use

{{Weather inline|type of weather|width (optional)}}

Valid Parameters

There are 9 valid types of weather. All are case-insensitive.

Width

Specify the width in pixels, and include "px".

{{Weather inline|Snow|width=24px}}

Snow.png Snow