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

From Stardew Valley Wiki
Jump to navigation Jump to search
 
(11 intermediate revisions by 2 users not shown)
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.
+
==Use==
 +
<pre>{{Weather inline|type of weather|width (optional)}}</pre>
  
−
==Notes==
+
==Valid Parameters==
−
* 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 9 valid types of weather. All are case-insensitive.
−
* 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.
+
*All / Any = {{Weather inline|All}}
 +
*Sun = {{Weather inline|Sun}}
 +
*Springwind = {{Weather inline|Springwind}}
 +
*Fallwind = {{Weather inline|Fallwind}}
 +
*Rain = {{Weather inline|Rain}}
 +
*Storm = {{Weather inline|Storm}}
 +
*Snow = {{Weather inline|Snow}}
 +
*Festival = {{Weather inline|Festival}}
  
−
==Usage==
+
==Width==
−
===Syntax===
+
Specify the width in pixels, and include "px".
−
Basic usage:
+
<pre>{{Weather inline|Snow|width=24px}}</pre>
−
<nowiki>{{</nowiki>[[Template:Weather inline|Weather inline]] | ''weather'' <nowiki>}}</nowiki>
+
{{Weather inline|Snow|width=24px}}
−
 
+
<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
−
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.
 
−
 
 
−
==Usage==
 
−
 
 
−
<pre>*{{Weather inline|sunny}}
 
−
*{{Weather inline|rain}}
 
−
*{{Weather inline|POLLEN}} or {{Weather inline|wind}}
 
−
*{{Weather inline|springwind}}
 
−
*{{Weather inline|stormy}}
 
−
*{{Weather inline|Snowy}}</pre>
 
−
 
 
−
*{{Weather inline|sunny}}
 
−
*{{Weather inline|rain}}
 
−
*{{Weather inline|POLLEN}}
 
−
*{{Weather inline|springwind}}
 
−
*{{Weather inline|stormy}}
 
−
*{{Weather inline|Snowy}}
 
−
 
 
−
<pre>{{Weather inline|sUN, Rainy|space=&#32;/&#32;}}</pre>
 
−
{{Weather inline|sUN, Rainy|space=&#32;/&#32;}}
 
−
<includeonly>[[Category:Formatting templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 

Latest revision as of 21:24, 8 January 2023

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

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Weather_inline/doc&oldid=145259"