Template:alternative form of/documentation

This template is for definition sections. For the template used to list alternative spellings linking to other articles, see Template:alter.

	Documentation for Template:alternative form of. ^[edit]
	This page contains usage information, categories, interwiki links and other content describing the template.

Shortcuts:
{{altform}}
{{alt form}}
{{alt form of}}

Uses Lua:

This template creates a definition line for alternative forms of primary entries.

By default, this template displays its output with an initial capital letter. This can be overridden using |nocap=1 (see below).

This template is not meant to be used in etymology sections.

Note that users can customize how the output of this template displays by modifying their Custom CSS files. See “Form of” templates for details.

Usage

Use in the definition line, most commonly as follows:

# {{alternative form of|<langcode>|<primary entry goes here>}}

where <langcode> is the language code, e.g. en for English, de for German, or ja for Japanese.

Positional (unnamed) parameters:

|1= (required): The language code of the term linked to (which this page is an alternative form of). See Wiktionary:List of languages. The parameter |lang= is a deprecated synonym; please do not use. If this is used, all numbered parameters move down by one.
|2= (required): The term to link to (which this page is an alternative form of). This should include diacritics as appropriate to the language (e.g. accents in Russian to mark the stress, vowel diacritics in Arabic, macrons in Latin to indicate vowel length, etc.). These diacritics will automatically be stripped out in a language-specific fashion in order to create the link to the page.
|3= (optional): The text to be shown in the link to the term. If empty or omitted, the term specified by the second parameter will be used. This parameter is normally not necessary, and should not be used solely to indicate diacritics; instead, put the diacritics in the second parameter.

Named parameters:

|t= or |4= (optional): A gloss or short translation of the term linked to. The parameter |gloss= is a deprecated synonym; please do not use.
|tr= (optional): Transliteration for non-Latin-script terms, if different from the automatically-generated one.
|ts= (optional): Transcription for non-Latin-script terms whose transliteration is markedly different from the actual pronunciation. Should not be used for IPA pronunciations.
|sc= (optional): Script code to use, if script detection does not work. See Wiktionary:Scripts.
|from=, |from2=, |from3=, etc. (optional): A label (see {{label}}) that gives additional information on the dialect that the term belongs to, the place that it originates from, or something similar.
|nocap= (optional): If |nocap=1, then the first letter will be in lowercase.
|id= (optional): A sense id for the term, which links to anchors on the page set by the {{senseid}} template.

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for alternative form of

Indicates that a term is an alternate form of another term, such as contractions

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
language code	`1`	language code for the term's language Example en	String	required
term	`2`	The term that this term is the alternate form of Example Judaeo-Spanish	Page name	required
displayed text	`3`	text to display for the linked term	Line	optional
gloss	`4`	a gloss of the term	String	optional
transliteration	`tr`	a transliteration of the term	String	optional
script code	`sc`	A script code for the term Example Hant	String	optional
dialect/region of origin	`from`	Names a dialect or region from which the term originates. Parameters from2 through from5 also available. Example Southern US	String	optional
dialect/region of origin 2	`from2`	Names a dialect or region from which the term originates. Parameters from2 through from5 also available. Example Taiwanese Hokkien	String	optional