Template:Settlement/doc

[⧼smw purge⧽]

This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more information

This template provides an infobox for player settlements.

{{Settlement
| name =
| image =
| image_caption =
| type =
| leadership =
| hq =
| ideology =
| established =
| disbanded =
| public =
| status =
| dimension =
| x =
| y =
| z =
| underground =
}}

An infobox to serve as a quick reference on the right side of settlement pages.

Template parameters

Parameter		Description	Type	Status
Settlement name	name	Will automatically enter based on page name Example Spawn Town	Line	optional
Image	image	Refers to the image file stored on the wiki. By default, the Parallel logo will be displayed, but you should always point this parameter to a render or screenshot of the location. Default ParallelLogo.png	File	suggested
Image caption	image_caption	An optional caption for the image.	Line	optional
Type	type	The type of settlement. Example Player town	Line	suggested
Leadership	leadership	The leader(s) of the group. Example Diamondback88	Line	suggested
Headquarters	hq	The headquarters of the settlement. Example Spawn Town Observatory	Line	suggested
Ideology	ideology	The professed ideology of the settlement. Example Monarchist	Line	suggested
Established	established	The date the settlement was established.	Line	suggested
Disbanded	disbanded	The date the settlement was disbanded.	Line	suggested
Public join?	public	Whether settlement membership is open to the public. Suggested values Yes No	Line	suggested
Status	status	Status of the settlement. Suggested values Active Inactive Closed Abandoned Destroyed	Line	suggested
Dimension	dimension	Dimension where the settlement is located. Suggested values Parallel Prime Overworld Parallel Prime Nether Otherside Overworld Otherside Nether The End Sky Dimension Space Example Sky Dimension	Line	required
X	x	The x-coordinate of the settlement.	Number	suggested
Y	y	The y-coordinate of the settlement.	Number	suggested
Z	z	The x-coordinate of the settlement.	Number	suggested
Underground?	underground	Whether the settlement is underground. Suggested values Yes No	Boolean	suggested