Editing Module:TaxonItalics/doc

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
[[Module:TaxonItalics]] {{Toolbar|style=font-size:90% |separator=dot
     | 1 = [[:Module talk:TaxonItalics|talk]]
     | 2 = {{edit|1=Module:TaxonItalics|2=edit}}
     | 3 = {{history|Module:TaxonItalics|hist}}
     | 4 = [{{fullurl:Special:WhatLinksHere/:Module:TaxonItalics|limit=999}} links]
     | 5 = [[Module:TaxonItalics/doc|doc]]
     | 6 = [[Special:PrefixIndex/Module:TaxonItalics|subpages]]
     | 7 = [[Module:TaxonItalics/sandbox|sandbox]]
     | 8 = [[Module talk:TaxonItalics/testcases|testcases]]
}}
{{high risk|439099}}
==Purpose==
The module is primarily intended for use by the [[WP:Automated taxobox system|automated taxobox system]]. It supports the correct italicization of scientific names. Botanical ([[International Code of Nomenclature for algae, fungi, and plants|ICNafp]]) names may contain "connecting terms"; these must not be italicized. The hybrid symbol, ×, should also not be italicized. The module optionally wikilinks and abbreviates italicized names.

For non-virus taxa, italics are used at the rank of genus or below. The module does not decide whether a scientific name should be italicized. Use {{tlx|Is italic taxon}} for this purpose.

==Usage==
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME}}</nowiki> – italicizes a taxon name
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME|linked=yes}}</nowiki> – italicizes a taxon name, wikilinking the italicized output to the unchanged input
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME|abbreviated=yes}}</nowiki> – italicizes a taxon name, abbreviating all but the last part to the first letter
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME|dab=yes}}</nowiki> – italicizes a taxon name, treating any parenthesized part as a disambiguation term, and not italicizing it

The parameters can be combined. It can also be used via {{tl|Taxon italics}}.

==Examples==
===Just italicized===
;Connecting terms
* Pinus subg. Pinus → {{#invoke:TaxonItalics|main|Pinus subg. Pinus}}
* P. subgenus Pinus → {{#invoke:TaxonItalics|main|P. subgenus Pinus}}
* P. subsect. Pinaster → {{#invoke:TaxonItalics|main|P. subsect. Pinaster}}
* Acer tataricum subsp. ginnala → {{#invoke:TaxonItalics|main|Acer tataricum subsp. ginnala}}
* Aster ericoides var. ericoides → {{#invoke:TaxonItalics|main|Aster ericoides var. ericoides}}
* A. ericoides varietas ericoides → {{#invoke:TaxonItalics|main|A. ericoides varietas ericoides}}
* A. e. subvar. ericoides → {{#invoke:TaxonItalics|main|A. e. subvar. ericoides}}
Botanical names may contain only one infraspecific epithet; a string like "Fragaria vesca subsp. vesca f. semperflorens" is a classification, not a name, and is not handled by the module.

;Hybrid symbols
* Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla}}
* ×Beallara → {{#invoke:TaxonItalics|main|×Beallara}}
* &amp;times; Beallara → {{#invoke:TaxonItalics|main|&times; Beallara}}
* <nowiki>{{hybrid}}</nowiki>Beallara → {{#invoke:TaxonItalics|main|{{hybrid}}Beallara}}

===Linked===
Using  {{para|linked|yes}}
* Populus sect. Aigeiros → {{#invoke:TaxonItalics|main|Populus sect. Aigeiros|linked=yes}}
* Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla|linked=yes}}

===Abbreviated===
Using  {{para|abbreviated|yes}}
* Populus sect. Aigeiros → {{#invoke:TaxonItalics|main|Populus sect. Aigeiros|abbreviated=yes}}
* Acer tataricum subsp. ginnala → {{#invoke:TaxonItalics|main|Acer tataricum subsp. ginnala|abbreviated=yes}}
* [also linked] × Sorbaronia fallax → {{#invoke:TaxonItalics|main|× Sorbaronia fallax|abbreviated=yes|linked=yes}}
* [also linked] Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla|abbreviated=yes|linked=yes}}
* Elaeagnus ×submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus ×submacrophylla|abbreviated=yes}}
* Elaeagnus <nowiki>{{hybrid}}</nowiki> submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus {{hybrid}} submacrophylla|abbreviated=yes}}

===Disambiguation terms===
By default, a parenthesized part of a taxon name is assumed to be a subgenus name, and is italicized:
* Varanus (Hapturosaurus) → {{#invoke:TaxonItalics|main|Varanus (Hapturosaurus)}}
* Caia (plant) → {{#invoke:TaxonItalics|main|Caia (plant)}} – {{red|wrong}}
To treat a parenthesized part as a disambiguation term, use {{para|dab|yes}}
* Caia (plant) → {{#invoke:TaxonItalics|main|Caia (plant)|dab=yes}}
* (also linked) Caia (plant) → {{#invoke:TaxonItalics|main|Caia (plant)|linked=yes|dab=yes}}

For even more examples, see the [[Module talk:TaxonItalics/testcases|testcases]].

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

}}</includeonly>