×
Create a new article
Write your page title here:
We currently have 3,034 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
3,034Articles

Template:LocationMap/doc: Difference between revisions

(Created page with "== Description == This template is used to display individual map(s) of a world/area on its article. == Syntax == <pre> {{LocationMap | filename = [e.g. "Example.png"] | capt...")
 
m (minor changes, note about customsize)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Description ==
==Description==
This template is used to display individual map(s) of a world/area on its article.
<templatedata>
{
"description": "This template is used to display individual map(s) of a world/area on its article.",
"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"
}
</templatedata>


== Syntax ==
==Syntax==
<pre>
<pre>
{{LocationMap
{{LocationMap
Line 10: Line 37:
}}
}}
</pre>
</pre>
''Note: most maps should use both filename and caption. customsize is optional.''


== Sample output ==
==Sample==
<pre>
<pre>
{{LocationMap
{{LocationMap
Line 25: Line 53:
}}
}}


<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
<includeonly>__NOEDITSECTION__</includeonly>

Latest revision as of 04:31, 28 June 2024

Description

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.

ParameterDescriptionTypeStatus
Filenamefilename

The map's file name, inclusive of file type.

Example
Example.png
Stringrequired
Captioncaption

A caption describing the map.

Stringsuggested
Custom sizecustomsize

A custom size for displaying the map, measured in pixels.

Default
270px
Example
20px
Stringoptional

Syntax

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

Note: most maps should use both filename and caption. customsize is optional.

Sample

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