View source for Template:Needs IPA/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{lua|Module:Lang|Module:String}}
This template should be used on a single word or phrase that requires [[Transcription (linguistics)|transcription]] into the [[International Phonetic Alphabet]]. Use directly after the word or phrase. This template is a self-reference and so is part of the Wikipedia project rather than the encyclopedic content.

== Usage ==
* <code><nowiki>{{needs IPA|lang=xx}}</nowiki></code>
where <code>xx</code> is the [[ISO 639]] code for the language for which a transcription is requested. It supports up to three languages.

* <code><nowiki>{{needs IPA|lang=xx|lang2=yy|lang3=zz}}</nowiki></code>

In the main namespace, the template categorizes the page into the category named "Articles needing [language name] IPA" if it exists, and into [[:Category:Articles needing IPA]] if it doesn't (or if no language is specified).

You may explicitly specify the term or language being requested in the first parameter, which appears between "needs" and "IPA":
* <code><nowiki>{{needs IPA|English|lang=en}}</nowiki></code>
* <code><nowiki>{{needs IPA|surname|lang=xx}}</nowiki></code>

=== Examples ===
{{Automarkup
|Glauxkenfruble{{needs IPA{{!}}lang=lt}}
|Glauxkenfruble{{needs IPA{{!}}Lithuanian{{!}}lang=lt}}
}}

== Tracking categories ==
* {{clc|Articles needing IPA}}
** {{clc|Articles needing English IPA}}

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
	"description": "An inline template that marks a word or phrase as requiring transcription in the International Phonetic Alphabet",
	"params": {
		"1": {
			"label": "Qualifier",
			"description": "Text that appears between \"needs\" and \"IPA\"",
			"type": "string",
			"required": false,
			"example": "Lithuanian"
		},
		"date": {
			"label": "Month and year",
			"description": "Provides the month and year; e.g., 'January 2013', but not 'jan13'",
			"type": "string",
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true
		},
		"lang": {
			"label": "Language",
			"description": "ISO 639 language code for the language for which a transcription is requested",
			"example": "en",
			"type": "string",
			"suggested": true
		},
		"lang2": {
			"label": "Language 2",
			"description": "ISO 639 language code for the second language for which a transcription is requested",
			"example": "de",
			"type": "string"
		},
		"lang3": {
			"label": "Language 3",
			"description": "ISO 639 language code for the third language for which a transcription is requested",
			"example": "ar",
			"type": "string"
		},
		"reason": {
			"label": "Reason",
			"description": "Text appended in the tooltip providing context for the request",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"lang",
		"lang2",
		"lang3",
		"reason",
		"date"
	]
}
</templatedata>

== See also ==
* {{tl|Pronunciation needed}}, another inline template requesting [[phonetic transcription]]

{{IPA templates}}
{{Inline cleanup tags}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Inline cleanup templates]]
[[Category:International Phonetic Alphabet templates]]
[[Category:Language maintenance templates]]
}}</includeonly>