View source for Module:TaxonList/doc

{{high-use|2482}}
{{Module rating|protected}}
[[Module:TaxonList]] {{Toolbar|style=font-size:90% |separator=dot
     | 1 = [[:Module talk:TaxonList|talk]]
     | 2 = {{edit|1=Module:TaxonList|2=edit}}
     | 3 = {{history|Module:TaxonList|hist}}
     | 4 = [{{fullurl:Special:WhatLinksHere/:Module:TaxonList|limit=999}} links]
     | 5 = [[Module:TaxonList/doc|doc]]
     | 6 = [[Module:TaxonList/sandbox|sandbox]]
     | 7 = [[Template:Taxon list/testcases|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 <code>taxonName1|authority1|taxonName2|authority2| ... |taxonNameN|authorityN</code>. Templates supported are: {{tl|Bold species list}}, {{tl|Linked species list}}, {{tl|Linked taxon list}}, {{tl|Species list}} and {{tl|Taxon list}}.

== Usage ==

The <code>main</code> 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 <code>main</code> picks up these arguments from the <em>parent</em> frame.

<code><nowiki>{{</nowiki>#invoke:TaxonList|main|PARAMETERS}}</code>

where <code>PARAMETERS</code> may be

*<code>italic</code> – set to <code>yes</code> to italicize each taxon name
*<code>linked</code> – set to <code>yes</code> to wikilink each taxon name
*<code>bold</code> – set to <code>yes</code> to embolden each taxon name (also turns off wikilinking)
*<code>incomplete</code> – set to <code>yes</code> to output "(incomplete)" at the end of the list

== Examples ==
{{tl|Taxon list}} contains <code><nowiki>{{#invoke:TaxonList|main|incomplete={{{incomplete|no}}}}}</nowiki></code>. Hence:

<code><nowiki>{{Taxon list |Asparagales|Bromhead |Iridales|Dumortier}}</nowiki></code> →<br>
{{Taxon list |Asparagales|Bromhead |Iridales|Dumortier}}

{{tl|Linked  species list}} contains <code><nowiki>{{#invoke:TaxonList|main|linked=yes|italic=yes|incomplete={{{incomplete|no}}}}}</nowiki></code>. Hence:

<code><nowiki>{{Linked species list |Poecilotheria fasciata|(Latreille, 1804) |Poecilotheria ornata|Pocock, 1899 |Poecilotheria rajaei|Nanayakkara et al., 2012 |incomplete=yes}}</nowiki></code> →<br>
{{Linked species list |Poecilotheria fasciata|(Latreille, 1804) |Poecilotheria ornata|Pocock, 1899 |Poecilotheria rajaei|Nanayakkara et al., 2012 |incomplete=yes}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>