Template:Audio button/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Created page with "{{Documentation}} The '''Audio button''' template is used to embed an audio file in a single-button inline audio player. Helps reduce the overall footprint of the audio player, which often renders quite large, and encourages the browser to not preload files. ==Parameters== <pre>{{Audio button|<filename> (e.g. Quest complete.ogg)|alt=Hover text to display (displays filename if omitted)}}</pre> ==See also== * Template:Listen * Template:Listen inline ==Credits==..."
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation}}
The '''Audio button''' template is used to embed an audio file in a single-button inline audio player. Helps reduce the overall footprint of the audio player, which often renders quite large, and encourages the browser to not preload files.
The '''Audio button''' template is used to embed an audio file in a single-button inline audio player. Helps reduce the overall footprint of the audio player, which often renders quite large, and encourages the browser to not preload files.


==Parameters==
==Parameters==
<pre>{{Audio button|<filename> (e.g. Quest complete.ogg)|alt=Hover text to display (displays filename if omitted)}}</pre>
<pre>{{Audio button|<filename> (e.g. Quest complete.ogg)|alt=Hover text to display (displays filename if omitted)}}</pre>
==See also==
* [[Template:Listen]]
* [[Template:Listen inline]]


==Credits==
==Credits==
Line 14: Line 8:
** [https://runescape.wiki/w/Template:Audio_button Equivalent templates and gadgets] on the RuneScape Wiki, created by Habblet.
** [https://runescape.wiki/w/Template:Audio_button Equivalent templates and gadgets] on the RuneScape Wiki, created by Habblet.
<includeonly>[[Category:Audio templates|{{PAGENAME}}]]</includeonly>
<includeonly>[[Category:Audio templates|{{PAGENAME}}]]</includeonly>
{{TemplateData|<templatedata>
{
"params": {
"1": {
"label": "Filename",
"description": "Filename of the audio file",
"example": "Doorman_ping_affermative_01.mp3",
"type": "string",
"required": true
},
"alt": {
"label": "Hover text",
"description": "Text to display when hovering over the button",
"example": "The Doorman saying 'Sounds good.'",
"type": "string",
"default": "The value of the filename parameter",
"required": false
}
},
"description": "The Audio button template is used to embed an audio file in a single-button inline audio player. Helps reduce the overall footprint of the audio player, which often renders quite large, and encourages the browser to not preload files.",
"format": "inline"
}
</templatedata>
}}

Latest revision as of 02:24, 17 October 2025

The Audio button template is used to embed an audio file in a single-button inline audio player. Helps reduce the overall footprint of the audio player, which often renders quite large, and encourages the browser to not preload files.

Parameters

[edit source]
{{Audio button|<filename> (e.g. Quest complete.ogg)|alt=Hover text to display (displays filename if omitted)}}

Credits

[edit source]