Module:Science redirect: Difference between revisions

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

This module is designed to serve as a back end for {{R from alternative scientific name}}, {{R to scientific name}}, {{R from scientific name}}, {{R to monotypic taxon}} and {{R from monotypic taxon}}.

The template parameters and recognized categories are set in Module:Science redirect/conf.

Usage

{{#invoke:Science redirect|R|template name excluding 'R'}}

For example, for {{R to scientific name}}, you would use {{#invoke:Science redirect|R|to scientific name}} to produce:

• To scientific name of an organism: This is a redirect from a vernacular ("common") name to the scientific name of an organism (or group of organisms).

Adding or modifying supported templates

The template parameters and recognized categories are set in Module:Science redirect/conf. Instructions on how to add data are in the comments of that file.

For debugging, add parameter |debug=true, e.g. {{#invoke:Science redirect|R|to scientific name|debug=true}} produces:

{{Redirect template
| name = To scientific name of an organism
| from = a vernacular ("common") name
| main category = Redirects to scientific names
| printworthy = yes
| to = the scientific name of an organism (or group of organisms)
}}

Tracking categories

Science redirects ( 13 )

• Category:Redirects from alternative scientific names ( 8,742 )
• Category:Redirects to scientific names ( 19,964 )
• Category:Redirects from scientific names ( 977 )
• Category:Redirects to monotypic taxa ( 3,589 )
• Category:Redirects from monotypic taxa ( 3,265 )

Invalid parameters

• Category:Redirects from alternative scientific names using unknown values for parameter 1 ( 21 )
• Category:Redirects to scientific names using unknown values for parameter 1 ( 12 )
• Category:Redirects from scientific names using unknown values for parameter 1 ( 4 )
• Category:Redirects to monotypic taxa using unknown values for parameter 1 ( 15 )
• Category:Redirects from monotypic taxa using unknown values for parameter 1 ( 6 )

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

local conf = require( "Module:Science redirect/conf" )

local p = {}

function p.R(frame)
	local template = mw.ustring.gsub(frame.args[1], ' ', '_')
	if conf.templates[template] then
		return p._main(frame, conf.templates[template].name, conf.templates[template].from, conf.templates[template].to, conf.templates[template].category, conf.templates[template].info, conf.templates[template].removeA)
	elseif template then
		return '<span class="error">The template '..template..'is not valid.</span>\n'
	else
		return '<span class="error">No template specified</span>\n'
	end
end

function p._main(frame, name, from, to, category, info, removeA)
	--initialize variables
	local args = frame:getParent().args
	local singleNoun, pluralNoun = '', ''
	local cat = mw.ustring.match(mw.ustring.lower(args[1] or 'none'), '^(.-)s?$')
	local outStr = ''
	
	--Check for known parameter 1
	if conf.cats[cat] then singleNoun, pluralNoun = conf.cats[cat][1], conf.cats[cat][2] else
		singleNoun, pluralNoun = 'an organism'
		outStr = '[[Category:Redirects '..category..' using unknown values for parameter 1]]'
	end
	
	--strip article from singleNoun if removeA is true
	if removeA == true then
		if singleNoun == 'an organism' then singleNoun = '' else singleNoun = (mw.ustring.match(singleNoun, '^an? (.*)$') or singleNoun) end
	end
	
	--support alternative indications for printworthy
	if args[2] == 'unprintworthy' or args['unprintworthy'] == 'true' then args['printworthy'] = 'no' end
	
	--build template arguments
	local main_category = 'Redirects '..category
	if pluralNoun then main_category = main_category..' of '..pluralNoun end
	local outArgs = {
		name = mw.ustring.gsub(name, '$1', singleNoun),
		from = mw.ustring.gsub(mw.ustring.gsub(from, '$1', singleNoun), '$2', (pluralNoun or 'organisms')),
		to = mw.ustring.gsub(mw.ustring.gsub(to, '$1', singleNoun), '$2', (pluralNoun or 'organisms')),
		['main category'] = main_category,
		printworthy = (args['printworthy'] or 'yes'),
		info = info,
	}
	
	--build output string
	if frame.args['debug'] == 'true' then
		outStr = frame:extensionTag{name='nowiki',content=outStr}..'{{Redirect template<br />\n'
		for k,v in pairs( outArgs ) do
			outStr = outStr..'| '..k..' = '..v..'<br />\n'
		end
		outStr = outStr..'}}'
	else
		outStr = outStr..frame:expandTemplate{ title = 'Redirect template', args = outArgs }
	end
	
	return outStr
end

return p