Template:form of/fulldoc

BEGIN SAMPLE OUTPUT OF TEMPLATE:

Uses Lua:

Module:form of/templates

This template creates a definition line for form of/fulldocs of primary entries.

By default, this template displays its output with an initial lowercase letter. This can be overridden by using |cap=1 to make the initial letter capitalized (but this is not generally recommended for non-English languages, as non-English definitions should be lowercase).

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:

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

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

Parameters

Positional (unnamed) parameters:

|1= (required): The language code of the term linked to (which this page is a form of/fulldoc). 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 a form of/fulldoc). 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. This parameter can also include multiple terms separated by a comma, as long as there is no space after the comma, and each such term can have inline modifiers specifying transliterations, display forms, qualifiers, labels, genders and other properties. See below.
|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.
|cat=, |cat2=, |cat3=, etc. (optional): Additional categories to place the page into. They are automatically prepended with the language name. A single parameter can contain multiple comma-separated categories as long as there is no space after the comma.
|addl= (optional): Additional text to display at the end, before the final closing <span/> tag. It is normally joined to the preceding text by a comma followed by a space. However, if the value of |addl= begins with a colon or semicolon, it is appended directly with no joining punctuation, and if the value begins with an underscore, the remainder is joined to the preceding text with a space.
|cap= (optional): If |cap=1, then the first letter will be in capitalized. Not generally recommended, except for English definitions, because non-English definitions should begin with a lowercase letter and be formatted like a phrase, rather than a full sentence.
|notext= (optional): If |notext=1, don't display the initial text preceding the term(s), but only the actual term or terms. The page is still categorized as normal, unless |nocat=1 is given.
|id= (optional): A sense id for the term, which links to anchors on the page set by the {{senseid}} template.
|sc= (optional): Script code to use, if script detection does not work. See Wiktionary:Scripts. Rarely needs to be given.
|sort= (optional): Sort key for sorting any categories the page is added to. Rarely needs to be given except for Japanese, and even then, only when there are multiple possible pronunciations.

Inline modifiers

Use a syntax like Изабе́лла<tr:Izabɛ́lla><t:Isabelle> to specify modifiers such as transliterations, glosses and qualifiers. In this example, for the Russian name Изабе́лла (Izabɛ́lla, “Isabelle”), the manual transliteration Izabɛ́lla and gloss "Isabelle" are given. The following modifiers are recognized; see {{link}} for the exact meaning of these modifiers.

t: gloss
tr: transliteration
ts: transcription, for languages where the transliteration and pronunciation are markedly different
q: left qualifier, e.g. <q:neither sexual nor romantic in nature> (in reference to platonic love); this appears before the term, parenthesized and italicized
qq: right qualifier; this appears after the term, parenthesized and italicized
l: comma-separated left labels, e.g. <l:rare> or <l:UK,Australia> or <l:archaic,or,dialectal>; as shown, there must not be a space after the comma for it to be recognized as a delimiter; the labels appear before the term, parenthesized, italicized and appropriately linked as if {{lb}} were used (but without categorization); an alternative syntax is to enclose the labels in <<...>>, e.g. <l:<<rare>>, <<archaic>> or <<dialectal>>>
ll: comma-separated right labels; these appear after the term, parenthesized, italicized and appropriately linked as for left labels
ref: reference or references, using the syntax documented in Template:IPA#References
g: comma-separated list of gender/number specifications; see Module:gender and number for the complete list
alt: alternative display text
pos: part of speech
lit: literal meaning
id: sense ID; see {{senseid}}
sc: script code

END SAMPLE OUTPUT OF TEMPLATE

The following documentation is located at Template:form of/fulldoc/documentation.

Useful links: root page • root page’s subpages • links • redirects • transclusions • errors (parser/module) • sandbox

Uses Lua:

Module:form of doc/templates

This template should be used for displaying the documentation of a form-of template. Note that form-of templates that describe a non-lemma inflection of a lemma form should be documented using {{form of/infldoc}}.

This template is used on the documentation page usually as follows:

{{form of/fulldoc|...}}
<includeonly>
]
</includeonly>

Examples and a see-also section can follow the {{form of/fulldoc}} declaration, and should be formatted for example like this:

{{form of/fulldoc|withcap=1}}
===Examples===
On {{m|en|job centre}}:
 <pre># {{lb|en|business|UK}} {{synonym of|en|job center}}</pre>gives
# {{lb|en|business|UK}} {{synonym of|en|job center}}

==See also==
* {{section link|Wiktionary:Semantic relations#Synonymy}}
<includeonly>
]
</includeonly>

Additional categories you may want to add the template to are Category:Declension form-of templates, Category:Conjugation form-of templates and Category:Grammar form-of templates.

Parameters

All parameters are optional.

|lang=: If given, this is a language-specific template, which automatically assumes the specified language and does not take a language-code parameter.
|exlang=, |exlang2=, ...: For non-language-specific templates, language codes of example languages to which the template applies. Defaults to en for English.
|cat=, |cat2=, ...: Categories which the template categorizes the page into. They should be specified without any preceding language name, e.g. obsolete forms. Multiple comma-separated categories can be included in a single parameter as long as there isn't a space after the comma.
|shortcut=, |shortcut2=, ...: Shortcut names of this template. They do not need to be preceded with Template:, which is automatically added. Multiple comma-separated shortcuts can be included in a single parameter as long as there isn't a space after the comma.
|pldesc=: The plural description of this template, without any preceding article. Examples are alternative typographies or ]. Defaults to the template name minus any trailing "of", and pluralized with an "s", e.g. for {{obsolete spelling of}}, this will have the default "obsolete spellings". Normally, use this for inserting links into the text or for irregular plurals.
|primaryentrytext=: By default, the literal text of primary entries, which directly follows the text specified by |pldesc=.
|addlintrotext=: Any additional text to insert at the end of the first paragraph of the intro. This text normally specifies what the template does (using |pldesc=, |primaryentrytext=), the language it applies to (if |lang= is given), example languages it may apply to (if |exlang= is given), as well as any categories that the page is added to (of |cat= is given).
|addlparamtext=: Any additional text to insert at the end of the named parameter section, before the section on inline modifiers. This can be used to expand on the usage of certain parameters, such as |from=/|from2=.
|withdot=: If true, specifies that the template adds a trailing period by default and takes |dot= and |nodot= parameters to override this.
|withcap=: If true, specifies that the template begins by default with an initial capital letter and takes a |nocap= parameter to override this.
|withencap=: If true, specifies that the template begins by default with an initial capital letter when the language is English (but not otherwise). Use |nocap=1 to make the initial letter lowercase in English, and |cap=1 to make the initial letter capitalized in non-English languages (although this is not generally recommended).
|withfrom=: If true, specifies that the template takes optional parameters |from=, |from2=, etc. to specify regional context labels to appear in the definition line.
|sgdescof=: Singular form of the template description, with trailing "of"; should normally preceded by "a" or "an" as appropriate. By default this is derived from the template name with "an" prepended if the name starts with a vowel and "a" prepended otherwise. For example, for the template {{alternative case form of}}, the default value will be "an alternative case form of". This is used in the parameter descriptions of the second and third numbered parameters and normally does not need to be overridden. An example of a template that overrides this is {{short for}}.
|art=: As an alternative to specifying |sgdescof=, this parameter overrides only the auto-generated article at the beginning of the description.

Template:form of/fulldoc

Usage

Parameters

Inline modifiers

Parameters

See also

Wikious

Boobota

Sagapedia