Template:Goodbox - Revision history

76561197969631737: Updated to new infobox styles, information, etc. for resources.

2024-10-12T14:33:21Z

Updated to new infobox styles, information, etc. for resources.

← Older revision		Revision as of 14:33, 12 October 2024
Line 1:		Line 1:
	<includeonly>{{#invoke: Goodbox\|~~renderGoodbox~~		<includeonly>{{#invoke: Goodbox\|main
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
	~~\| purpose={{{purpose\|}}}~~
	~~\| species_preference={{{species_preference\|}}}~~
	}}		}}
	</includeonly>		</includeonly>

76561197969631737: adding Goods category--this will propagate to all pages that call this template

2024-10-01T03:04:27Z

adding Goods category--this will propagate to all pages that call this template

← Older revision		Revision as of 03:04, 1 October 2024
Line 3:		Line 3:
	\| purpose={{{purpose\|}}}		\| purpose={{{purpose\|}}}
	\| species_preference={{{species_preference\|}}}		\| species_preference={{{species_preference\|}}}
	}}</includeonly><noinclude>		}}
			</includeonly>
			<includeonly>[[Category:Goods]]</includeonly><noinclude>

	{{Goodbox\|name=Parts\|purpose=This is an example infobox}}		{{Goodbox\|name=Parts\|purpose=This is an example infobox}}

76561197969631737: Updated with new main method name

2023-11-28T01:02:33Z

Updated with new main method name

← Older revision		Revision as of 01:02, 28 November 2023
Line 1:		Line 1:
	<includeonly>{{#invoke: Goodbox\|~~infobox~~		<includeonly>{{#invoke: Goodbox\|renderGoodbox
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
	\| purpose={{{purpose\|}}}		\| purpose={{{purpose\|}}}

76561197969631737: added purpose to example template call

2023-11-18T16:25:12Z

added purpose to example template call

← Older revision		Revision as of 16:25, 18 November 2023
Line 5:		Line 5:
	}}</includeonly><noinclude>		}}</includeonly><noinclude>

	{{Goodbox\|name=Parts}}		{{Goodbox\|name=Parts\|purpose=This is an example infobox}}

	'''Goodbox''' is a template that creates an infobox on the page by displaying data provided by template parameters and loading data from the data template [[Template:Goods_csv]]. The infobox to the right on this page is an example.		'''Goodbox''' is a template that creates an infobox on the page by displaying data provided by template parameters and loading data from the data template [[Template:Goods_csv]]. The infobox to the right on this page is an example.

76561197969631737: Created for infoboxes on goods' pages

2023-11-07T21:46:37Z

Created for infoboxes on goods' pages

New page

<includeonly>{{#invoke: Goodbox|infobox
| name= {{{name| {{{1|}}} }}}
| purpose={{{purpose|}}}
| species_preference={{{species_preference|}}}
}}</includeonly><noinclude>

{{Goodbox|name=Parts}}

'''Goodbox''' is a template that creates an infobox on the page by displaying data provided by template parameters and loading data from the data template [[Template:Goods_csv]]. The infobox to the right on this page is an example.

== Overview ==

This template should be used for all [[Resources|Goods]] on the wiki. The template requires only the <code>name</code> parameter, which tells the code behind the scenes which Good you want an infobox for.

In the future, this template could be augmented to automatically create categories based on the information retrieved. For example, the infobox for [[Parts]] could add categories for building materials, rare goods, or even goods that are at the end of their production chain.

== Parameters ==

Only the first, <code>name</code> is required, and it must be spelled correctly to match the in-game name of the good. Other parameters are optional, but add to the value of displaying the infobox.

{|class="wikitable"
|-
! Parameter !! Type !! Description
|-
| name || string || '''Required.''' The in-game name of the good for which you want to display the infobox. Will also serve as the header of the box.
|-
| purpose || string || The overall purpose of the good, such as "Services" or "Complex Food" or omit this parameter. For example, if the purpose is "Crafting," the infobox will already show "Crafting Resources" for the good's ``Category,`` so you may omit it.
|-
| species_preference || string || For goods that are consumed by villagers, write which species prefers this good. For example, Biscuits are preferred by "Beaver, Harpy, Human."
|}

== Errors ==

When the template is called without a name, the template reminds you that it is required.

'''Example:'''

<pre>{{Goodbox}}</pre>

Yields:

{{Goodbox}}

When providing the name of a good, it is important that it is spelled correctly, including any punctuation. Otherwise, an error will return from the data module.

'''Example:'''

Broken: <code><nowiki>{{Goodbox|name=PlantFibre}}</nowiki></code>

{{Goodbox|name=PlantFibre}}

Fixed: <code><nowiki>{{Goodbox|name=Plant Fiber}}</nowiki></code>

{{Goodbox|name=Plant Fiber}}
</noinclude>