Module:Form of/templates/documentation

This module contains code that directly implements {{form of}}, {{inflection of}}, and the various other form-of templates. It is meant to be called directly from templates. See also Module:form of, which contains the underlying implementing code and is meant to be called from other modules.

form_of_t

{{#invoke:form of/templates|form_of_t}}

Template-callable implementation of {{form of}} and the various more specific form-of templates (but not {{inflection of}} or templates that take tagged inflection parameters). See the code for the exact invocation arguments.

tagged_form_of_t

{{#invoke:form of/templates|tagged_form_of_t}}

Template-callable implementation of form-of templates that are defined by specific tagged inflections (typically a template referring to a non-lemma inflection, such as {{genitive plural of}}). This works exactly like form_of_t() except that the "form of" text displayed before the link is based off of a pre-specified set of inflection tags (which will be appropriately linked to the glossary) instead of arbitrary text. From the user's perspective, there is no difference between templates implemented using form_of_t() and tagged_form_of_t(); they accept exactly the same parameters and work the same. See also inflection_of_t() below, which is intended for templates with user-specified inflection tags.

See the code for the exact invocation arguments, which are very similar to form_of_t().

inflection_of_t

{{#invoke:form of/templates|inflection_of_t}}

Template-callable implementation of {{inflection of}} and certain semi-specific variants, such as {{participle of}} and {{past participle form of}}. This function is intended for templates that allow the user to specify a set of inflection tags. It works similarly to form_of_t() and tagged_form_of_t() except that the calling convention for the calling template is

{{TEMPLATE|LANG|MAIN_ENTRY_LINK|MAIN_ENTRY_DISPLAY_TEXT|TAG|TAG|...}}

instead of

{{TEMPLATE|LANG|MAIN_ENTRY_LINK|MAIN_ENTRY_DISPLAY_TEXT|GLOSS}}

Note that there isn't a numbered parameter for the gloss, but it can still be specified using |t= or |gloss=.

See the code for the exact invocation arguments, which are very similar to form_of_t() and tagged_form_of_t().

normalize_pos

{{#invoke:form of/templates|normalize_pos}}

Template-callable function to normalize a part-of-speech tag given a possible abbreviation (passed in as |1= of the invocation args). If the abbreviation isn't recognized, the original POS tag is returned. If no POS tag is passed in, return the value of invocation arg |default=.