View source for Template:Locationbox/doc

<templatedata>
{
	"params": {
		"headercolor": {
			"label": "(Header color)",
			"description": "The color of the header of the location box.",
			"type": "string",
			"default": "#3366cc",
			"suggested": true
		},
		"headerfontcolor": {
			"label": "(Header font color)",
			"description": "The color of the text for the header of the location box.",
			"type": "string",
			"default": "#ffffff",
			"suggested": true
		},
		"image": {
			"label": "(Location image)",
			"description": "The file name for the image to be displayed by the location box.",
			"type": "wiki-file-name",
			"example": "Azure_garden.png",
			"required": true
		},
		"caption": {
			"label": "(Location image caption)",
			"description": "The corresponding caption for the image, visible if a value is provided.",
			"type": "string"
		},
		"JapaneseName": {
			"label": "Japanese Name",
			"description": "The area's original name in Japanese, if applicable.",
			"example": "扉部屋",
			"type": "string"
		},
		"VersionAdded": {
			"label": "Version Added",
			"description": "The version in which the area was first added.",
			"example": "0.114",
			"type": "string",
			"default": "x.x",
			"suggested": true
		},
		"VersionRemoved": {
			"label": "Version Removed",
			"description": "The version in which the area was removed, if applicable.",
			"example": "0.115a",
			"type": "string"
		},
		"VersionGaps": {
			"label": "Version Gaps",
			"description": "Any gaps where the area was removed only to later be re-added, starting with the version it was removed, followed by a dash, followed by the version it was re-added in. Use commas to separate multiple instances.",
			"example": "0.110b-0.110b patch 1,0.111-0.113a",
			"type": "string"
		},
		"VersionsUpdated": {
			"label": "Versions Updated",
			"description": "The version(s) in which the area has been updated. This should not include VersionAdded, VersionRemoved, or any removed versions in VersionGaps. Use commas to separate multiple instances. Versions may also be followed by a dash and a 1 or 2 character code; this is an update type identifier used by Yume 2kki Explorer, and these are automatically handled by the version manager in the app.",
			"example": "0.112,0.112 patch 1,0.112d",
			"type": "string"
		},
		"Effects": {
			"label": "Effects",
			"description": "Effects (or the game's equivalent) obtainable in this location.",
			"example": "Chainsaw",
			"type": "string",
			"required": true
		},
		"Collectibles": {
			"label": "Collectibles",
			"description": "Collectibles that you can find in this location.",
			"example": "WP #87, Kura Puzzle #45",
			"type": "string",
			"aliases": [
				"Wallpapers",
				"Menu"
			],
			"suggested": true
		},
		"Events": {
			"label": "Events",
			"description": "Events that you can encounter in this location.",
			"type": "string",
			"required": true
		},
		"NPCS": {
			"label": "Notable NPCs",
			"description": "Noteworthy NPCs that show up in this location.",
			"type": "string",
			"suggested": true
		},
		"Connections": {
			"label": "Connecting Areas",
			"description": "List of areas connected to this location (using the Connection template) as of the game's current version.",
			"type": "string",
			"example": "{{Connection|Dream Pool|one_way_type=NoEntry}}",
			"required": true
		},
		"RemovedConnections": {
			"label": "Removed Connections",
			"description": "List of area connections (using the Connection template) to this location that have since been removed.",
			"type": "string",
			"example": "{{Connection|Digital Forest}}"
		},
		"BGM": {
			"label": "BGM",
			"description": "List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.",
			"type": "string",
			"example": "{{BGM|title=soto_C5|filename=Soto-C5.ogg|label=Glasses Path}}",
			"required": true
		},
		"Map ID": {
			"label": "Map ID",
			"description": "List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits. Annotations may be added to each map ID using parentheses. If you wish to include commas in these annotations, use &comma; - it will break otherwise.",
			"example": "0002, 0003",
			"type": "string",
			"required": true
		},
		"Primary": {
			"label": "Author",
			"description": "The location's main author(s).",
			"type": "string",
			"suggested": true
		},
		"Contributing": {
			"label": "Contributing",
			"description": "Authors who have contributed to the location.",
			"type": "string"
		},
		"Name": {
			"label": "Original Name(s)",
			"description": "The area's original Japanese (or generally, native, assuming a fangame's language is not English) names, along with any translations thereof, separated by commas.",
			"example": "扉部屋, ''Tobirabeya'', Door Room",
			"type": "string",
			"suggested": true
		},
		"Map Type": {
			"label": "Map Type",
			"description": "Descriptors for a given location, such as the overall map size and whether it loops or otherwise.",
			"example": "Small, Non-looping",
			"type": "string"
		}
	},
	"description": "Displays a location box, which contains a world's details.",
	"paramOrder": [
		"headercolor",
		"headerfontcolor",
		"Name",
		"image",
		"caption",
		"JapaneseName",
		"VersionAdded",
		"VersionRemoved",
		"VersionsUpdated",
		"VersionGaps",
		"Effects",
		"Collectibles",
		"Events",
		"Map Type",
		"NPCS",
		"Connections",
		"RemovedConnections",
		"BGM",
		"Map ID",
		"Primary",
		"Contributing"
	],
	"format": "{{_\n|_ = _\n}}"
}
</templatedata>

==Semantic properties==
This template exposes the following semantic properties.
{| style="width: 100%;" cellspacing="0" cellpadding="4" class="wikitable"
!style="text-align: center;"|Property name
!style="text-align: center;"|Description
!style="text-align: center;"|Data type
!style="text-align: center;"|Cardinality
|-
|Has location image filename
|The location image's filename.
|Page
|Single
|-
|Header font color
|The color of the locationbox's header text. Used for location-based styling.
|String
|Single
|-
|Header background color
|The color of the locationbox's header background. Used for location-based styling.
|String
|Single
|-
|Has location image
|The path pointing to the location image. Used for external applications to refer to the image.
|String
|Single
|-
|Japanese name
|The area's Japanese (or generally, native-language) name. Used for localization purposes.
|String
|Single
|-
|Version added
|The version where the location was added. Primarily used with the Yume 2kki Explorer.
|String
|Single
|-
|Versions updated
|The version(s) where the location was updated. Primarily used with the Yume 2kki Explorer.
|String
|Multiple
|-
|Version removed
|The version where the location was removed. Primarily used with the Yume 2kki Explorer.
|String
|Single
|-
|Version gaps
|The versions where the location was absent prior to its return. Primarily used with the Yume 2kki Explorer.
|String
|Multiple
|-
|Has map type
|The properties describing a map's nature.
|String
|Multiple
|-
|Has primary author
|The person(s) who created the location; this is applicable to collaborative fangame projects.
|String
|Multiple
|-
|Has contributing author
|The person(s) contributing to the the development of the location; this is applicable to collaborative fangame projects.
|String
|Multiple
|}

==General usage==
<pre style="line-height:1.6;">
 {{Locationbox
 |headercolor = #4a0400
 |headerfontcolor = #ffa500
 |image = volcanic_subterrain.png
 |Effects = None
 |Collectibles = 
 |Events = None
 |NPCS = None
 |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}}
 |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}}
 |Map ID = 1023
 |Primary = Ruri
 |Contributing = qxy
 }}
</pre>
will return:
{{Locationbox
 |headercolor = #4a0400
 |headerfontcolor = #ffa500
 |image = volcanic_subterrain.png
 |Effects = None
 |Collectibles = 
 |Events = None
 |NPCS = None
 |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}}
 |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}}
 |Map ID = 1023
 |Primary = Ruri
 |Contributing = qxy
}}
<noinclude>[[Category:Template Documentation]]</noinclude>