View source for Template:Location page/doc

This template displays part of a Location page. It is responsible for the summary, main image and relative location template.

It will also insert a row into the {{C|locations}} Cargo table.

Copy-ready:
<pre>
{{Location page
| prefix = 
| name =
| alt name prefix = 
| alt name =
| image = 
| image description = 
| act =
| summary =
| region prefix = 
| region = 
| north =
| west =
| east = 
| south =
}}
</pre>

== Examples ==

=== Usage: ===
<pre>{{Location page
| prefix = The
| name = Ebonlake Grotto
| alt name prefix = the
| alt name = Myconid Colony
| image = Ebonlake Grotto Overview.jpg
| image description = Overview of the area.
| act = one
| summary = It is the home of the [[Myconid]] Circle, a group of mushroom-like telepaths led by Sovereign {{CharLink|Spaw}}.
| region prefix = the
| region = Underdark
| north = 
| west = Dread Hollow
| east = Storehouse
| south = Decrepit Village
}}</pre>

=== Result ===
{{Location page
| prefix = The
| name = Ebonlake Grotto
| alt name prefix = the
| alt name = Myconid Colony
| image = Ebonlake Grotto Overview.jpg
| image description = Overview of the area.
| act = one
| summary = It is the home of the [[Myconid]] Circle, a group of mushroom-like telepaths led by Sovereign {{CharLink|Spaw}}.
| region prefix = the
| region = Underdark
| north = 
| west = Dread Hollow
| east = Storehouse
| south = Decrepit Village
}}

[[Category:Page generating templates]]

== Template data ==
<templatedata>
{
	"params": {
		"prefix": {
			"description": "What to prefix the name with",
			"type": "string"
		},
		"name": {
			"description": "If specified, overrides the name. Otherwise, it will take the name of the article",
			"type": "string",
            "required": true
		},
		"alt name prefix": {
			"description": "What to prefix the alt name with",
			"type": "string"
		},
		"alt name": {
			"description": "Alternative name for the location",
			"type": "string"
		},
		"image": {
			"description": "Image to use as the main page image at the top right",
			"type": "wiki-file-name"
		},
		"image description": {
			"description": "Description of the main page image, displayed underneath.",
			"type": "string"
		},
		"act": {
			"description": "Which act of the game this location appears in",
			"type": "string",
            "required": true,
			"suggestedvalues": [
				"prologue",
				"one",
				"two",
				"three"
			]
		},
		"summary": {
			"description": "Summary of the location. Also used for SEO purposes.",
			"type": "content"
		},
		"region prefix": {
			"description": "What to prefix the region name with",
			"type": "string"
		},
		"region": {
			"description": "The region where this location is located within. Slightly changes the summary.",
			"type": "wiki-page-name",
			"example": "Underdark"
		},
		"north": {
			"description": "The location to the north of this location.",
			"type": "wiki-page-name"
		},
		"east": {
			"description": "The location to the east of this location.",
			"type": "wiki-page-name"
		},
		"south": {
			"description": "The location to the south of this location.",
			"type": "wiki-page-name"
		},
		"west": {
			"description": "The location to the west of this location.",
			"type": "wiki-page-name"
		},
		"no output": {
			"description": "If yes, don't output anything and just insert into the table.",
			"type": "string"
		}
	},
	"format": "block"
}
</templatedata>