Template:IPA/doc: Difference between revisions

From TalossaWiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation subpage}}
 
<!--  
<!--
     PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
     PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
-->
-->
=== Usage ===
=== Usage ===
'''[[Template:IPA]]''' is most useful when there are multiple instances of the [[wikipedia:International Phonetic Alphabet|International Phonetic Alphabet]] (IPA) on a page. It contains


'''[[Template:IPA]]''' is most useful when there are multiple instances of the IPA on a page. It contains
<nowiki><span title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">{{{1}}}</span></nowiki>


<nowiki><span title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">{{{1}}}</span></nowiki>
This means, it simply specifies a class called “IPA” as a hook for CSS styling and DOM scripting.


I.e., it simply specifies CSS class IPA.
This allows fixing broken display of IPA characters in MS Internet Explorer 6 for Windows, and choice of style in any browser.


This allows fixing broken display of [[International Phonetic Alphabet]] (IPA) characters in MS Internet Explorer 6 for Windows, and choice of style in any browser.  
The font declaration is in [[MediaWiki:Common.js]] and targets ''only'' Windows XP. Registered Wikipedia users can specify their own style for IPA text by editing, for each project, their user style sheet, e.g. monobook.css. Users can also specify the style locally in their browser, which works across projects.


The font declaration is in [[MediaWiki:Common.js]]. Registered Wikipedia users can specify their own style for IPA text by editing, for each project, their user style sheet, e.g. monobook.css. Users can also specify the style locally in their browser, which works across projects.
[[MediaWiki:Common.css]] also ensures that links inside IPA transcriptions marked up with this template do not use underlines since these carry special semantics there.
 
=== TemplateData ===
<pre>{
"description": "This template ensures proper display of transcriptions using the International
Phonetic Alphabet (IPA), especially in older operating systems and browsers. There are related
specialized templates that also semi-automatically generate the transcription itself.",
"params": {
  "1": {
    "label": "transcription",
    "description": "including square brackets [...] for phonetic transcriptions or enclosing
forward slashes /.../ for phonemic ones",
    "type": "string",
    "required": true
  }
}}</pre>


=== Examples ===
=== Examples ===
Placing a phonemic rendering of the word ''characters'' in Template:IPA:
Placing a phonemic rendering of the word ''characters'' in Template:IPA:


  <nowiki>{{IPA|/ˈkærəktɚz/}}</nowiki>
  <nowiki>{{IPA|/ˈkærəktɚz/}}</nowiki>
<nowiki>{{IPA|/[[character|ˈkærəktɚz]]/}}</nowiki>


The result will be a span with a class attribute, like this:
The result will be a span with a class attribute, like this:
Line 25: Line 41:
  <nowiki><span</nowiki> title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">/ˈkærəktɚz/<nowiki></span></nowiki>
  <nowiki><span</nowiki> title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">/ˈkærəktɚz/<nowiki></span></nowiki>


Which appears in your browser as:
Which appear in your browser as:


: {{IPA|/ˈkærəktɚz/}}
: {{IPA|/ˈkærəktɚz/}}
: {{IPA|/[[character|ˈkærəktɚz]]/}}


Without template:IPA:
Without template:IPA:


: /ˈkærəktɚz/
: /ˈkærəktɚz/
: /[[character|ˈkærəktɚz]]/


[The last two should only look different if you are using Internet Explorer 6 or lower on Windows, or if you have a custom style defined for IPA text.]
[These sets should only look different if you are using Internet Explorer 6 or lower on Windows, or if you have a custom style defined for IPA text.]


Please place all IPA text into Template:IPA, even if it doesn't have any special IPA characters, like this: {{IPA |/mi/}}.  This will allow users to format all examples of IPA text consistently, with their choice of fonts, colours, etc.
Please place all IPA text into Template:IPA, even if it doesn't have any special IPA characters, like this: {{IPA |/mi/}}.  This will allow users to format all examples of IPA text consistently, with their choice of fonts, colours, etc.


=== List of fonts ===
<noinclude>[[Category:IPA]][[Category:IPA templates]][[Category:Templates]]</noinclude>
The following is a list of fonts that are specified using this template.
*[[Microsoft Sans Serif]]
*[[Arial Unicode MS]]
*[[Lucida Sans Unicode]]
 
{{usage of IPA templates}}
<includeonly>
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
[[Category:IPA templates|{{PAGENAME}}]]
 
<!-- PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS. -->
[[ar:قالب:IPA]]
[[be-x-old:Шаблён:IPA]]
[[ca:Plantilla:AFI]]
[[de:Vorlage:IPA]]
[[es:Plantilla:IPA]]
[[dsb:Pśedłoga:IPA]]
[[eo:Ŝablono:Prononco]]
[[fa:الگو:آوا]]
[[fi:Malline:IPA]]
[[fr:Modèle:Prononciation API]]
[[he:תבנית:IPA]]
[[hi:साँचा:अ-ध्व-लि]]
[[hsb:Předłoha:IPA]]
[[hu:Sablon:IPA]]
[[it:Template:IPA]]
[[ja:Template:IPA2]]
[[ko:틀:IPA]]
[[nl:Template:IPA]]
[[nn:Mal:IPA]]
[[no:Mal:IPA]]
[[pl:Szablon:IPA]]
[[pt:Predefinição:AFI]]
[[ru:Шаблон:IPA]]
[[simple:Template:IPA]]
[[sr:Шаблон:МФА]]
[[sv:Mall:IPA]]
[[th:แม่แบบ:IPA]]
[[tpi:Template:IPA]]
[[vi:Tiêu bản:IPA]]
</includeonly>

Latest revision as of 14:47, 1 March 2014

Usage

Template:IPA is most useful when there are multiple instances of the International Phonetic Alphabet (IPA) on a page. It contains

<span title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">{{{1}}}</span>

This means, it simply specifies a class called “IPA” as a hook for CSS styling and DOM scripting.

This allows fixing broken display of IPA characters in MS Internet Explorer 6 for Windows, and choice of style in any browser.

The font declaration is in MediaWiki:Common.js and targets only Windows XP. Registered Wikipedia users can specify their own style for IPA text by editing, for each project, their user style sheet, e.g. monobook.css. Users can also specify the style locally in their browser, which works across projects.

MediaWiki:Common.css also ensures that links inside IPA transcriptions marked up with this template do not use underlines since these carry special semantics there.

TemplateData

{
"description": "This template ensures proper display of transcriptions using the International
Phonetic Alphabet (IPA), especially in older operating systems and browsers. There are related
 specialized templates that also semi-automatically generate the transcription itself.",
"params": {
  "1": {
    "label": "transcription",
    "description": "including square brackets [...] for phonetic transcriptions or enclosing
 forward slashes /.../ for phonemic ones",
    "type": "string",
    "required": true
  }
}}

Examples

Placing a phonemic rendering of the word characters in Template:IPA:

{{IPA|/ˈkærəktɚz/}}
{{IPA|/[[character|ˈkærəktɚz]]/}}

The result will be a span with a class attribute, like this:

<span title="Representation in the International Phonetic Alphabet (IPA)" class="IPA">/ˈkærəktɚz/</span>

Which appear in your browser as:

/ˈkærəktɚz/
/ˈkærəktɚz/

Without template:IPA:

/ˈkærəktɚz/
/ˈkærəktɚz/

[These sets should only look different if you are using Internet Explorer 6 or lower on Windows, or if you have a custom style defined for IPA text.]

Please place all IPA text into Template:IPA, even if it doesn't have any special IPA characters, like this: /mi/. This will allow users to format all examples of IPA text consistently, with their choice of fonts, colours, etc.