Template:Infobox Housing/doc
Template page
More actions
Purpose
This infobox summarizes a player home or basement. It displays the home name, optional icon and image, supported lot size, and availability.
Usage
{{Infobox Housing
|name=
|icon=
|iconwidth=
|caption=
|image=
|imagewidth=
|lot=
|available=
}}
Parameters
| Parameter | Required | Explanation |
|---|---|---|
name
|
No | Name displayed at the top of the infobox. Defaults to the page name. |
icon
|
No | Icon filename. When omitted, the template looks for a filename based on the page name, with colons and slashes replaced by hyphens and _icon.png appended. The icon is displayed only when that file exists.
|
iconwidth
|
No | Width of the icon in pixels. Defaults to 64.
|
caption
|
No | Caption displayed beneath the detected icon. |
image
|
No | Filename of a representative image. When supplied, the template displays it and stores the filename in Has picture.
|
imagewidth
|
No | Display width passed to the representative-image row. Defaults to 250.
|
lot
|
Recommended | Lot size or supported lot sizes displayed in the infobox. Existing pages commonly include explicit semantic annotations such as [[lot size::Town lot|Town]] and a linked deed type.
|
available
|
No | Availability or acquisition history displayed in the infobox. Link established source or reward pages where appropriate. |
Behavior and side effects
When an icon file exists, it is displayed through Has home icon. Supplying image adds Has picture. Every transcluding page is added to Category:Housing.
The template does not create lot size or deed type values automatically; those annotations must be included deliberately in lot. Follow established housing pages and avoid inventing unsupported lot compatibility.
Example
{{Infobox Housing
|image=SotA Druid Town Home small.jpg
|lot=[[lot size::Town lot|Town]], [[City lot|City]], [[Keep lot|Keep]], or [[Castle lot|Castle]] [[deed type::Housing|Home]]
}}
See Druid Tree (Town Home) for this template in use. The example is not rendered here because it would assign housing properties and a category to the documentation page.