Difference between revisions of "Template:Infobox/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Syntax: new {{{image size}}} parameter)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Infobox
 
−
|name            = 
 
−
|image          =
 
−
|description    =
 
−
|source          =
 
−
|season          =
 
−
|craftingstation =
 
−
|ingredients    =
 
−
|sellprice      =
 
−
}}
 
−
 
 
==Description==
 
==Description==
−
This template is designed to display [[:Category:Items|items]] and their details, such as [[crops]], [[fish]], [[tools]], [[weapons]], [[artifacts]], etc.
+
This template displays a generic infobox for a wide variety of items. '''Do not use this on your user page. It is reserved for content pages.'''
−
 
 
−
==Usage==
 
−
===Placement===
 
−
This template should be placed at the top of an article page (it will automatically align right). Alert templates, such as <nowiki>{{stub}}</nowiki> or <nowiki>{{construction}}</nowiki>, can be placed above this template.
 
−
 
 
−
===Additional Information===
 
−
The ''image2 - image4'' parameters can be used to display more than one image file, in certain cases. For example,[[File:Egg.png|32px]][[File:Brown_Egg.png|32px]] ([[Egg]] and [[Egg|Brown Egg]]).
 
−
 
−
This template will automatically populate links from plain text. Source and season will automatically scan for associate articles and make links if they exist.
 
−
 
 
−
Crafting requirements are detailed by nesting ingredients in the [[Template:Name|Name]] template, as well as the crafting station. This template will automatically attach a picture, along with the link to the item's page.
 
−
 
 
−
Quality allows for true or false, as well as a list of qualities to show. This ensures that items that never have a certain quality will never show the value for that. An alternative way to handle this would be introducing <nowiki>{{{silver}}}</nowiki> and <nowiki>{{{gold}}}</nowiki> parameters.
 
−
 
 
−
===Syntax===
 
−
<pre>
 
