Template:Music track map/doc: Difference between revisions

From RuneRealm Wiki
Jump to navigation Jump to search
Content added Content deleted
(Created page with "{{Documentation}} This template can be used on Map pages to create a music track map. This template will include a notice about the function of the page, as well as providing the relevant categories and SMW properties to the page. The first unnamed parameter must be the coordinates for the polygon indicating the music track area. == Example == <pre>{{Music track map |songs=Dreamstate |files=File:Dreamstate.ogg |x=1760|y=5088|plane=2 |align=right|[ [ [1728,5056],[1728,5...")
 
No edit summary
Tag: Reverted
Line 1: Line 1:
{{Documentation}}
{{Documentation}}


This template can be used on Map pages to create a music track map. This template will include a notice about the function of the page, as well as providing the relevant categories and SMW properties to the page. The first unnamed parameter must be the coordinates for the polygon indicating the music track area.
This template can be used on Map mw.pages to create a music track map. This template will include a notice about the function of the page, as well as providing the relevant categories and SMW properties to the page. The first unnamed parameter must be the coordinates for the polygon indicating the music track area.


== Example ==
== Example ==
Line 92: Line 92:
"songs": {
"songs": {
"label": "List of songs",
"label": "List of songs",
"description": "Comma-separated list of music track pages.",
"description": "Comma-separated list of music track mw.pages.",
"example": "Harmony, Flute salad",
"example": "Harmony, Flute salad",
"type": "string",
"type": "string",
Line 100: Line 100:
"files": {
"files": {
"label": "List of music track files",
"label": "List of music track files",
"description": "CSV list of the file pages for the songs, including File: and .ogg extension",
"description": "CSV list of the file mw.pages for the songs, including File: and .ogg extension",
"example": "File:Harmony.ogg, File:Flute Salad.ogg",
"example": "File:Harmony.ogg, File:Flute Salad.ogg",
"type": "string",
"type": "string",

Revision as of 00:38, 17 October 2024

This is a documentation subpage for Template:Music track map.
It contains usage information, categories, and other content that is not part of the original template page.

This template can be used on Map mw.pages to create a music track map. This template will include a notice about the function of the page, as well as providing the relevant categories and SMW properties to the page. The first unnamed parameter must be the coordinates for the polygon indicating the music track area.

Example

{{Music track map
|songs=Dreamstate
|files=File:Dreamstate.ogg
|x=1760|y=5088|plane=2
|align=right|[
[ [1728,5056],[1728,5120],[1792,5120],[1792,5056] ],
[ [1744,5072],[1744,5104],[1776,5104],[1776,5072] ]
]}}

See also

Parameters

Attributes other than the mandatory coordinate data can be specified like they can in {{Map}}:

No description.

Template parameters

ParameterDescriptionTypeStatus
Polygon array1

no description

Stringrequired
Center Xx

no description

Default
3200
Numbersuggested
Center Yy

no description

Default
3200
Numbersuggested
Planeplane

no description

Default
0
Numberoptional
Map IDmapID

no description

Default
-1
Numberoptional
Widthwidth

Map frame width

Default
300
Numberoptional
Heightheight

Map frame height

Default
300
Numberoptional
Zoom levelzoom

no description

Numberoptional
Alignalign

Map frame alignment

Default
center
Stringoptional
Link targetlink

The target link for the map page

Default
(Map page name)
Example
Varrock
Stringoptional
Link textlinktext

Link text, if the text is not the same as the default link target.

Example
Varrock music
Stringoptional
List of songssongs

Comma-separated list of music track mw.pages.

Example
Harmony, Flute salad
Stringrequired
List of music track filesfiles

CSV list of the file mw.pages for the songs, including File: and .ogg extension

Example
File:Harmony.ogg, File:Flute Salad.ogg
Stringrequired
Is members only?members

'No' if free-to-play, 'Yes' if Members-only

Default
yes
Example
no
Booleanrequired