Template:Audio sample/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 21:55, 23 December 2012

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
| Audio file    = <!--Without "File:" prefix-->
| Upper caption = <!--Omit to disable caption-->
| Background    = <!--Color or 'Song'; defaults to 'khaki'-->
}}

Parameter description

Parameter	Description
Audio file	Name of the audio file without "File:" prefix. For example, for File:americaog.ogg, simply specify `americaog.ogg`
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.
Background	Optional. Specifies the background color of the caption. Acceptable values are valid CSS color values. (See Web colors article.) The default (when this parameter is omitted) is khaki. The special word "Song" (first letter capitalized) results in the same color as that of the song infobox.

@@ Line 3: / Line 3: @@
 === Usage ===
+;Syntax
 <pre>
 {{Audiosample
+| Audio file    = <!--Without "File:" prefix-->
-| Upper caption = yes
+| Upper caption = <!--Omit to disable caption-->
-| Audio file    =
+| Background    = <!--Color or 'Song'; defaults to 'khaki'-->
 }}
 </pre>
+;Parameter description
-The following are the optional fields:
+{| class=wikitable
+! Parameter !! Description
-<pre>
+|-
-| Background    = Color or 'Song' defaults to 'khaki'
+| Audio file || Name of the audio file without "File:" prefix. For example, for [[:File:americaog.ogg]], simply specify <code>americaog.ogg</code>
-</pre>
+|-
+| 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.
-and
+|-
+| Background || Optional. Specifies the background color of the caption. Acceptable values are valid [[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:{{song infobox/color}}">the same color as that of the song infobox</span>.
-<pre>
+|}
-| Name          =
-</pre>
-The "Background" field is there for non-singles . The "Name" field is for when the single is a double-a side.
-=== See also ===
 <includeonly>