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
Line 5: Line 5:
==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 10:
** [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>
}}
}}

Revision as of 02:15, 17 October 2025

Template documentation [create]
No documentation available.

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

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

Credits

}}