View source for Module:Gender and number/documentation

This module shows gender/number annotations, such as {{g|m}} (masculine), {{g|n-p}} (neuter plural) or {{g|f-an-d}} (feminine animate dual). "Gender" is something of a misnomer, as the available annotation categories include other similar lexical characteristics such as animacy and verb aspect (though the former is sometimes also considered a part of word gender). These annotations are attached to nouns, pronouns and other parts of speech that have such lexical categories, depending on the particular language. The annotations occur as parameters e.g. to headword templates such as {{tl|head}}, {{tl|es-noun}} (for Spanish nouns), {{tl|fr-proper noun}} (for French proper nouns) and {{tl|ru-verb}} (for Russian verbs); to translation templates such as {{tl|t}}, {{tl|t+}} and {{tl|t-check}}; to definition templates such as {{tl|demonym-noun}}; and to dedicated gender/number templates such as {{tl|g}}. __TOC__

==Gender/number specifications==
A given annotation is described using a ''gender/number specification''. Each such specification is a hyphen-separated list of ''gender/number codes'', where a given code describes a single value of a particular category (e.g. ''m'' for "masculine", ''an'' for "animate", ''p'' for "plural"). Often, templates accept a list of gender/number specifications rather than just a single one, since some terms belong to multiple possible gender/number categories. Depending on the template in question, these specifications will be given using separate parameters or a single comma-separated parameter.

When displaying a specification, each code in the specification is converted into the appropriate display form. The different codes within the specification are then added together, separated by spaces.

Some examples:
{| class="wikitable"
! List
! Result
|-
| {"m"} || {{#invoke:gender and number|show_list|m}}
|-
| {"m-p"} || {{#invoke:gender and number|show_list|m-p}}
|-
| {"m-an-p"} || {{#invoke:gender and number|show_list|m-an-p}}
|-
| {"mfbysense-p"} || {{#invoke:gender and number|show_list|mfbysense-p}}
|-
| {"?-p"} || {{#invoke:gender and number|show_list|?-p}}
|-
| {"?!-an-s"} || {{#invoke:gender and number|show_list|?!-an-s}}
|-
| {"f-d", "m-p"} || {{#invoke:gender and number|show_list|f-d|m-p}}
|-
| {"m-p", "f-p"} || {{#invoke:gender and number|show_list|m-p|f-p}}
|-
| {"m", "f", "p"} || {{#invoke:gender and number|show_list|m|f|p}}
|}

The source of truth for the current set of recognized codes is [[Module:gender and number/data]].

The following table gives:
# the currently recognized codes;
# the type category they belong to (in a given spec, only one code in a given type category can be present);
# how the codes display (hover over the display form to see an explanation of what the code means);
# which category (if any) that the term will be assigned to if the code in question is in the term's headword gender/number spec (where <code>POS</code> is replaced by the pluralized part of speech of the term).

{{#invoke:gender and number doc|gender_and_number_table}}

Certain gender/number codes are ''combination codes'' that are more or less equivalent to individually specifying two or more codes of a given type category in separate gender/number specs. Some combination codes categorize and display additionally. The following table gives these combination codes:

{{#invoke:gender and number doc|combinations_table}}

In certain type categories, if more than one code of that category is given (necessarily in different gender/number specifications), the term is added to a special category. The following table gives these multi-code categories:

{{#invoke:gender and number doc|multicode_table}}

==Noun classes==
Specifications that begin with "c" (but not "c" itself) are treated specially. They are considered noun classes, and the part immediately after the "c" is simply treated as some kind of name for a noun class; usually this will be a number. Noun classes do not have sub-parts, so they will not contain hyphens. When more than one specification is given, they must all be noun classes, and they are displayed separated with a forward slash instead, and preceded by ''class''.

Examples:
{| class="wikitable"
! List
! Result
|-
| {"c1"} || {{#invoke:gender and number|show_list|c1}}
|-
| {"c1", "c2"} || {{#invoke:gender and number|show_list|c1|c2}}
|-
| {"c1a", "c2a"} || {{#invoke:gender and number|show_list|c1a|c2a}}
|}

==Usage==
The module can be used from another module by importing it and calling the exported <code>format_list</code> function. It requires one parameter, which must be a table of zero or more strings. It will then return a string containing the result. For example:

<syntaxhighlight lang="lua">
local gen = require("Module:gender and number")
local example1 = gen.format_list({"m"})
local example2 = gen.format_list({"m", "f"})
local example3 = gen.format_list({"m-p"})
</syntaxhighlight>

'''WARNING: The list passed in will be overwritten.'''

It can also be invoked from a template. The function <code>show_list</code> is used for this. It works the same way as the <code>format_list</code> function, but the specifications are passed as parameters to the module invocation, like so:

<pre>
*{{#invoke:gender and number|show_list|m}}
*{{#invoke:gender and number|show_list|m|f}}
*{{#invoke:gender and number|show_list|m-p}}
</pre>

:*{{#invoke:gender and number|show_list|m}}
:*{{#invoke:gender and number|show_list|m|f}}
:*{{#invoke:gender and number|show_list|m-p}}

There is no limit to the number of parameters that can be given this way. The module will process all of its parameters until it finds one that is empty. This means that the following will display only "{{#invoke:gender and number|show_list|m}}" and not "{{#invoke:gender and number|show_list|m|n}}":

<pre>
{{#invoke:gender and number|show_list|m||n}}
</pre>

{{module cat|-|Page generation}}