Template:form of/fulldoc/documentation

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.

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 :
 * 1)  &lt;/pre>gives

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.


 * pldesc
 * The plural description of this template, without any preceding article. Examples are  or  . Defaults to the template name minus any trailing "of", and pluralized with an "s", e.g. for, 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).


 * 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.


 * 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, 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.


 * art
 * As an alternative to specifying sgdescof, this parameter overrides only the auto-generated article at the beginning of the description.