ទំព័រគំរូ:គំរូសំឡេង/doc

គំរូសំឡេង
ឯកសារ ជំនួយ

Once a free audio sample has been uploaded to Wikipedia (see the WP:SAMPLE guideline for information and links), use this template to add a link to the sample within an infobox. Any sample calling for a lengthy description must be positioned in the article body, not the infobox.

For non-free audio samples, the {{Listen}} template is preferred, and it must be placed in the body of the article, along with a description of the sounds to provide contextual significance, and thus satisfy requirement No. 8 of the Policy section of Wikipedia:Non-free content criteria.

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. The {{Listen}} template is preferred for samples accompanied by lengthy descriptions.

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

The HTML mark up produced by this template includes an hAudio microformat, which makes the recording's details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a playlist or database. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

Date-of-publication ("published") information will only be included in the microformat if {{Start date}} (or {{Start date and age}} where appropriate) is used in a parent template or infobox (but do not use these if the date is before 1583 CE).

For the length or duration of a recording, say 3 minutes 45 seconds, use {{Duration}} thus: {{Duration|m=3|s=45}}, which renders as 3:45. An optional h parameter can be used for hours.

Please do not remove instances of these sub-templates.

Classes

hAudio uses HTML classes including:

• 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

This is the TemplateData documentation for the template used by the new VisualEditor.

គំរូសំឡេង

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.

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]] Example song, single	String	required
Header	header	Change the header text. If value is "none", then the header will not be displayed. Example none	String	optional
File	file	Audio file to be shown. Example Example.ogg	File	required
Description	description	Description of the audio file Example "O Kazakhstan" (instrumental)	String	optional