Template:Map/doc: Difference between revisions

Inline

Latest revision as of 15:04, 14 December 2024

This is a documentation subpage for Template:Map.

It contains usage information, categories, and other content that is not part of the original template page.

This template displays an interactive map.

Displays an interactive map.

Template parameters
Parameter		Description	Type	Status
Type	`type`	'Episode', 'Room' or 'Entity' Example Room	String	required
Target	`target`	Name of the room, episode or object to display. You can specify multiple items by separating them with a semi-colon (no spaces), or specify everything by using the string 'All' Example 'Sea Road', 'Sea Road;Little Square', 'All'	String	required
Height	`height`	Height of the map, if not the default of 300px. Example 500px	String	optional
Width	`width`	Width of the map, if not the default of 300px. Example 500px	String	optional

@@ Line 1: / Line 1: @@
+{{Documentation}}
 This template displays an interactive map.
+See the [[Brighter Shores:Map Project]] for more details!
 <templatedata>
@@ Line 5: / Line 9: @@
 	"description": "Displays an interactive map.",
 	"params": {
-		"location": {
+		"type": {
-			"label": "Location",
+			"label": "Type",
-			"description": "Name of the room or episode to display.",
+			"description": "'Episode', 'Room' or 'Entity'",
 			"type": "string",
 			"required": true,
-			"example": "Sea Road"
+			"example": "Room"
+        },
-		}
+		"target": {
+			"label": "Target",
+			"description": "Name of the room, episode or object to display. You can specify multiple items by separating them with a semi-colon (no spaces), or specify everything by using the string 'All'",
+			"type": "string",
+			"required": true,
+			"example": "'Sea Road', 'Sea Road;Little Square', 'All'"
+		},
+		"height": {
+			"label": "Height",
+			"description": "Height of the map, if not the default of 300px.",
+			"type": "string",
+			"required": false,
+			"example": "500px"
+        },
+		"width": {
+			"label": "Width",
+			"description": "Width of the map, if not the default of 300px.",
+			"type": "string",
+			"required": false,
+			"example": "500px"
+        }
 	}
 }