Template:Buildingbox - Revision history

76561197969631737: moving documentation to subpage

2024-10-31T01:55:13Z

moving documentation to subpage

@@ Line 1: / Line 1: @@
-<includeonly>{{#invoke: Buildingbox|main
+<includeonly>{{#invoke: Buildingbox | main
-	| name= {{{name| {{{1|}}} }}}
+|name = {{{name| {{{1|}}} }}}
-}}</includeonly>
+}}
-<includeonly>[[Category:Buildings]]</includeonly><noinclude>
+[[Category:Buildings]]</includeonly><noinclude>
-{{Buildingbox|name=Mine}}
+{{Documentation}}
 </noinclude>

76561197969631737: Quickly updating to match new module

2024-10-09T02:53:52Z

Quickly updating to match new module

← Older revision		Revision as of 02:53, 9 October 2024
Line 1:		Line 1:
	<includeonly>{{#invoke: Buildingbox\|~~renderBuildingbox~~		<includeonly>{{#invoke: Buildingbox\|main
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
	~~\| purpose={{{purpose\|}}}~~
	~~\| species_preference={{{species_preference\|}}}~~
	~~\| specializations={{{specializations\|}}}~~
	}}</includeonly>		}}</includeonly>
	<includeonly>[[Category:Buildings]]</includeonly><noinclude>		<includeonly>[[Category:Buildings]]</includeonly><noinclude>

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

2024-10-01T03:09:08Z

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

← Older revision		Revision as of 03:09, 1 October 2024
Line 4:		Line 4:
	\| species_preference={{{species_preference\|}}}		\| species_preference={{{species_preference\|}}}
	\| specializations={{{specializations\|}}}		\| specializations={{{specializations\|}}}
	}}</includeonly><noinclude>		}}</includeonly>
			<includeonly>[[Category:Buildings]]</includeonly><noinclude>

	{{Buildingbox\|name=Mine}}		{{Buildingbox\|name=Mine}}

76561197969631737: Made generic instead of specific to industry buildings

2023-12-24T16:28:52Z

Made generic instead of specific to industry buildings

← Older revision		Revision as of 16:28, 24 December 2023
Line 1:		Line 1:
	<includeonly>{{#invoke: ~~Shopbox~~\|~~renderShopbox~~		<includeonly>{{#invoke: Buildingbox\|renderBuildingbox
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
	\| purpose={{{purpose\|}}}		\| purpose={{{purpose\|}}}
Line 6:		Line 6:
	}}</includeonly><noinclude>		}}</includeonly><noinclude>

	{{~~Shopbox~~\|name=~~Cookhouse~~}}		{{Buildingbox\|name=Mine}}

	'''~~Shopbox~~''' 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:Workshops_csv]]~~. The infobox to the right on this page is an example.		'''Buildingbox''' is a template that creates an infobox on the page by displaying data provided by template parameters and loading data about the building corresponding to the name requested. The infobox to the right on this page is an example.

	== Overview ==		== Overview ==

	This template should be used for all ~~Production Buildings~~ on the ~~wiki~~, ~~that is~~, ~~buildings whose recipes convert goods into other goods~~. The template requires only the <code>name</code> parameter, which tells the code behind the scenes which building you want an infobox for.		This template should be used for all production, service, gathering, farming, and collecting buildings on the wiki—that is, any building with a recipe (not Hearths, Warehouses, or Housing). The template requires only the <code>name</code> parameter, which tells the code behind the scenes which building 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 the [[Cookhouse]] could add categories for food production, complex food, crafting materials, large buildings, or even 2-star buildings.		In the future, this template could be augmented to automatically create page categories based on the information retrieved. For example, the infobox for the [[Cookhouse]] could add categories for food production, complex food, crafting materials, large buildings, or even 2-star buildings.

	== Parameters ==		== Parameters ==
Line 39:		Line 39:
	'''Example:'''		'''Example:'''

	<pre>{{~~Shopbox~~}}</pre>		<pre>{{Buildingbox}}</pre>

	Yields:		Yields:

	{{~~Shopbox~~}}		{{Buildingbox}}

	When providing the name of a building, it is important that it is spelled correctly, including any punctuation. Otherwise, an error will return from the data module.		When providing the name of a building, it is important that it is spelled correctly, including any punctuation. Otherwise, an error will return from the data module.
Line 49:		Line 49:
	'''Example:'''		'''Example:'''

	Broken: <code><nowiki>{{~~Shopbox~~\|name=Alchemist Hut}}</nowiki></code>		Broken: <code><nowiki>{{Buildingbox\|name=Alchemist Hut}}</nowiki></code>

	{{~~Shopbox~~\|name=Alchemist Hut}}		{{Buildingbox\|name=Alchemist Hut}}

	Fixed: <code><nowiki>{{~~Shopbox~~\|name=Alchemist's Hut}}</nowiki></code>		Fixed: <code><nowiki>{{Buildingbox\|name=Alchemist's Hut}}</nowiki></code>

	{{~~Shopbox~~\|name=Alchemist's Hut}}		{{Buildingbox\|name=Alchemist's Hut}}
	</noinclude>		</noinclude>

76561197969631737: 76561197969631737 moved page Template:Shopbox to Template:Buildingbox: Wrote a better module that handles all buildings. moving this to not break existing pages.

2023-12-24T16:25:47Z

76561197969631737 moved page Template:Shopbox to Template:Buildingbox: Wrote a better module that handles all buildings. moving this to not break existing pages.

← Older revision		Revision as of 16:25, 24 December 2023
(No difference)

76561197969631737: Adding custom parameters for purpose, species preferences, and specializations

2023-12-24T14:53:12Z

Adding custom parameters for purpose, species preferences, and specializations

← Older revision		Revision as of 14:53, 24 December 2023
Line 1:		Line 1:
	<includeonly>{{#invoke: Shopbox\|renderShopbox		<includeonly>{{#invoke: Shopbox\|renderShopbox
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
			\| purpose={{{purpose\|}}}
			\| species_preference={{{species_preference\|}}}
			\| specializations={{{specializations\|}}}
	}}</includeonly><noinclude>		}}</includeonly><noinclude>

Line 22:		Line 25:
	\|-		\|-
	\| name \|\| string \|\| '''Required.''' The in-game name of the building for which you want to display the infobox. Will also serve as the header of the box.		\| name \|\| string \|\| '''Required.''' The in-game name of the building for which you want to display the infobox. Will also serve as the header of the box.
			\|-
			\| purpose \|\| string \|\| The overall purpose of the building, such as "Services" or omit this parameter. For example, if the purpose is "Industry," the infobox will already show "Industry" for the building's '''Category,''' so you may omit it.
			\|-
			\| species_preference \|\| string \|\| For buildings that provide services consumed by villagers, you may write which species prefers these services. For example, Leisure is preferred by "Beaver, Human." (Do not duplicate specialization information as species preferences.)
			\|-
			\| specializations \|\| string \|\| For buildings with specializations, you can include them here.
	\|}		\|}

76561197969631737: Updated with new main method name

2023-11-28T01:07:04Z

Updated with new main method name

← Older revision		Revision as of 01:07, 28 November 2023
Line 1:		Line 1:
	<includeonly>{{#invoke: Shopbox\|~~infobox~~		<includeonly>{{#invoke: Shopbox\|renderShopbox
	\| name= {{{name\| {{{1\|}}} }}}		\| name= {{{name\| {{{1\|}}} }}}
	}}</includeonly><noinclude>		}}</includeonly><noinclude>

76561197969631737: Created for infoboxes on buildings' pages

2023-11-09T04:48:38Z

Created for infoboxes on buildings' pages

New page

<includeonly>{{#invoke: Shopbox|infobox
| name= {{{name| {{{1|}}} }}}
}}</includeonly><noinclude>

{{Shopbox|name=Cookhouse}}

'''Shopbox''' 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:Workshops_csv]]. The infobox to the right on this page is an example.

== Overview ==

This template should be used for all Production Buildings on the wiki, that is, buildings whose recipes convert goods into other goods. The template requires only the <code>name</code> parameter, which tells the code behind the scenes which building 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 the [[Cookhouse]] could add categories for food production, complex food, crafting materials, large buildings, or even 2-star buildings.

== Parameters ==

Only the first, <code>name</code> is required, and it must be spelled correctly to match the in-game name of the building. 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 building for which you want to display the infobox. Will also serve as the header of the box.
|}

== Errors ==

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

'''Example:'''

<pre>{{Shopbox}}</pre>

Yields:

{{Shopbox}}

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

'''Example:'''

Broken: <code><nowiki>{{Shopbox|name=Alchemist Hut}}</nowiki></code>

{{Shopbox|name=Alchemist Hut}}

Fixed: <code><nowiki>{{Shopbox|name=Alchemist's Hut}}</nowiki></code>

{{Shopbox|name=Alchemist's Hut}}
</noinclude>