Module:TaxonList/doc
This is the documentation page for Module:TaxonList
| File:Ambox warning yellow.svg | This Lua module is used on approximately 14,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
| File:Lua-Logo.svg | This module depends on the following other modules: |
Module:TaxonList (talk⧼dot-separator⧽⧼dot-separator⧽hist⧼dot-separator⧽links⧼dot-separator⧽doc⧼dot-separator⧽sandbox⧼dot-separator⧽testcases)
The purpose of this module is to provide support for a set of templates that produce a list of taxon names and their authorities, with the taxon names possibly italicized, wikilinked or emboldened. It allows these templates to have an indefinite number of arguments of the form taxonName1|authority1|taxonName2|authority2| ... |taxonNameN|authorityN. Templates supported are: {{Bold species list}}, {{Linked species list}}, {{Linked taxon list}}, {{Species list}} and {{Taxon list}}.
Usage
The main function in this module must only be invoked from within a template that itself is transcluded from a page that supplies taxon name/authority pairs as arguments, since main picks up these arguments from the parent frame.
{{#invoke:TaxonList|main|PARAMETERS}}
where PARAMETERS may be
italic– set toyesto italicize each taxon namelinked– set toyesto wikilink each taxon namebold– set toyesto embolden each taxon name (also turns off wikilinking)incomplete– set toyesto output "(incomplete)" at the end of the list
Examples
{{Taxon list}} contains {{#invoke:TaxonList|main|incomplete={{{incomplete|no}}}}}. Hence:
{{Taxon list |Asparagales|Bromhead |Iridales|Dumortier}} →
- Asparagales Bromhead
- Dumortier Iridales
{{Linked species list}} contains {{#invoke:TaxonList|main|linked=yes|italic=yes|incomplete={{{incomplete|no}}}}}. Hence:
{{Linked species list |Poecilotheria fasciata|(Latreille, 1804) |Poecilotheria ornata|Pocock, 1899 |Poecilotheria rajaei|Nanayakkara et al., 2012 |incomplete=yes}} →
- Nanayakkara et al., 2012 (Latreille, 1804)
- Poecilotheria ornata Poecilotheria fasciata
- Pocock, 1899 Poecilotheria rajaei (incomplete list)
