Template:form of/infldoc

BEGIN SAMPLE OUTPUT OF TEMPLATE:

Uses Lua:

Module:form of/templates

This template creates a definition line for the form of/infldoc of a primary entry.

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/infldoc|<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 the form of/infldoc 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 the form of/infldoc 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.
|id= (optional): A sense id for the term, which links to anchors on the page set by the {{senseid}} template.

END SAMPLE OUTPUT OF TEMPLATE

The following documentation is located at Template:form of/infldoc/documentation. ^[edit]

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

This template should be used for displaying the documentation of a form-of template, particularly one that indicates a non-lemma inflection of a lemma form. Form-of templates that describe other sorts of variants should be documented using {{form of/fulldoc}}.

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

{{form of/infldoc|...}}
<includeonly>
[[Category:Form-of templates]]
</includeonly>

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

{{form of/infldoc|sgdesc=the [[Appendix:Glossary#elative|elative]] degree|exlang=ar|addlintrotext=This template does not currently place the page into any category; that is done by the headword template, e.g. {{temp|ar-elative}}.}}

===Examples===
On {{ncog|ar|أَكْبَر}} (elative of the adjective {{m|ar|كَبِير}}):
 <pre>{{elative of|ar|كَبِير}}</pre>gives
# {{elative of|ar|كَبِير}}
<includeonly>
[[Category:Form-of templates]]
[[Category:Grammar form-of templates]]
</includeonly>

Generally you will want to specify Category:Form-of templates as well as one of Category:Declension form-of templates, Category:Conjugation form-of templates or 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.
|shortcut=, |shortcut2=, ...: Shortcut names of this template. They should be specified with the preceding namespace tag (normally Template:), but without being linked.
|sgdesc=: The singular description of this template, normally preceded by "the". Examples are the feminine equivalent or the [[Appendix:Glossary#elative|elative]] degree. Defaults to the template name minus any trailing "of", preceded by "the". For example, the template {{dative plural of}} will have the default "the dative plural". Normally, use this for inserting links into the text or descriptive text that otherwise differs from the template name. In lieu of using this parameter, the default can also be customized using |form= and/or |art=.
|primaryentrytext=: By default, the literal text "of a primary entry", which directly follows the text specified by |sgdesc=.
|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 |sgdesc=, |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).
|withtags=: If true, specifies that the template takes inflection tags starting with numbered params |4= and up instead of a gloss.
|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.
|withfrom=: If true, specifies that the template takes optional parameters |from=, |from2=, etc. to specify regional context labels to appear in the definition line.
|withp=: If true, specifies that the template takes an optional parameter |p= or |POS= to specify the part of speech for categorization purposes.
|sgdescof=: Singular form of the template description, with trailing "of"; should normally preceded by "the". By default this is derived from |sgdesc= with the addition of "of", and rarely needs to be overridden.
|art=: As an alternative to specifying |sgdesc=, this parameter overrides only the auto-generated article "the" at the beginning of the description.
|form=: As an alternative to specifying |sgdesc=, this parameter adds additional text (e.g. "form" or "variant") at the end of the default value. This is most frequently specified as |form=form to add the literal text "form". This is used for example in the documentation for {{feminine of}}, where "the feminine form of a primary entry" is clearer than "the feminine of a primary entry".

Usage

Parameters

Parameters

See also