Module:TaxonItalics

Module documentation[view] [edit] [history] [purge]

Module:TaxonItalics (talk ·  · hist · links · doc · subpages · sandbox · testcases)

Purpose

The module is primarily intended for use by the automated taxobox system. It 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
• {{#invoke:TaxonItalics|main|TAXON_NAME|dab=yes}} – 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 {{Taxon italics}}.

Examples

Just italicized

Connecting terms

• Pinus subg. Pinus →
• P. subgenus Pinus →
• P. subsect. Pinaster →
• Acer tataricum subsp. ginnala →
• Aster ericoides var. ericoides →
• A. ericoides varietas 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 →
• ×Beallara →
• × Beallara →
• {{hybrid}}Beallara →

Linked

Using |linked=yes

• Populus sect. Aigeiros →
• Elaeagnus × submacrophylla →

Abbreviated

Using |abbreviated=yes

• Populus sect. Aigeiros →
• Acer tataricum subsp. ginnala →
• [also linked] × Sorbaronia fallax →
• [also linked] Elaeagnus × submacrophylla →
• Elaeagnus ×submacrophylla →
• Elaeagnus {{hybrid}} submacrophylla →

Disambiguation terms

By default, a parenthesized part of a taxon name is assumed to be a subgenus name, and is italicized:

• Varanus (Hapturosaurus) →
• Caia (plant) → – wrong

To treat a parenthesized part as a disambiguation term, use |dab=yes

• Caia (plant) →
• (also linked) Caia (plant) →

For even more examples, see the testcases.

The above documentation is transcluded from Module:TaxonItalics/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

local p = {}

local cTerms3 = {
	subspecies = "subsp.",
	["subsp."] = "subsp.",
	subsp = "subsp.",
	["ssp."] = "subsp.",
	ssp = "subsp.",
	varietas = "var.",
	["var."] = "var.",
	var = "var.",
	subvarietas = "subvar.",
	["subvar."] = "subvar.",
	subvar = "subvar.",
	forma = "f.",
	["f."] = "f.",
	f = "f.",
	subforma = "subf.",
	["subf."] = "subf.",
	subf = "subf."
	}
local cTerms2 = {
	subgenus = "subg.",
	["subg."] = "subg.",
	subg = "subg.",
	section = "sect.",
	["sect."] = "sect.",
	["cf."] = "cf.",
	cf = "cf.",
	["c.f."] = "cf."
	}

--[[=========================================================================
Italicize a taxon name appropriately.
* If the name is already italicized, do nothing.
* If the name is not made up of four words or the name is made up of four
  words and the third word is not a botanical connecting term, add italic
  markup to the outside of the name.
* If the name is made up of four words and the third word is a botanical
  connecting term, add italic markup so as not to italicize the connecting
  term.
=============================================================================]]
function p.italicizeTaxonName(frame)
	local name = frame.args[1] or ''
	-- replace any use of the HTML italic tags by Wikimedia markup
	name = string.gsub(string.gsub(name, "<i>", "''"), "</i>", "''")
	local result = name
	local italMarker = "''"
	if name ~= '' then
		if string.sub(name, 1, 2) == "''" then
			-- do nothing if the name already has italic markers at the start
		else
			local words = mw.text.split(name, " ", true)
			if #words == 4 then
				if string.find(name, "''", 1, true) then
					-- add outside italic markup to four word names already containing internal italic markup
					result = italMarker .. name .. italMarker
				else
					-- test for the third word of a four word name being a connecting term
					if cTerms3[words[3]] then
						-- de-italicize the connecting term by adding internal italic markup
						result = italMarker .. words[1] .. " " .. words[2] .. italMarker .. " " .. cTerms3[words[3]] .. " " .. italMarker .. words[4] .. italMarker
					else
						-- third word is not a connecting term, so add outside italic markup
						result = italMarker .. name .. italMarker
					end
				end
			elseif #words == 3 then
				if string.find(name, "''", 1, true) then
					-- add outside italic markup to three word names already containing internal italic markup
					result = italMarker .. name .. italMarker
				else
					-- test for the second word of a three word name being a connecting term
					if cTerms2[words[2]] then
						-- de-italicize the connecting term by adding internal italic markup
						result = italMarker .. words[1] .. " " .. cTerms2[words[2]] .. " " .. italMarker .. words[43] .. italMarker
					else
						-- second word is not a connecting term, so add outside italic markup
						result = italMarker .. name .. italMarker
					end
				end
			else
				-- add outside italic markup to names not made up of four words
				result = italMarker .. name .. italMarker
			end
		end
	end
	return result
end

return p