Module:Taxobox ranks/doc
 | This is a documentation subpage for Module:Taxobox ranks. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used on approximately 605,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
Module:Taxobox ranks (talk · · hist · links · doc · sandbox · testcases)
This module provides support to the automated taxobox system – templates such as {{Automatic taxobox}} or {{Speciesbox}}. Part of it also supports manual taxoboxes.
It defines:
- The rank names that are acceptable and the way they are displayed in English.
- For a subset of the rank names, it defines arbitrary numerical values that are used to check the consistent ordering of ranks in a taxonomic hierarchy.
It is thus part of the configuration of taxoboxes and taxonomy templates.
To add a new rank
To add a new rank, edit the table that defines the local variable ranks in this module. The rank name should be in Latin, where a Latin version exists, and should be all lower-case. The equivalent English name should be capitalised. 'Special cases' have italicized English names.
Usage
{{Anglicise rank}} uses this module by invoking the function angliciseRank(). See the documentation of {{Anglicise rank}} for details of how the function behaves.
A table containing all the ranks defined in the module can be displayed via {{#invoke:Taxobox ranks|showRanks}}.
A table containing all the rank values defined in the module can be displayed via {{#invoke:Taxobox ranks|showRankTable}}.