View source for Template:Buildingbox/doc

{{Buildingbox|name=Mine}}

'''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 ==

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 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 ==

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.
|-
| 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.
|}

== Errors ==

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

'''Example:'''

<pre>{{Buildingbox}}</pre>

Yields:

{{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.

'''Example:'''

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

{{Buildingbox|name=Alchemist Hut}}

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

{{Buildingbox|name=Alchemist's Hut}}