Difference between revisions of "Template:Audio/doc"

From blackwiki
Jump to navigation Jump to search
imported>Geekdiva
imported>Erutuon
(IPA should be placed in Template:audio-IPA, not this template)
Line 2: Line 2:
 
<!--PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE-->
 
<!--PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE-->
 
{{for|instructions on inserting audio files|Wikipedia:Creation and usage of media files#Audio}}
 
{{for|instructions on inserting audio files|Wikipedia:Creation and usage of media files#Audio}}
===Purpose===
+
=== Purpose ===
 
This template links to an audio file for quick listening.  It is meant to be used inline with text, for pronunciations and the like. Please note that this just creates a link to the file and does not actually embed the file. If the file is Non-Free and only referenced via this template it is not in compliance with [[WP:NFCC#7|Wikipedia:Non-free content criteria § Policy #7]].
 
This template links to an audio file for quick listening.  It is meant to be used inline with text, for pronunciations and the like. Please note that this just creates a link to the file and does not actually embed the file. If the file is Non-Free and only referenced via this template it is not in compliance with [[WP:NFCC#7|Wikipedia:Non-free content criteria § Policy #7]].
  
===Usage===
+
=== Usage ===
;Basic:
+
; Basic:
 
<code><nowiki>{{Audio|name of sound file|text to use as link to soundfile|help=}}</nowiki></code>
 
<code><nowiki>{{Audio|name of sound file|text to use as link to soundfile|help=}}</nowiki></code>
  
;Simple
+
; Simple
:<code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|/ˌæləˈbæmə/}}) is a state located in...</nowiki></code>
+
: <code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...</nowiki></code>
:&rarr; '''Alabama''' ({{Audio|en-us-Alabama.ogg|/ˌæləˈbæmə/}}) is a state located in...
+
: '''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...
;Variant
+
; Help links
:<code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|Pronunciation of "Alabama"}})</nowiki></code>
 
:&rarr; '''Alabama''' ({{Audio|en-us-Alabama.ogg|Pronunciation of "Alabama"}})
 
;Help links
 
 
Setting {{para|help|no}} disables the "help/info" links. If this is done the template {{tlx|inline audio}} ''must'' be shown on the page.
 
Setting {{para|help|no}} disables the "help/info" links. If this is done the template {{tlx|inline audio}} ''must'' be shown on the page.
  
:<code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|Pronunciation of "Alabama"|help=no}})</nowiki></code>
+
: <code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation of "Alabama"|help=no}})</nowiki></code>
: &rarr; '''Alabama''' ({{Audio|en-us-Alabama.ogg|Pronunciation of "Alabama"|help=no}})
+
: '''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation|help=no}})
 
: Todo: add {{tlx|inline audio}} to this page.
 
: Todo: add {{tlx|inline audio}} to this page.
  
===Microformat===
+
=== Microformat ===
 
{{UF-audio}}
 
{{UF-audio}}
  
===See also===
+
=== See also ===
 
{{Audio templates}}
 
{{Audio templates}}
  

Revision as of 23:40, 8 January 2017

Purpose

This template links to an audio file for quick listening. It is meant to be used inline with text, for pronunciations and the like. Please note that this just creates a link to the file and does not actually embed the file. If the file is Non-Free and only referenced via this template it is not in compliance with Wikipedia:Non-free content criteria § Policy #7.

Usage

Basic

{{Audio|name of sound file|text to use as link to soundfile|help=}}

Simple
'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...
Alabama (About this soundpronunciation ) is a state located in...
Help links

Setting |help=no disables the "help/info" links. If this is done the template {{inline audio}} must be shown on the page.

'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation of "Alabama"|help=no}})
Alabama (About this soundpronunciation)
Todo: add {{inline audio}} to this page.

Microformat

Template:UF-audio

See also