Template:LocationMap/doc: Difference between revisions

Revision as of 14:05, 30 November 2022

This template is used to display individual map(s) of a world/area on its article.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Filename	`filename`	The map's file name, inclusive of file type. Example Example.png	String	required
Caption	`caption`	A caption describing the map.	String	suggested
Custom size	`customsize`	A custom size for displaying the map, measured in pixels. Default 270px Example 20px	String	optional

{{LocationMap
| filename = [e.g. "Example.png"]
| caption =
| customsize = [e.g. 20px, 270px if left blank]
}}

{{LocationMap
| filename = Forestpier mapwork.png
| caption = Annotated map of the area
| customsize = 200px
}}

Annotated map of the area

@@ Line 1: / Line 1: @@
 == Description ==
-This template is used to display individual map(s) of a world/area on its article.
+<noinclude>[[Category:Template documentation]]</noinclude>
+<templatedata>
+{
+	"params": {
+		"filename": {
+			"label": "Filename",
+			"description": "The map's file name, inclusive of file type.",
+			"example": "Example.png",
+			"type": "string",
+			"required": true
+		},
+		"caption": {
+			"label": "Caption",
+			"description": "A caption describing the map.",
+			"type": "string",
+			"suggested": true
+		},
+		"customsize": {
+			"label": "Custom size",
+			"description": "A custom size for displaying the map, measured in pixels.",
+			"example": "20px",
+			"type": "string",
+			"default": "270px"
+		}
+	},
+	"format": "block",
+	"description": "This template is used to display individual map(s) of a world/area on its article."
+}
+</templatedata>
 == Syntax ==
@@ Line 24: / Line 52: @@
 | customsize = 200px
 }}
-<noinclude>[[Category:Template documentation]]</noinclude>