Jump to content

Template:Audio sample/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
upd
m top: {{High-use}}
 
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-use}}
<!-- 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}}}}


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}}.
== Usage ==


== Code ==
If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.
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.
<syntaxhighlight lang="wikitext" style="overflow:auto;">{{Infobox song
...
| misc = {{subst:Audio sample
| type =
| header = <!-- leave blank for "Audio sample" -->
| file =
| description =
}}
</syntaxhighlight>


=== Syntax ===
==Parameters==
===type===
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}}.


===header===
<pre>
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).
{{subst:Audio sample
| type =
| header =
| file =
| description =
}}
</pre>


=== Parameters ===
===file===
Enter the name of the audio file. The param will work with or without the preceding <code>File:</code>.
{| class=wikitable
! Parameter !! Description
|-
| type || Specifies the background color of the caption from {{tl|Infobox album/color}}. See that template's page for all values.
|-
| header || Changes the header text; default is "Audio sample". Hide the header by specifying value <code>none</code>.
|-
| file || Name of the audio file. For example, for [[:File:americaog.ogg]], specify <code>americaog.ogg</code>.
|-
| description || Description of the audio file. Usually not necessary.
|}


=== TemplateData ===
===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==
<syntaxhighlight lang="wikitext" 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
}}
</syntaxhighlight>

== Microformat ==
{{UF-audio}}

== TemplateData ==
{{TemplateDataHeader}}
{{TemplateDataHeader}}


Line 38: Line 58:
"type": {
"type": {
"label": "Type",
"label": "Type",
"description": "Type of recording (this changes the colour of the header). See [[Template:Infobox album/color]] for all values",
"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",
"example": "song, single",
"type": "string",
"type": "string",
"suggested": true,
"suggested": true,
Line 76: Line 96:
</templatedata>
</templatedata>


<includeonly>
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
[[Category:Exclude in print]]
[[Category:Music infobox templates]]
[[Category:Music infobox templates|Audiosample]]
[[Category:Audio templates]]
[[Category:Embeddable templates]]
[[Category:Embeddable templates]]
</includeonly>
}}</includeonly>

Latest revision as of 17:58, 26 December 2023

Audio sample

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

[edit]

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

[edit]

type

[edit]

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}}.

[edit]

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

[edit]

Enter the name of the audio file. The param will work with or without the preceding File:.

description

[edit]

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

[edit]
{{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

[edit]

The HTML mark-up produced by this template includes an hAudio microformat that makes an audio recording's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Subtemplates

Date-of-publication ("published") information will only be included in the microformat if {{start date}} (or, where appropriate, {{start date and age}}) is used in a parent infobox/template. Do not, however, use {{start date}} or {{start date and age}} if a date before 1583 CE is involved.

Use {{duration}} to specify the duration/length of a recording. For instance, if the recording's duration is 3 minutes 45 seconds, use {{duration|m=3|s=45}} (which appears as: 3:45). If needed, |h= may be included to specify a number of hours.

Please do not remove instances of these subtemplates.

Classes used

The HTML classes of this microformat include:

  • haudio
  • fn
  • album
  • description
  • category
  • contributor
  • duration
  • h
  • item
  • min
  • photo
  • position
  • price
  • published
  • s
Please do not rename or remove these classes
nor collapse nested elements which use them.

TemplateData

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Audio sample in articles based on its TemplateData.

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