Template:Building link

This is the Template Documentation from Template:Building link/doc.

Overview

Creates a link to a building's page.

The template validates that you have correctly spelled the building name and can include an icon. Any links returned by this template should have articles and not be redlinks.

A shortcut template exists for this template, Template:bl. You can use {{bl}} instead of {{Building link}} with the same parameters.

Parameters

Building

The name of the building is the only required parameter. Use the name as it appears in-game, including apostrophes (for example, the Woodcutters' Camp—not Woodcutter's Camp). A missing or mispelled (or mis-punctuated) building name will result in an error.

If you do not wish to write the code name=, you may skip that, but 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.

Output overrides

All of these parameters are optional and change how the link is formatted.

Parameter	Type	Description
size	string	The size of the icon to display. Choose one of the following: none small medium large huge The default for buildings is none, suitable for paragraphs.
display	string	If you include display=notext only the icon will be rendered. There are currently no other options for this parameter.
unnamed parameter	string	Including this formats the link with the plural name of the building. You may use either s or es to append it to the end of the link in a highly readable way, like this: {{bl|Cookhouse|s}}.

Building links that are written into paragraphs should use no icon, which is the default. The small icon for buildings is not recognizable (compared to species, resources, or specializations). Avoid it unless necessary, but it is available in case it is needed.

Note that adding "s" after the template call no longer includes the "s" in the link as it used to.

Examples

Basic usage

{{Building link|Trappers' Camp}}

Makes a simple text-only link to the Trappers' Camp article for use in-line in paragraphs like this that discuss villagers trapping and gathering things. Remember that using the small version of building icons like the Trappers' Camp is strongly advised against, because there aren't enough pixels to make them recognizable to the broad audience of this wiki.

{{Building link|Trappers' Camp|size=medium}}

Yields an icon just big enough to be recognizable. Suitable for tables that list the buildings where layout provides some space for icons:

Trappers' Camp

{{Building link|name=Ranch|large}}

Yields a larger icon for good recognition for use in tables with space that allows it:

Ranch

{{Building link|Ranch|size=huge}}

Yields the largest icon, which is great for headlining tables featuring this building:

Ranch

Other examples

{{Building link|Ranch|s}}

Formats the link so the name appears plural, but still links to the correct page (hover to see tooltip, or click):

Ranches

{{Building link|Apothecary|s|size=none}}

Mentioning how important Apothecaries are to your villagers does format the building name correctly as plural. The pages for the names of buildings ending in -y when plural like the Breweries have already been created as redirect pages, so you may use them freely:

• Apothecaries
• Bakeries
• Beaneries
• Breweries
• Distilleries
• Granaries
• Manufactories
• Monasteries
• Smithies
• Tincturies

{{Building link|Trappers' Camp|s|size=gigantic}}

Specifying an icon size that is not recognized does not return an error. Instead, it defaults to no icon:

Trappers' Camps

Errors

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

{{Building link}}

With no arguments:

{{Building link|Library}}

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

{{Building link|huge|Ranch|es}}

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