Template:Audio sample/doc: Difference between revisions
Removed non-free content being used in the template namespace per WP:NFCC#9. Non-free content may only be used in the article namespace. |
Removed non-free content being used in the template namespace per WP:NFCC#9. Non-free content may only be used in the article namespace. |
||
Line 26: | Line 26: | ||
| header || "Audio sample" is the default header. A custom header may be added or to hide it altogether, specify <code>none</code>. |
| header || "Audio sample" is the default header. A custom header may be added or to hide it altogether, specify <code>none</code>. |
||
|- |
|- |
||
| file || Name of the audio file. For example, for , specify <code> |
| file || Name of the audio file. For example, for , specify <code></code>. |
||
|- |
|- |
||
| description || Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. |
| description || Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. |
Revision as of 00:46, 6 June 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. |
Audio sample | |
---|---|
Usage
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.
Syntax
{{subst:Audio sample | type = | header = | file = | description = }}
Parameters
Parameter | Description |
---|---|
type | Specify single , song , or a code from {{Infobox album/doc/type}} – this sets the header color.
|
header | "Audio sample" is the default header. A custom header may be added or to hide it altogether, specify none .
|
file | Name of the audio file. For example, for , specify .
|
description | Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. |
Microformat
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
nor collapse nested elements which use them.
TemplateData
TemplateData for Audio sample
Adds an audio sample for album and song infoboxes. Use in the "misc" parameter of those templates.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Type | type | 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]]
| String | required |
Header | header | Change the header text. If value is "none", then the header will not be displayed.
| String | optional |
File | file | Audio file to be shown.
| File | required |
Description | description | Description of the audio file
| String | optional |