Difference between revisions of "Template:Audio sample/doc"

From blackwiki
Jump to navigation Jump to search
imported>Zyxw
m (keep /sandbox out of categories)
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
{{infobox|data1={{parameter names example||type=song|file=Wikipedia.ogg}}}}
  
=== Usage ===
+
Once an audio sample has been uploaded to Wikipedia (see the [[WP:SAMPLE]] guideline for information and links), use this template to add an audio sample link to an infobox; to add samples to the main body of an article, use {{tl|Listen}}.
;Syntax
+
 
<pre>
+
== Code ==
{{Audiosample
+
This template is used with the {{para|misc}} parameter of the infobox template. It should not be used on its own.  If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced. Parameter indentation will also automatically be fixed.
| Audio file    = <!--Without "File:" prefix-->
+
<pre style="overflow:auto;">{{Infobox song
| Upper caption = <!--Omit to disable caption-->
+
...
| Background    = <!--Color or 'Song'; defaults to 'khaki'-->
+
| misc        = {{subst:Audio sample
}}
+
| type        =
 +
| header      = <!-- leave blank for "Audio sample" -->
 +
| file        =  
 +
| description =
 +
}}
 
</pre>
 
</pre>
  
;Parameter description
+
==Parameters==
{| class=wikitable
+
===type===
! Parameter !! Description
+
Enter <code>single</code> to produce a khaki header or <code>song</code> for light blue for other Infobox song types, so that the headers will have a consistent color. Other header colors are shown at {{tl|Infobox album/color}}.
|-
+
 
| Audio file || Name of the audio file without "File:" prefix. For example, for [[:File:americaog.ogg]], simply specify <code>americaog.ogg</code>
+
===header===
|-
+
If this parameter is left blank, <code>Audio sample</code> (the default setting) will be generated. A custom header may be created by entering text in this field.  For no header, enter {{para|header|no}}. For multiple audio samples, set the first to {{para|header|Audio samples}} and the succeeding links to {{para|header|no}}, so only one header for all will be created (see Example with multiple samples).
| 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.
+
 
|-
+
===file===
| 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>.
+
Enter the name of the audio file, without the preceding <code>File:</code>. For example for [[:File:Silent Night (choral).ogg]], enter <code>Silent Night (choral).ogg</code>.
|}
+
 
 +
===description===
 +
Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary.  However, "First verse", "Chorus", etc., may be added to identify a specific sample.  Generally, commentary about the composition, techniques used, etc., should be included in the main body of the article and not in the infobox.
 +
 
 +
==Example with multiple samples==
 +
<pre style="overflow:auto;">{{Infobox song
 +
...
 +
| misc        = {{subst:Audio sample
 +
| type        = song
 +
| header      = Audio samples
 +
| file        = Silent Night (choral).ogg
 +
| description = Choral version
 +
}}{{subst:Audio sample
 +
| type        = song
 +
| header      = no
 +
| file        = Gruber - Schumann-Heink - Stille Nacht.ogg
 +
| description = Soprano solo version
 +
}}
 +
</pre>
 +
 
 +
== Microformat ==
 +
{{UF-audio}}
 +
 
 +
== TemplateData ==
 +
{{TemplateDataHeader}}
 +
 
 +
<templatedata>
 +
{
 +
"params": {
 +
"type": {
 +
"label": "Type",
 +
"description": "Type of recording (this changes the colour of the header), such as single for khaki or song for light blue. For album types, see [[Template:Infobox album/color]]",
 +
"example": "song, single",
 +
"type": "string",
 +
"suggested": true,
 +
"required": true
 +
},
 +
"header": {
 +
"label": "Header",
 +
"description": "Change the header text. If value is \"none\", then the header will not be displayed.",
 +
"example": "none",
 +
"type": "string"
 +
},
 +
"file": {
 +
"label": "File",
 +
"description": "Audio file to be shown.",
 +
"example": "Example.ogg",
 +
"type": "wiki-file-name",
 +
"required": true,
 +
"suggested": true
 +
},
 +
"description": {
 +
"label": "Description",
 +
"description": "Description of the audio file",
 +
"example": "\"O Kazakhstan\" (instrumental)",
 +
"type": "string"
 +
}
 +
},
 +
"description": "Adds an audio sample for album and song infoboxes. Use in the \"misc\" parameter of those templates.",
 +
"paramOrder": [
 +
"type",
 +
"header",
 +
"file",
 +
"description"
 +
],
 +
"format": "block"
 +
}
 +
</templatedata>
  
<includeonly>
+
<includeonly>{{sandbox other||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
+
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Exclude in print]]
 
[[Category:Exclude in print]]
[[Category:Music infobox templates|Audiosample]]
+
[[Category:Music infobox templates]]
 +
[[Category:Audio templates]]
 
[[Category:Embeddable templates]]
 
[[Category:Embeddable templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 17:51, 10 March 2020

Template:Parameter names example

Once an audio sample has been uploaded to Wikipedia (see the WP:SAMPLE guideline for information and links), use this template to add an audio sample link to an infobox; to add samples to the main body of an article, use {{Listen}}.

Code

This template is used with the |misc= parameter of the infobox template. It should not be used on its own. If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced. Parameter indentation will also automatically be fixed.

{{Infobox song
...
| misc         = {{subst:Audio sample
 | type        = 
 | header      = <!-- leave blank for "Audio sample" -->
 | file        = 
 | description =
 }}

Parameters

type

Enter single to produce a khaki header or song for light blue for other Infobox song types, so that the headers will have a consistent color. Other header colors are shown at {{Infobox album/color}}.

header

If this parameter is left blank, Audio sample (the default setting) will be generated. A custom header may be created by entering text in this field. For no header, enter |header=no. For multiple audio samples, set the first to |header=Audio samples and the succeeding links to |header=no, so only one header for all will be created (see Example with multiple samples).

file

Enter the name of the audio file, without the preceding File:. For example for File:Silent Night (choral).ogg, enter Silent Night (choral).ogg.

description

Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. However, "First verse", "Chorus", etc., may be added to identify a specific sample. Generally, commentary about the composition, techniques used, etc., should be included in the main body of the article and not in the infobox.

Example with multiple samples

{{Infobox song
...
| misc         = {{subst:Audio sample
 | type        = song
 | header      = Audio samples
 | file        = Silent Night (choral).ogg
 | description = Choral version
 }}{{subst:Audio sample
 | type        = song
 | header      = no
 | file        = Gruber - Schumann-Heink - Stille Nacht.ogg
 | description = Soprano solo version
 }}

Microformat

Template:UF-audio

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Audio sample

Adds an audio sample for album and song infoboxes. Use in the "misc" parameter of those templates.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Typetype

Type of recording (this changes the colour of the header), such as single for khaki or song for light blue. For album types, see [[Template:Infobox album/color]]

Example
song, single
Stringrequired
Headerheader

Change the header text. If value is "none", then the header will not be displayed.

Example
none
Stringoptional
Filefile

Audio file to be shown.

Example
Example.ogg
Filerequired
Descriptiondescription

Description of the audio file

Example
"O Kazakhstan" (instrumental)
Stringoptional