Template:Locationbox/doc: Difference between revisions

Locationbox/doc
Basic Info
Effects	None
Events	None
Notable NPCs	None
Other
Connecting Areas	Chemical Research Facility ⛔
BGM	bgm-e (after lighting the foundry)
Map ID	1023
Primary Author	Ruri
Contributing Author(s)	qxy

Revision as of 13:39, 26 November 2020

Displays a location box, which contains a world's details.

Template parameters
Parameter		Description	Type	Status
headercolor	`headercolor`	The color of the header of the location box. Default #3366CC	String	suggested
headerfontcolor	`headerfontcolor`	The color of the text for the header of the location box. Default #FFFFFF	String	optional
headerfontsize	`headerfontsize`	The header's font size. Default 200%	String	optional
name	`name`	The area's original Japanese names, along with any translations thereof, separated by commas.. Example 扉部屋, ''Tobirabeya'', Door Room	String	optional
image	`image`	The file name for the image to be displayed by the location box.	File	optional
imagewidth	`imagewidth`	no description	Unknown	optional
caption	`caption`	The corresponding caption for the image, visible if a value is provided.	String	optional
JapaneseName	`JapaneseName`	The area's Japanese name. Example 扉部屋	String	optional
Effects	`Effects`	Effects obtainable in the current location. Example Chainsaw	String	optional
Wallpapers	`Wallpapers`	Collectibles that you can find in the current location. Example WP #87, Kura Puzzle #45	String	optional
Events	`Events`	Events that you can encounter.	String	optional
NPCS	`NPCS`	Notable NPCs that show up in the current location.	String	optional
Connections	`Connections`	Locations accessible from the location at present.	String	optional
BGM	`BGM`	Soundtrack that plays in the current location.	String	optional
Map ID	`Map ID`	The IDs corresponding to the location's map, as well as any existing sub-areas.	String	optional
Contributing	`Contributing`	Authors who have added to the location, visible if a value is provided.	String	optional
Primary	`Primary`	The location's main author.	String	optional

General usage

{{Locationbox |headercolor = #4A0400 |headerfontcolor = #FFA500 |image = volcanic_subterrain.png |Effects = None |Wallpapers = None |Events = None |NPCS = None |Connections = [[Chemical Research Facility]] {{OneWay|NoEntry}} |BGM = bgm-e (after lighting the foundry) |Map ID = 1023 |Primary = [[:Category:Ruri|Ruri]] |Contributing = [[:Category:Qxy|qxy]] }}

will return

@@ Line 1: / Line 1: @@
-;Description
+<templatedata>
-:The Locationbox template is used in detailing a map's general information.
+{
-;Syntax
+	"params": {
-:Type <code>{{t|Locationbox}}</code> somewhere.
+		"headercolor": {
-;Parameters
+			"label": "headercolor",
-:headercolor
+			"description": "The color of the header of the location box.",
-:* The color of the header of the location box. Default: #3366CC.
+			"type": "string",
-:headerfontcolor
+			"default": "#3366CC",
-:* The color of the text for the header of the location box. Default: ffffff.
+			"suggested": true
-:image
+		},
-:* The file name for the image to be displayed by the location box.
+		"headerfontcolor": {
-:caption
+			"label": "headerfontcolor",
-:* The corresponding caption for the image, visible if a value is provided.
+			"description": "The color of the text for the header of the location box.",
-:Effects
+			"type": "string",
-:* Effects obtainable in the current location.
+			"default": "#FFFFFF"
-:Wallpapers
+		},
-:* Collectibles that you can find in the current location.
+		"headerfontsize": {
-:Events
+			"label": "headerfontsize",
-:* Events that you can encounter.
+			"description": "The header's font size.",
-:NPCS
+			"type": "string",
-:* Notable NPCs that show up in the current location.
+			"default": "200%"
-:Connections
+		},
-:* Locations accessible from the location at present.
+		"name": {
-:BGM
+			"label": "name",
-:* Soundtrack that plays in the current location.
+			"description": "The area's original Japanese names, along with any translations thereof, separated by commas..",
-:Map ID
+			"example": "扉部屋, ''Tobirabeya'', Door Room",
-:* The IDs corresponding to the location's map, as well as any existing sub-areas.
+			"type": "string"
-:Primary
+		},
-:* The location's main author.
+		"image": {
-:Contributing
+			"label": "image",
-:* Authors who have added to the location, visible if a value is provided.
+			"description": "The file name for the image to be displayed by the location box.",
+			"type": "wiki-file-name"
+		},
+		"imagewidth": {},
+		"caption": {
+			"label": "caption",
+			"description": "The corresponding caption for the image, visible if a value is provided.",
+			"type": "string"
+		},
+		"JapaneseName": {
+			"label": "JapaneseName",
+			"description": "The area's Japanese name.",
+			"example": "扉部屋",
+			"type": "string"
+		},
+		"Effects": {
+			"label": "Effects",
+			"description": "Effects obtainable in the current location.",
+			"example": "Chainsaw",
+			"type": "string"
+		},
+		"Wallpapers": {
+			"label": "Wallpapers",
+			"description": "Collectibles that you can find in the current location.",
+			"example": "WP #87, Kura Puzzle #45",
+			"type": "string"
+		},
+		"Events": {
+			"label": "Events",
+			"description": "Events that you can encounter.",
+			"type": "string"
+		},
+		"NPCS": {
+			"label": "NPCS",
+			"description": "Notable NPCs that show up in the current location.",
+			"type": "string"
+		},
+		"Connections": {
+			"label": "Connections",
+			"description": "Locations accessible from the location at present.",
+			"type": "string"
+		},
+		"BGM": {
+			"label": "BGM",
+			"description": "Soundtrack that plays in the current location.",
+			"type": "string"
+		},
+		"Map ID": {
+			"label": "Map ID",
+			"description": "The IDs corresponding to the location's map, as well as any existing sub-areas.",
+			"type": "string"
+		},
+		"Contributing": {
+			"label": "Contributing",
+			"description": "Authors who have added to the location, visible if a value is provided.",
+			"type": "string"
+		},
+		"Primary": {
+			"label": "Primary",
+			"description": "The location's main author.",
+			"type": "string"
+		}
+	},
+	"description": "Displays a location box, which contains a world's details."
+}
+</templatedata>
 ==General usage==

Locationbox/doc

Basic Info
Effects	EffectNone
Events	None
Notable NPCs	None
Other
Connecting Areas	Chemical Research Facility NoEntry⛔
BGM	bgm-e (after lighting the foundry)
Map ID	1023
Primary Author	Ruri
Contributing Author(s)	qxy