Module:families/templates/documentation

This module provides access to Module:families from templates, so that they can make use of the information stored there.

exists
Check whether a family code exists and is valid. It will return "1" if the family code exists, and the empty string "" if it does not.

This is rarely needed, because a script error will result when someone uses a code that is not valid, so you do not need this just to check for errors. However, in case you need to decide different actions based on whether a certain parameter is a family code or something else, this function can be useful.

getByCode
Queries information about a family code.


 * The family code should be one of the codes that is defined in Module:families data. If it is missing or does not exist, the result will be a script error.
 * The item is the name of one of the pieces of data that is stored for a family, such as  or  . If no item has been provided, the result will be a script error. However, if the name of a nonexistent item is given, the result will be an empty string. This allows you to check for the presence or absence of an item without triggering errors.
 * The index is optional, and is used for items that are lists, such as . It selects which item in the list to return. On items that are single strings, like , it has no effect. If no index is given, the default will be 1 (the first subitem). If an index is given that is higher than the number of items in the list, the result will be an empty string.

For example, to request the default (canonical) name of the family whose code is :


 * Result:

To request its second name, if any:


 * Result:

To request its family:


 * Result: