Template:Listen/doc

From RuneRealm Wiki

This is the current revision of this page, as edited by Eq (talk | contribs) at 05:46, 16 October 2024 (Created page with "{{documentation}} The '''Listen''' template is used to embed an audio file. For a list of audio files, see Category:Audio files. ==Parameters== <pre>{{Listen | title = title | desc = description | image = filename of an image to use (optional) | filename = filename of the audio (spaces should be included as "_") | align = alignment (left/right; default is right) }}</pre> ==Examples== <pre>{{Listen | title = Quest completion | desc = Pl..."). The present address (URL) is a permanent link to this version.

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This is a documentation subpage for Template:Listen.
It contains usage information, categories, and other content that is not part of the original template page.

The Listen template is used to embed an audio file. For a list of audio files, see Category:Audio files.

Parameters

{{Listen
| title     = title
| desc      = description
| image     = filename of an image to use (optional)
| filename  = filename of the audio (spaces should be included as "_")
| align     = alignment (left/right; default is right)
}}

Examples

{{Listen
| title     = Quest completion
| desc      = Plays after a quest is completed.
| filename  = Quest Completed (1).ogg
}}

produces:

File:Audio options icon.png
Quest completion
Plays after a quest is completed.
File:Quest Completed (1).ogg

OGG file (left-aligned)

{{Listen
| title     = [[Impulses]]
| desc      = Plays when near a crop circle.
| filename  = Impulses.ogg
| align     = left
}}

produces:

File:Audio options icon.png
Impulses
Plays when near a crop circle.
File:Impulses.ogg

With image

{{Listen
|title = Earth's Fury
|filename = Jade bolts (e).ogg
|image = [[File:Jade bolts special.gif|200px]]
|desc = A player activates the ''Earth's Fury'' effect
}}

produces:

File:Audio options icon.png
Earth's Fury
A player activates the Earth's Fury effect
File:Jade bolts (e).ogg

See also

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

The Listen template is used to embed an audio file inside a box.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Alignmentalign

Alignment of player box

Suggested values
right left
Default
right
Example
left
Stringoptional
Filenamefilename

Filename of audio file

Example
Quest completed.ogg
Stringrequired
Titletitle

Title of the audio file

Example
Quest Completed (1).ogg
Stringrequired
Descriptiondesc

Description of the audio file

Example
Plays after quest completion
Stringoptional
Imageimage

Image or video to be shown above audio file.

Example
[[File:Jade bolts special.gif|200px]]
Fileoptional