−
{{Infobox
 
−
|name            = Name of Item (Page name if omitted)
 
−
|image          = file_name.png (Page name.png if omitted)
 
−
|image size      = size to display image at (48px if omitted)
 
−
|description    = Ingame description of the item
 
−
|location        = [[foraging location]]
 
−
|source          = Farming / Quest / Shop
 
−
|seed            = [[seed name]]
 
−
|season          = Spring / Winter / Fall / Summer
 
−
|growth          = 4 days
 
−
|buff            = buff effects
 
−
|buffduration    = buff duration
 
−
|craftingstation = {{name|Preserves Jar}} <- use the name template, then list the station name
 
−
|ingredients    = {{name|Fish|13}} {{name|item|#}} <- use the name template, then list the item and # of ingredient needed
 
−
|edibility      = 20
 
−
|sellprice      = 14
 
−
|type            = fruit / vegetable
 
−
|iridium        = true <- add iridium quality stars rating
 
−
|quality        = true / false / list of qualities to show
 
−
|profession      = Rancher / Tiller / Artisan / Blacksmith / Gemologist / Forester / Tapper / Fisher / Angler
 
−
|modifier        = Manual profession modifier
 
−
}}
 
−
</pre>
 
−
 
 
−
==Samples==
 
−
<pre>
 
−
{{Infobox
 
−
|name            = Corn
 
−
|image          = Corn.png
 
−
|description    = Plant these in the spring. Takes 10 days to mature, but keeps producing after that. Yields multiple beans per harvest. Grows on a trellis.
 
−
|source          = Farming
 
−
|season          = [[Spring]]
 
−
|craftingstation = {{name|Preserves Jar}}
 
−
|ingredients    = {{name|Fish|13}} {{name|Tomato Seeds|13}}
 
−
|edibility      = 10
 
−
|type            = vegetable
 
−
|sellprice      = 14
 
−
|iridium        = true
 
−
|profession      = Rancher,Fisher
 
−
}}
 
−
</pre>
 
−
 
 
−
Results in...
 
−
{{Infobox
 
−
|name            = Corn
 
−
|image          = Corn.png
 
−
|description    = Plant these in the spring. Takes 10 days to mature, but keeps producing after that. Yields multiple beans per harvest. Grows on a trellis.
 
−
|source          = Farming
 
−
|season          = [[Spring]]
 
−
|craftingstation = {{name|Preserves Jar}}
 
−
|ingredients    = {{name|Fish|13}} {{name|Tomato Seeds|13}}
 
−
|edibility      = 10
 
−
|type            = vegetable
 
−
|sellprice      = 14
 
−
|iridium        = true
 
−
|profession      = Rancher,Fisher
 
−
}}
 
−
 
 
−
<pre style="clear:both;">
 
−
{{Infobox
 
−
|name            = Corn
 
−
|location        = [[Pelican Town]]
 
−
|image          =
 
−
|description    = Plant these in the spring. Takes 10 days to mature, but keeps producing after that. Yields multiple beans per harvest. Grows on a trellis.
 
−
|seed            = [[Radish Seeds]]
 
−
|season          = Spring
 
−
|growth          = 6 days
 
−
|buff            = {{name|Foraging|+2}}{{name|Defense|+2}}
 
−
|buffduration    = 7m 41s
 
−
|craftingstation = {{name|Preserves Jar}}
 
−
|ingredients    = {{name|Fish|13}} {{name|Tomato Seeds|13}}
 
−
|edibility      = 10
 
−
|sellprice      = 14
 
−
|iridium        = true
 
−
|profession      = Fake profession
 
−
|modifier        = 0.75
 
−
|quality        = false
 
−
}}
 
−
</pre>
 
  
−
Results in...
+
==Parameters==
−
{{Infobox
+
All parameters are optional. If omitted, nothing will display.
−
|name           = Corn
+
{|class="wikitable sortable"
−
|location        = [[Pelican Town]]
+
|-
−
|image          =
+
!Parameter!!Notes
−
|description     = Plant these in the spring. Takes 10 days to mature, but keeps producing after that. Yields multiple beans per harvest. Grows on a trellis.
+
|-
−
|seed            = [[Radish Seeds]]
+
|eng||Name of the image to display, in English, without the ".png" extension.<br />If the image has an extension other than ".png", then the "ext" parameter must be used.
−
|season          = Spring
+
|-
−
|growth         = 6 days
+
|ext||Extension of image specified in "eng" parameter, without the period (''e.g.,'' "gif", "jpg", etc.)
−
|buff           = {{name|Foraging|+2}}{{name|Defense|+2}}
+
|-
−
|buffduration   = 7m 41s
+
|name||Name of item (Page name if omitted)<br />For use on pages like [[Trash (item)]] where the name of the item is different from the page name.
−
|craftingstation = {{name|Preserves Jar}}
+
|-
−
|ingredients    = {{name|Fish|13}} {{name|Tomato Seeds|13}}
+
|image2<br />image3<br />image4<br />image5||Name of additional images to display<br />Must be of type ".png"<br />Omit the extension (''e.g.,'' Tiger Slime Egg)
−
|edibility       = 10
+
|-
−
|sellprice       = 14
+
|image2spacing||Set to "true" to add extra space between the images specified in "eng" and "image2"
−
|profession      = Fake profession
+
|-
−
|modifier        = 0.75
+
|description||In-game item description<br />(Populated by [[:Template:Description]] if omitted). It is preferable to omit this parameter and update Template:Description instead.
−
|quality         = false
+
|-
−
}}<includeonly>[[Category:Infobox templates]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
|source||How to obtain the item (''e.g.,'' <nowiki>[[Crafting]], [[Artisan Goods]], [[Slime Egg-Press]]</nowiki>)
−
<includeonly>[[de:Vorlage:{{PAGENAME}}]]
+
|-
−
[[es:Plantilla:{{PAGENAME}}]]
+
|location||Location(s) of item (''e.g.,'' <nowiki>[[Cindersap Forest]], [[The Beach]], Bushes throughout the valley, etc.</nowiki>)
−
[[ja:テンプレート:{{PAGENAME}}]]
+
|-
−
[[pt:Predefinição:{{PAGENAME}}]]
+
|seed||Name of seed (''e.g.,'' <nowiki>{{Name|Corn Seeds}}</nowiki>)
−
[[ru:Шаблон:{{PAGENAME}}]]
+
|-
−
[[zh:Template:{{PAGENAME}}]]</includeonly>
+
|growth||Number of days the crop takes to grow to maturity (''e.g.,'' 4 days)
 +
|-
 +
|buff||Name of buff(s) given by the item (''e.g.,'' <nowiki>{{Name|Farming|+4}}</nowiki>)
 +
|-
 +
|buffduration||Length of time buff(s) are active
 +
|-
 +
|season||Name of season when the item can be obtained or grown<br />Can be plain text (''e.g.,'' Spring, Summer, All, etc.) or can use [[:Template:Season]] (''e.g.,'' <nowiki>{{Season|Summer}} • {{Season|Winter}}</nowiki>)
 +
|-
 +
|weather||Weather required to obtain the item<br />Can use plain text (''e.g.,'' Rain) and this template will automatically apply [[:Template:Weather inline]] formatting
 +
|-
 +
|xp||Experience points gained for harvesting or otherwise obtaining the item
 +
|-
 +
|edibility||Found in <samp>Data\ObjectInformation.xnb</samp><br />Note that inedible items have an edibility of -300, and poisonous items have a negative edibility greater than -300
 +
|-
 +
|sellprice||Found in <samp>Data\ObjectInformation.xnb</samp><br />If the item cannot be sold, then "N/A" and "Cannot be sold" are valid values
 +
|-
 +
|quality||Set to "false" to suppress silver, gold, and iridium qualities
 +
|-
 +
|recipe||How to obtain the recipe to craft the item (''e.g.,'' <nowiki>[[Farming]] Level 7</nowiki>)
 +
|-
 +
|craftingstation||Equipment used to craft the item (''e.g.,'' <nowiki>{{Name|Preserves Jar}}</nowiki>)
 +
|-
 +
|crafttime||How long does the item process in its equipment (''e.g.,'' 4 hours)
 +
|-
 +
|ingredients||Ingredients needed to craft the item (''e.g.,'' <nowiki>{{Name|Copper Bar|2}}{{Name|Sap|10}}</nowiki>)
 +
|-
 +
|tingredients||Ingredients with the [[Skills#Fishing|Trapper profession]]<br />''Used on the [[Crab Pot]] page''
 +
|-
 +
|produces||Item produced via crafting, artisan goods, or harvesting (''e.g.,'' 5 Deluxe Fertilizer per craft)
 +
|-
 +
|}<includeonly>[[Category:Infobox templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 18:30, 16 December 2022

Description

This template displays a generic infobox for a wide variety of items. Do not use this on your user page. It is reserved for content pages.

Parameters

All parameters are optional. If omitted, nothing will display.

Parameter Notes
eng Name of the image to display, in English, without the ".png" extension.
If the image has an extension other than ".png", then the "ext" parameter must be used.
ext Extension of image specified in "eng" parameter, without the period (e.g., "gif", "jpg", etc.)
name Name of item (Page name if omitted)
For use on pages like Trash (item) where the name of the item is different from the page name.
image2
image3
image4
image5		 Name of additional images to display
Must be of type ".png"
Omit the extension (e.g., Tiger Slime Egg)
image2spacing Set to "true" to add extra space between the images specified in "eng" and "image2"
description In-game item description
(Populated by Template:Description if omitted). It is preferable to omit this parameter and update Template:Description instead.
source How to obtain the item (e.g., [[Crafting]], [[Artisan Goods]], [[Slime Egg-Press]])
location Location(s) of item (e.g., [[Cindersap Forest]], [[The Beach]], Bushes throughout the valley, etc.)
seed Name of seed (e.g., {{Name|Corn Seeds}})
growth Number of days the crop takes to grow to maturity (e.g., 4 days)
buff Name of buff(s) given by the item (e.g., {{Name|Farming|+4}})
buffduration Length of time buff(s) are active
season Name of season when the item can be obtained or grown
Can be plain text (e.g., Spring, Summer, All, etc.) or can use Template:Season (e.g., {{Season|Summer}} • {{Season|Winter}})
weather Weather required to obtain the item
Can use plain text (e.g., Rain) and this template will automatically apply Template:Weather inline formatting
xp Experience points gained for harvesting or otherwise obtaining the item
edibility Found in Data\ObjectInformation.xnb
Note that inedible items have an edibility of -300, and poisonous items have a negative edibility greater than -300
sellprice Found in Data\ObjectInformation.xnb
If the item cannot be sold, then "N/A" and "Cannot be sold" are valid values
quality Set to "false" to suppress silver, gold, and iridium qualities
recipe How to obtain the recipe to craft the item (e.g., [[Farming]] Level 7)
craftingstation Equipment used to craft the item (e.g., {{Name|Preserves Jar}})
crafttime How long does the item process in its equipment (e.g., 4 hours)
ingredients Ingredients needed to craft the item (e.g., {{Name|Copper Bar|2}}{{Name|Sap|10}})
tingredients Ingredients with the Trapper profession
Used on the Crab Pot page
produces Item produced via crafting, artisan goods, or harvesting (e.g., 5 Deluxe Fertilizer per craft)
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Infobox/doc&oldid=144181"