Difference between revisions of "Template:IPA vowels/doc"

From blackwiki
Jump to navigation Jump to search
imported>Nardog
(proscribe infobox)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Uses TemplateStyles|Template:IPA common/styles.css|Template:
+
{{Uses TemplateStyles|Template:IPA common/styles.css|Template:IPA vowels/styles.css}}
  
 +
'''Customized usage'''
 +
* <code><nowiki>{{IPA vowels|audio=yes}}</nowiki></code> – shows audio samples ([[IPA vowel chart with audio|view]])
 +
* <code><nowiki>{{IPA vowels|class=floatright}}</nowiki></code> – floats to the right
 +
* <code><nowiki>{{IPA vowels|style=margin: auto;}}</nowiki></code> – appears centered
 +
* <code><nowiki>{{IPA vowels|caption=}}</nowiki></code> – hides the main frame (or enter a preferred caption after <code>=</code>)
 +
* <code><nowiki>{{IPA vowels|notes=no}}</nowiki></code> – hides the footnotes
 +
* <code><nowiki>{{IPA vowels|class=mw-collapsible}}</nowiki></code> – appears collapsible
 +
* <code><nowiki>{{IPA vowels|class=mw-collapsible mw-collapsed}}</nowiki></code> – appears collapsed
  
"description": "Transcludes a box of the IPA vowels. Can be made a side-floating infobox or include audio samples.",
+
''When editing this template, make sure it works not just by itself but also in {{tl|IPA navigation}} and with the options above.''
 +
 
 +
{{IPA templates}}
 +
 
 +
{{collapse top|TemplateData}}
 +
<templatedata>
 +
{
 +
"params": {
 +
"class": {
 +
"description": "If \"floatright\", floats to the right",
 +
"example": "floatright",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"audio": {
 +
"description": "If \"yes\", includes audio samples",
 +
"example": "yes",
 +
"type": "string"
 +
},
 +
"caption": {},
 +
"tableclass": {},
 +
"tablestyle": {},
 +
"notes": {
 +
"description": "if 'no', hides the footnotes",
 +
"example": "no",
 +
"type": "string"
 +
},
 +
"style": {},
 +
"captionstyle": {}
 +
},
 +
"description": "Transcludes a box of the IPA vowels. Can be made a side-floating box or include audio samples.",
 
"format": "{{_|_=_}}\n"
 
"format": "{{_|_=_}}\n"
 
}
 
}

Latest revision as of 08:55, 17 July 2020

Script error: No such module "Uses TemplateStyles".

Customized usage

  • {{IPA vowels|audio=yes}} – shows audio samples (view)
  • {{IPA vowels|class=floatright}} – floats to the right
  • {{IPA vowels|style=margin: auto;}} – appears centered
  • {{IPA vowels|caption=}} – hides the main frame (or enter a preferred caption after =)
  • {{IPA vowels|notes=no}} – hides the footnotes
  • {{IPA vowels|class=mw-collapsible}} – appears collapsible
  • {{IPA vowels|class=mw-collapsible mw-collapsed}} – appears collapsed

When editing this template, make sure it works not just by itself but also in {{IPA navigation}} and with the options above.

TemplateData

Transcludes a box of the IPA vowels. Can be made a side-floating box or include audio samples.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Classclass

If "floatright", floats to the right

Example
floatright
Stringsuggested
Audioaudio

If "yes", includes audio samples

Example
yes
Stringoptional
Captioncaption

no description

Unknownoptional
Tableclasstableclass

no description

Unknownoptional
Tablestyletablestyle

no description

Unknownoptional
Notesnotes

if 'no', hides the footnotes

Example
no
Stringoptional
Stylestyle

no description

Unknownoptional
Captionstylecaptionstyle

no description

Unknownoptional