Difference between revisions of "Module:TaxonItalics/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Peter coxhead
(→‎Examples: another linked example)
m (26 revisions imported)
 
(10 intermediate revisions by one other user not shown)
Line 10: Line 10:
 
     | 8 = [[Module talk:TaxonItalics/testcases|testcases]]
 
     | 8 = [[Module talk:TaxonItalics/testcases|testcases]]
 
}}
 
}}
 +
{{high risk|439099}}
 
==Purpose==
 
==Purpose==
The purpose of this module is to correctly italicize scientific names at the rank of genus or below. 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 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.
  
The module does <em>not</em> deal with virus names, which have quite different structures and italicization rules.
+
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==
 
==Usage==
 
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME}}</nowiki> – italicizes a taxon name
 
* <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|abbreviated=yes}}</nowiki> – italicizes a taxon name, abbreviating all but the last part to the first letter
  
* <nowiki>{{#invoke:TaxonItalics|main|TAXON_NAME|linked=yes}}</nowiki> – italicizes a taxon name, wikilinking the italicized output to the unchanged input
+
It can also be used via {{tl|Taxon italics}}.
  
 
==Examples==
 
==Examples==
Connecting terms:
+
===Just italicized===
 +
;Connecting terms
 
* Pinus subg. Pinus → {{#invoke:TaxonItalics|main|Pinus subg. Pinus}}
 
* Pinus subg. Pinus → {{#invoke:TaxonItalics|main|Pinus subg. Pinus}}
 
* P. subgenus Pinus → {{#invoke:TaxonItalics|main|P. subgenus Pinus}}
 
* P. subgenus Pinus → {{#invoke:TaxonItalics|main|P. subgenus Pinus}}
Line 33: Line 35:
 
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.
 
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:
+
;Hybrid symbols
 
* Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla}}
 
* Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla}}
 
* ×Beallara → {{#invoke:TaxonItalics|main|×Beallara}}
 
* ×Beallara → {{#invoke:TaxonItalics|main|×Beallara}}
Line 39: Line 41:
 
* <nowiki>{{hybrid}}</nowiki>Beallara → {{#invoke:TaxonItalics|main|{{hybrid}}Beallara}}
 
* <nowiki>{{hybrid}}</nowiki>Beallara → {{#invoke:TaxonItalics|main|{{hybrid}}Beallara}}
  
Linked via {{para|linked|yes}}:
+
===Linked===
 
+
Using  {{para|linked|yes}}
 
* Populus sect. Aigeiros → {{#invoke:TaxonItalics|main|Populus sect. Aigeiros|linked=yes}}
 
* Populus sect. Aigeiros → {{#invoke:TaxonItalics|main|Populus sect. Aigeiros|linked=yes}}
 
* Elaeagnus × submacrophylla → {{#invoke:TaxonItalics|main|Elaeagnus × submacrophylla|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 mitschurinii → {{#invoke:TaxonItalics|main|× Sorbaronia mitschurinii|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}}
  
 
For even more examples, see the [[Module talk:TaxonItalics/testcases|testcases]].
 
For even more examples, see the [[Module talk:TaxonItalics/testcases|testcases]].

Latest revision as of 16:54, 29 September 2020

Module:TaxonItalics Template:Toolbar

Purpose

The module supports the correct italicization of scientific names. Botanical (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 {{Is italic taxon}} for this purpose.

Usage

  • {{#invoke:TaxonItalics|main|TAXON_NAME}} – italicizes a taxon name
  • {{#invoke:TaxonItalics|main|TAXON_NAME|linked=yes}} – italicizes a taxon name, wikilinking the italicized output to the unchanged input
  • {{#invoke:TaxonItalics|main|TAXON_NAME|abbreviated=yes}} – italicizes a taxon name, abbreviating all but the last part to the first letter

It can also be used via {{Taxon italics}}.

Examples

Just italicized

Connecting terms
  • Pinus subg. Pinus → Pinus subg. Pinus
  • P. subgenus Pinus → P. subg. Pinus
  • P. subsect. Pinaster → P. subsect. Pinaster
  • Acer tataricum subsp. ginnala → Acer tataricum subsp. ginnala
  • Aster ericoides var. ericoides → Aster ericoides var. ericoides
  • A. ericoides varietas ericoides → A. ericoides var. ericoides
  • A. e. subvar. ericoides → 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 → Elaeagnus × submacrophylla
  • ×Beallara → ×Beallara
  • &times; Beallara → × Beallara
  • {{hybrid}}Beallara → ×Beallara

Linked

Using |linked=yes

Abbreviated

Using |abbreviated=yes

  • Populus sect. Aigeiros → P. sect. Aigeiros
  • Acer tataricum subsp. ginnala → A. t. subsp. ginnala
  • [also linked] × Sorbaronia mitschurinii → × S. mitschurinii
  • [also linked] Elaeagnus × submacrophylla → E. × submacrophylla
  • Elaeagnus ×submacrophylla → E. ×submacrophylla
  • Elaeagnus {{hybrid}} submacrophylla → E. × submacrophylla

For even more examples, see the testcases.