Template:Audio sample/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 11:00, 10 May 2017

This is a documentation subpage for Template:Audio sample.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

Syntax

{{Audiosample
| file    = 
| header  = 
| type    = 
}}

Parameters

Parameter	Description
file	Name of the audio file. For example, for File:americaog.ogg, specify `americaog.ogg`
header	Putting anything in this parameter adds an infobox header reading "Audio sample".
type	Specifies the background color of the caption from {{Infobox album/color}}; defaults to `single`. See that template's page for all values.

@@ Line 2: / Line 2: @@
 <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
-=== Usage ===
+== Usage ==
-;Syntax
+=== Syntax ===
 <pre>
 {{Audiosample
-| Audio file    = <!--Without "File:" prefix-->
+| file    =
+| header  =
-| Upper caption = <!--Omit to disable caption-->
+| type    =
-| Background    = <!--Color or 'Song'; defaults to 'khaki'-->
 }}
 </pre>
+=== Parameters ===
-;Parameter description
 {| class=wikitable
 ! Parameter !! Description
 |-
-| Audio file || Name of the audio file without "File:" prefix. For example, for [[:File:americaog.ogg]], simply specify <code>americaog.ogg</code>
+| file || Name of the audio file. For example, for [[:File:americaog.ogg]], specify <code>americaog.ogg</code>
 |-
-| Upper caption || Specifies whether there is an upper caption that reads "Audio sample". Putting anything in this parameter, even a space character after equal sign, activates the caption. Omitting it removes the caption.
+| header || Putting anything in this parameter adds an infobox header reading "Audio sample".
 |-
+| type || Specifies the background color of the caption from {{tl|Infobox album/color}}; defaults to <code>single</code>. See that template's page for all values.
-| Background || Optional. Specifies the background color of the caption. Acceptable values are valid [[Cascading Style Sheets|CSS]] color values. (See [[Web colors]] article.) The default (when this parameter is omitted) is <span style="background:khaki;">khaki</span>. The special word "Song" (first letter capitalized) results in <span style="background:{{Infobox song/color}}">the same color as that of the song infobox</span>.
 |}