Module:TaxonList/doc

From HandWiki
< Module:TaxonList
Revision as of 17:39, 11 April 2021 by imported>Jworkorg (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:TaxonList

Module:TaxonList (talk · edit · 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

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 to yes to italicize each taxon name
  • linked – set to yes to wikilink each taxon name
  • bold – set to yes to embolden each taxon name (also turns off wikilinking)
  • incomplete – set to yes to 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}}