Template:Infobox/doc: Difference between revisions

Jump to navigation Jump to search
4,128 bytes added ,  23:05, 1 May 2023
add more content - still very much WIP
(Stub article - nowhere near complete)
 
(add more content - still very much WIP)
Line 1: Line 1:
==Description==
==Description==
This template creates an Info Box with information key information about a page, or properties of an item. It automatically adds select categories to a page based on values provided.
This template creates an Info Box with information key information about a page, or properties of an item. It automatically adds select categories to a page based on values provided. <!--It is very versatile and used for many times of items across the wiki.-->


==Usage==
==Usage==
The convention is to add an ''infobox'' section as the first item on the page. There are multiple possible parameters, which will be outlined below.
The convention is to add an ''infobox'' section as the first item on the page. There are multiple possible parameters, which will be outlined below.


{{infobox
|name=Vintage Phonograph
|image=Vintage Phonograph (Gold).png
|type=Furniture
|category=Decor, Misc.
|buyprice=6400
|color=yellow, brown
|tags=Traditional, Rustic, Rec Room, Study, Living Room
|universe=Other
|from={{name|Scrooge's Store}}
|storeSlot=quad FL
|size=2x2
|placement=surfaces
}}
was created from...
<pre>
<pre>
{{infobox
{{infobox
Line 19: Line 34:
|size=2x2
|size=2x2
|placement=surfaces
|placement=surfaces
}}
</pre>
or
{{infobox
|image=Pumpkin Soup.png
|description=A thick, creamy soup with an orange hue.
|type=Meal
|category=Appetizers
|stars=4
|energy=1431
|sellprice=1500
|ingredients={{ingredient|Vegetables}}
{{name|Milk}}<br>
{{name|Ginger}}<br>
{{name|Pumpkin}}
}}
was created from...
<pre>
{{infobox
|image=Pumpkin Soup.png
|description=A thick, creamy soup with an orange hue.
|type=Meal
|category=Appetizers
|stars=4
|energy=1431
|sellprice=1500
|ingredients={{name|Pumpkin}}<br>
{{name|Ginger}}<br>
{{name|Milk}}<br>
{{ingredient|Vegetables}}
}}
</pre>
or
{{infobox
|image=Iron Crafting Station.png
|type=Crafted Furniture
|craftingcategory=Functional Items
|functions=Crafting Station
|category=none
|color=
|tags=
|universe=Other
|reward={{quest|Scrooge McDuck's Grand Re-opening|realm=Story|friendship=Scrooge McDuck}}
|recipe={{name|Iron Ingot|10}}<br>
{{name|Hardwood|10}}<br>
{{name|Topaz}}
}}
was created from...
<pre>
{{infobox
|image=Iron Crafting Station.png
|type=Crafted Furniture
|craftingcategory=Functional Items
|functions=Crafting Station
|category=none
|color=
|tags=
|universe=Other
|reward={{quest|Scrooge McDuck's Grand Re-opening|realm=Story|friendship=Scrooge McDuck}}
|recipe={{name|Iron Ingot|10}}<br>
{{name|Hardwood|10}}<br>
{{name|Topaz}}
}}
}}
</pre>
</pre>
Line 29: Line 114:
</pre>
</pre>
'''name''' only needs to be provided if the name of the item differs from the name of the page. This happens in cases where there are multiple items with identical names, or the actual name contains a character that cannot be used in a page name.
'''name''' only needs to be provided if the name of the item differs from the name of the page. This happens in cases where there are multiple items with identical names, or the actual name contains a character that cannot be used in a page name.


====image====
====image====
Line 34: Line 120:
|image=Vintage Phonograph (Gold).png
|image=Vintage Phonograph (Gold).png
</pre>
</pre>
<!--'''image'''... TODO DESCRIPTION-->
'''image''' specifies the full file name, including extension, of the focal image to use in the infobox. The image and the page should be named identically.
 


====width====
====width====
Line 40: Line 127:
|width=350px
|width=350px
</pre>
</pre>
'''width''' controls the width of the image in the infobox.
'''width''' controls the width of the image in the infobox. This is typically not necessary to specify, and can be omitted. <!-- The default value is XXX -->
 


====type====
====type====
Line 46: Line 134:
|type=Furniture
|type=Furniture
</pre>
</pre>
Possible Values:
<!--
*
'''type''' specifies...Possible Values:
*
*Clothing
*
*Furniture
<!--'''type''' controls.... -->
*Crafted Furniture
*Meal
*....-->
 
====craftingcategory====
<pre>
|craftingcategory=Functional Items
</pre>
<!--'''craftingcategory''' specifies.... Whether single or multiple values. Requirements for providing value. Any nuances about values. When displayed in the infobox, if any templates are used or categories are automatically added. Possible Values:
*Functional Items
-->


====category====
====category====
Line 56: Line 154:
|category=Decor, Misc.
|category=Decor, Misc.
</pre>
</pre>
<!-- Possible Values: TODO -->
'''category''' specifies the category filters associated with the item. There can be multiple categories. If the value is "none", the item has no associated colors, and it will ONLY display in results when the All category filter is selected. Categories should be provided in the same order that they appear in the furniture and clothing menu. If creating a new item page and/or all categories have not been confirmed, add '''Category: Missing Categories''' to the bottom of the page, and leave the parameter blank. <!-- Possible Values: TODO -->
<!--'''category''' controls.... -->
<!--|category=Entrées-->
 
 
====stars (Meals)====
<pre>
|stars=4
</pre>
'''stars''' specifies the number of Stars a Meal Recipe has, which corresponds directly to how many Ingredients it requires. When displayed in the infobox, it will be displayed with the '''''stars''''' template. <!--TODO VERIFY-->
 
 
====energy (Meals)====
<pre>
|energy=1431
</pre>
'''energy''' specifies how much energy the Player gains by consuming the item. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the '''''energy''''' template. <!--TODO VERIFY-->
 


====buyprice====
====buyprice====
Line 63: Line 176:
|buyprice=6400
|buyprice=6400
</pre>
</pre>
<!-- Possible Values: TODO -->
'''buyprice''' specifies the number of Star Coins that are required to purchase this item from Scrooge's Store, Goofy's Stall, or Prince Eric's Blueprint Table. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the '''''price''''' template. <!--TODO VERIFY-->
<!--'''buyprice''' controls.... -->
 


====type====
====sellprice====
<pre>
<pre>
|type=Furniture
|sellprice=1500
</pre>
</pre>
<!-- Possible Values: TODO -->
'''sellprice''' specifies the number of Star Coins that are obtained in exchange for selling this item at Goofy's Stall or serving this meal at Chez Remy. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the '''''price''''' template. <!--TODO VERIFY-->
<!--'''XXXXXX''' controls.... -->
 


====color====
====color (Clothing, Furniture)====
<pre>
<pre>
|color=yellow, brown
|color=yellow, brown
</pre>
</pre>
<!-- Possible Values: TODO -->
<!-- Possible Values: TODO -->
'''color''' specifies the color filters associated with the item. There can be multiple colors. If the value is "none", the item has no associated colors, and it will ONLY display when no color filters are selected. They should be provided in the same order that the colors appear in the furniture and clothing menu. <!--Possible Values: TODO-->
'''color''' specifies the color filters associated with the Clothing or Furniture item. There can be multiple colors. If the value is "none", the item has no associated colors, and it will ONLY display in results when no color filters are selected. Colors should be provided in the same order that they appear in the furniture and clothing menu. If creating a new item page and all colors have not been confirmed, add '''Category: Missing Colors''' to the bottom of the page, and leave the parameter blank.<!--Possible Values: TODO-->


====tags====
====tags (Clothing, Furniture)====
<pre>
<pre>
|tags=Traditional, Rustic, Rec Room, Study, Living Room
|tags=Traditional, Rustic, Rec Room, Study, Living Room
</pre>
</pre>
<!--'''tags''' specifies.... both the tags values and the location. There can be multiple tags. If the value is "none", the item has no associated tags or XXXX, and it will ONLY display when no tags or XXXX filters are selected. When displayed in the infobox, they call the '''''tag''''' template. They should be provided in the same order that they appear in Scrooge's Shop and Scrooge's Catalog.--><!-- Possible Values: TODO -->
<!--'''tags''' specifies.... both the tags values and the location. There can be multiple tags. If the value is "none", the item has no associated tags or XXXX, and it will ONLY display in results when no tags or XXXX filters are selected. When displayed in the infobox, they call the '''''tag''''' template. Tags should be provided in the same order that they appear in Scrooge's Shop and Scrooge's Catalog. If creating a new item page and all tags have not been confirmed, add '''Category: Missing Tags''' to the bottom of the page, and leave the parameter blank. If you suspect that a page is missing tags, check the page's history log first, and then add Missing Tags if you think the item needs verification.--><!-- Possible Values: TODO -->


====universe====
 
====universe (Clothing, Furniture)====
<pre>
<pre>
|universe=Other
|universe=Other
</pre>
</pre>
'''universe''' specifies the Universe associated with the item. There can only be one Universe associated. If the value is "none", the item has no associated Universe - it will ONLY display when no Universe filters are selected. <!--Possible Values: TODO-->
'''universe''' specifies the Universe associated with the Clothing or Furniture item. There can only be one Universe associated. If the value is "none", the item has no associated Universe - it will ONLY display in results when no Universe filters are selected. <!--Possible Values: TODO-->
 


====from====
====from====
Line 97: Line 212:
</pre>
</pre>
<!-- Possible Values: TODO -->
<!-- Possible Values: TODO -->
<!--'''universe''' controls.... -->
<!--'''from''' specifies.... -->
 


====storeSlot====
====storeSlot (Clothing, Furniture)====
<pre>
<pre>
|storeSlot=quad FL
|storeSlot=quad FL
</pre>
</pre>
<!-- Possible Values: TODO -->
<!--'''storeSlot''' specifies.... If creating a new item page and the storeSlot has not been confirmed, add '''Category: Missing Store Slot''' to the bottom of the page, and leave the parameter blank.--><!-- Possible Values: TODO -->
<!--'''universe''' controls.... -->
 
 
 
====ingredients (Meals)====
<pre>
|ingredients={{name|Pumpkin}}<br>
{{name|Ginger}}<br>
{{name|Milk}}<br>
{{ingredient|Vegetables}}
}}
</pre>
<!--'''ingredients''' specifies.... Whether single or multiple values. Requirements for providing value. Any nuances about values. When displayed in the infobox, if any templates are used or categories are automatically added.-->
 
====recipe (Crafting)====
<pre>
|recipe={{name|Iron Ingot|10}}<br>
{{name|Hardwood|10}}<br>
{{name|Topaz}}
}}
</pre>
<!--'''recipe''' specifies.... Whether single or multiple values. Requirements for providing value. Any nuances about values. When displayed in the infobox, if any templates are used or categories are automatically added.-->


====size====
====size====
Line 110: Line 246:
|size=2x2
|size=2x2
</pre>
</pre>
<!-- Possible Values: TODO -->
<!--'''size''' specifies.... --><!-- Possible Values: TODO -->
<!--'''universe''' controls.... -->
 


====placement====
====placement====
Line 117: Line 253:
|placement=surfaces
|placement=surfaces
</pre>
</pre>
<!-- Possible Values: TODO -->
<!--'''placement''' specifies.... --><!-- Possible Values: TODO -->
<!--'''universe''' controls.... -->
 


<!--
<!--
====XXXXXX====
<pre>
<pre>
{{history|1.0|Added}}
|XXXXXX=XXXXXX
{{history|1.2|Changed name from ''Purple Couch''}}
{{history|1.3|Updated appearance and image}}
</pre>
</pre>
results in...
'''XXXXXX''' specifies.... Whether single or multiple values. Requirements for providing value. Any nuances about values. When displayed in the infobox, if any templates are used or categories are automatically added. Possible Values: XXXXXXX -->
 
{{history|1.0|Added}}
{{history|1.2|Changed name from ''Purple Couch''}}
{{history|1.3|Updated appearance and image}}
 
==Version==
This parameter is game version number which published the change.


This value is linked and displayed through [[:Template:Version|Template:Version]]. For full details about format and accepted values see the documentation and examples for [[:Template:Version|that template]].
==Changes==
This parameter lists changes that happened in the associated version. The first listed version is commonly when something is introduced - simply listed as '''Added'''. Each version where there is a change after that version should be listed, and all changes to that version should be contained inside the same template.
If there are multiple changes to the same version separate each change by comma inside the same template parameter.
For language standardization the wiki uses the following descriptions when listing changes;
* '''Item renaming''': Only the previous item name needs listed in changes. For example: ''Changed name from PREVIOUS NAME''
* '''Price changes''': List both the previous price and the new price. For example: Increased purchase price from ''OLD PRICE'' to ''NEW PRICE''
* '''Catalog Thumbnail updated''': Describe as ''Updated image''
* '''Model appearance updated''': Describe as ''Updated appearance''
* '''Both thumbnail and model updated''': Describe as ''Updated appearance and image''
-->
<includeonly>[[Category:General wiki templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>[[Category:General wiki templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
moderator
27,229

edits

Navigation menu