Template:Sound

From Aether Project Wiki
Jump to navigation Jump to search
[view | edit | history | purge]Documentation

This template is used to provide a button to play a sound effect, with a HTML audio player as a fallback if JS is disabled. This is intended primarily for short sound effects, as there is no seeking ability.

The script and styles are provided by the sound gadget (MediaWiki:Gadget-sound.js, MediaWiki:Gadget-sound.css, MediaWiki:Gadget-sound-styles.css), with a fallback style in the site gadget (MediaWiki:Gadget-site-styles.css).

Usage

  • |1= is the displayed wikitext. A speaker icon is displayed next to it indicating the playing status. Clicking the text (if not a link) or icon will stop any other sounds, and start/stop this sound.
  • |2= is the name of the audio file to play.
  • |3=, |4= and additional unnamed parameters specify additional audio files and display additional speaker icons. The fallback audio player will not show for these additional files, in order to prevent infoboxes from becoming very long if JS or the sound gadget is disabled.
  • |nofallback= hides the fallback audio player, so the sound can only be played if JS and the sound gadget is enabled. This is good for placing the sound button inline with text, as the fallback audio player is not inline, and would otherwise be too big to include within a sentence. In this case, you should set the displayed text to be a link to the file so it can still be played by no-js users and users which disabled the sound gadget.

Examples

(Disable the sound gadget to see how the fallback looks)

Basic
{{Sound|Play my mixtape 🔥|aether1.ogg}}

Play my mixtape 🔥


Inline with a link instead of a fallback player
{{Sound|'''[[Media:AetherPronunciation.ogg|The Aether]]'''|AetherPronunciation.ogg|nofallback=1}} is the dimension added by [[The Aether]] mod.

The Aether is the dimension added by The Aether mod.

[view | edit | history | purge]The above documentation is transcluded from Template:Sound/doc.