Template:Buildingbox/doc

Overview

Displays an infobox about a building on the right side of the page.

The infobox is populated automatically based on the parameters, validates the input, retrieves all necessary data, and handles all related lookups and formatting.

This template can and should be used exactly once at the top of every article on buildings with workplaces (that is, not houses or decorations).

For now, this template automatically categorizes pages on which it is used into Category:Buildings. In the future, this role will be relegated to the article template Template:Building.

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

Building

The name of the building is the only parameter, and it is required. It must be spelled correctly and match the in-game spelling and punctuation of the building. A reliable way of calling this template with the correct spelling on articles about a building is to use the mediawiki magic word {{PAGENAME}}, since all buildings' pages were carefully named to match the game data from which these template lookup and pull information.

If you do not wish to write the code name=, you may skip that. If any parameters are added later, you must specify the name of the building before any other parameters.

Parameter	Type	Description
name	string	Required. The name of the building, as it appears in the game.

At this time, there are no other parameters for this template.

Note: An older version of this template had other parameters. This version is backwards compatible, and any additional parameters are automatically ignored.

Examples

Ancient Hearth

Hearth
(City Buildings)

The heart of the colony is protected by the Holy Flame. Villagers gather here to rest, eat, and receive clothing. If the fire goes out, people will lose hope.

Specialization bonus:
 Warmth (Comfort) 

1 Workers

Construction

None

0	City score
0	Build time
4 × 4	Building size

Not movable

ID = `Small Hearth`

Basic usage

{{Buildingbox|Ancient Hearth}}

Creates the infobox seen on the right side of this article.

Errors

The following are error message generated by calling the template incorrectly.

{{Buildingbox}}

With no arguments:

{{Buildingbox|name=Alchemist Hut}}

With a misspelled building name:

{{Buildingbox|name=Library}}

Naming a building that doesn't exist in the game:

{{Buildingbox|Another parameter first|Ancient Hearth}}

The same goes for swapping the order of parameters so that the building is not first: