Module:TaxonList/doc
 | This is a documentation subpage for Module:TaxonList. 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 25,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. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
| File:Lua-Logo.svg | This module depends on the following other modules: |
Module:TaxonList (talk · · hist · links · doc · sandbox · 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
[edit source]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
[edit source]{{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)