Module:TaxonItalics/sandbox

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 → 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
• × Beallara → × Beallara
• {{hybrid}}Beallara → ×Beallara

Linked

Using |linked=yes

• Populus sect. Aigeiros → Populus sect. Aigeiros
• Elaeagnus × submacrophylla → Elaeagnus × submacrophylla

Abbreviated

Using |abbreviated=yes

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

Disambiguation terms

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

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

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

• Caia (plant) → Caia (plant)
• (also linked) Caia (plant) → 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.
Add categories to the /doc subpage. Subpages of this module.

--[[=========================================================================
Italicize a taxon name appropriately by invoking italicizeTaxonName.
The algorithm used is:
* If the name has italic markup at the start or the end, do nothing.
* Else
  * Remove (internal) italic markup.
  * If the name is made up of four words and the third word is a
    botanical connecting term, de-italicize the connecting term and add italic
    markup to the outside of the name.
  * Else if the name is made up of three words and the second word is a
    botanical connecting term or a variant of "cf.", de-italicize the
    connecting term and add italic markup to the outside of the name. 
  * Else just add italic markup to the outside of the name.
=============================================================================]]

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.",
	subsection = "subsect.",
	subsect = "subsect.",
	["subsect."] = "subsect.",
	series = "ser.",
	ser = "ser.",
	["ser."] = "ser.",
	subseries = "subser.",
	subser = "subser.",
	["subser."] = "subser.",
	["cf."] = "cf.",
	cf = "cf.",
	["c.f."] = "cf."
	}

--[[=========================================================================
Italicize a taxon name appropriately.
=============================================================================]]
function p.main(frame)
	local name = frame.args[1] or ''
	local linked = frame.args['linked'] == 'yes'
	return p.italicizeTaxonName(name, linked)
end

function p.italicizeTaxonName(name, linked)
	local italMarker = "''"
	local hybridSymbol = "×"
	-- trim the name and replace any use of the HTML italic tags by Wikimedia markup
	name = string.gsub(mw.text.trim(name), "</?i>", italMarker)
	local result = name
	if name ~= '' then
		if string.sub(name, 1, 2) == "''" or string.sub(name, -2) == "''" then
			-- do nothing if the name already has italic markers at the start or end
		else
			name = string.gsub(name, "''", "") -- first remove internal italics
			local words = mw.text.split(name, " ", true)
			if words[2] == hybridSymbol then
				words[1] = words[1] .. italMarker .. " " .. hybridSymbol
				words[3] = " " .. italMarker .. words[3]
				table.remove(words, 2)
				-- hybridDeitalicized = true
			end
			local deitalicized = false
			if #words == 4 then
				-- 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 = words[1] .. " " .. words[2] .. italMarker .. " " .. cTerms3[words[3]] .. " " .. italMarker .. words[4]
					deitalicized = true
				end
			elseif #words == 3 then
				-- 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 = words[1] .. italMarker .. " " .. cTerms2[words[2]] .. " " .. italMarker .. words[3]
					deitalicized = true
				end
			else
				-- do nothing except un-italicize hybrid symbol
				result = name:gsub(" " .. hybridSymbol .. " ", "''%0''")
			end
			-- add outside markup
			if linked then
				if deitalicized then
					result = "[[" .. name .. "|" .. italMarker .. result .. italMarker .. "]]"
				else
					result = italMarker .. "[[" .. name .. "]]" .. italMarker
				end
			else
				result = italMarker .. result .. italMarker
			end
		end
	end
	return result
end

return p