Template:form of/infldoc/documentation

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.

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

Examples and a see-also section can follow the declaration, and should be formatted for example like this:

Examples
On (elative of the adjective ): &lt;/pre>gives

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  for English.


 * cat, cat2, ...
 * Categories which the template categorizes the page into. They should be specified without any preceding language name, e.g..


 * shortcut, shortcut2, ...
 * Shortcut names of this template. They should be specified with the preceding namespace tag (normally ), but without being linked.


 * sgdesc
 * The singular description of this template, normally preceded by "the". Examples are  or  . Defaults to the template name minus any trailing "of", preceded by "the". For example, the template  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 to add the literal text "form". This is used for example in the documentation for, where "the feminine form of a primary entry" is clearer than "the feminine of a primary entry".