Module:Lang

From Zoophilia Wiki
Revision as of 20:05, 31 October 2017 by meta>Trappist the monk
Jump to navigationJump to search
Language templates
Languages (ISO 639)
Wiktionary links
Other
Data

This module exists primarily to provide correct html markup for non-English language text where that text is used in the English Wikipedia. It has a secondary purpose of providing correct visual rendering for this non-English text. The module was developed to consolidate processing for {{Lang}}, the {{lang-??}} (most), and {{Transl}} templates into a single source and to use a clearly defined data set extracted from international standards. It provides error checking and reporting to ensure that the html rendered is correct for browsers and screen readers.

Other templates that get language name support from this module are:

Data set

The data set is specified in Module:Language/name/data and its included data modules:

The data set also includes supplementary data modules:

Error messages and categorization

Mainspace articles that have errors are placed in appropriate error categories:

Maintenance categories:

See also

MoS on foreign words: 

--[=[
This is an experiment to see what is required to consolodate all of the myriad {{lang-xx}} templates
and their subtemplates into a single module with a data table

{{lang-es}} has parameters:
{{{1}}} text - required
{{{link}}} or {{{links}}} defaults to 'yes'
{{{lit}}} literal translation

{{language with name}} has parameters:
{{{1}}} iso language code - required
{{{2}}} language name in English - superfluous?
{{{3}}} text - required
{{{4}}} or {{{lit}}} literal translation
{{{link}}} or {{{links}}} set to 'no' disables '{{{2}} language' wikilinks
{{{rtl}}} passed through to {{lang}}
{{{nocat}}} passed through to {{lang}}

{{lang}} has parameters:
{{{1}}} iso language code - required
{{{2}}} text - required
{{{rtl}}} if set to any value, set dir="rtl" attribute and inserts &lrm; after the </span> tag
{{{nocat}}} if set to any value, disables categorization

How it works now:
	1. {{lang-es}} receives text as {{{1}}} to which it adds italic markup, sets |links to {{{link}}} or {{{links}}} or yes, sets |lit to {{{lit}}}, and calls {{language with name}}.  {{{rtl}}} ignored for this example
	2. {{language with name}} renders [[Spanish language|Spanish]] ({{{links}}} not set) or Spanish ({{{links}}} set) and calls {{lang}}
	3. {{lang}} wraps the text in the <span lang="es">text</span> and adds categorization
]=]

require('Module:No globals');
local getArgs = require('Module:Arguments').getArgs;

local p = {};


--[[--------------------------< C O D E _ F A L L B A C K >----------------------------------------------------

List of ISO 639-2 and -3 codes that fall back to ISO 639-1 codes supported by MediaWiki

]]

local code_fallback = {
	['aar'] = 'aa',																-- Afar
	['ara'] = 'ar',																-- Arabic
	['asm'] = 'as',																-- Assamese
	['fry'] = 'fy',																-- Western Frisian
	}


--[[--------------------------< C O D E _ 2 _ N A M E >--------------------------------------------------------

list of ISO 639-2 and -3 codes that DO NOT fall back to ISO 639-1 codes

]]

local code_2_name = {
	['aae'] = 'Arbëresh',
	['abq'] = 'Abaza',
	['aec'] = 'Sa\'idi Arabic',
	['aii'] = 'Assyrian Neo-Aramaic',
	['amh'] = 'Amharic',
	['anm'] = 'Anal',
	['apm'] = 'Mescalero-Chiricahua',
	['apw'] = 'Western Apache',
	['arm'] = 'Armenian',
	['ave'] = 'Avestan',
	['bal'] = 'Balochi',
	['bam'] = 'Bambara',
	['bar'] = 'Bavarian',
	['bft'] = 'Balti',
	['bho'] = 'Bhojpuri',
	['bla'] = 'Siksika',
	['brx'] = 'Bodo',
	['bxr'] = 'Buryat',
	['ca-valencia'] = 'Valencian',
	['cdo'] = 'Eastern Min',
	['ceb'] = 'Cebuano',
	['hop'] = 'Hopi',
	}


--[[--------------------------< I S _ S E T >------------------------------------------------------------------

Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string.
This function is global because it is called from both this module and from Date validation

]]

local function is_set( var )
	return not (var == nil or var == '');
end


--[=[-------------------------< M A K E _ W I K I L I N K >----------------------------------------------------

Makes a wikilink; when both link and display text is provided, returns a wikilink in the form [[L|D]]; if only
link is provided, returns a wikilink in the form [[L]]; if neither are provided or link is omitted, returns an
empty string.

]=]

local function make_wikilink (link, display)
	if is_set (link) then
		if is_set (display) then
			return table.concat ({'[[', link, '|', display, ']]'});
		else
			return table.concat ({'[[', link, ']]'});
		end
	else
		return '';
	end
end


--[[--------------------------< M A K E _ T E X T _ S P A N >--------------------------------------------------

]]

local function make_text_span (code, text, rtl, italic, size)
	local span = {};

	table.insert (span, '<span lang="');										-- open <span> tag
	table.insert (span,  code);											-- language attribute
	if is_set (rtl) then
		table.insert (span, ' dir="rtl"');										-- for right to left languages
	end
	if is_set (size) then														-- {{lang}} only
		table.insert (span, table.concat ({'style="font-size:', size, ';"'}))
	end
	table.insert (span, '> ');													-- close the opening span tag
	if 'yes' == italic then
		table.insert (span, table.concat ({"''", text, "''"}));			-- text with italic markup
	else
		table.insert (span, text);											-- DEFAULT: text is not italicized
	end
	table.insert (span, '</span>');												-- close the span
	if is_set (rtl) then
		table.insert (span, '&lrm;');											-- make sure the browser knows that we're at the end of the rtl
	end
	
	return table.concat (span);													-- put it all together and done
end


--[=[-------------------------< L A N G _ X X >----------------------------------------------------------------

{{#invoke:lang|lang_xx|code=es|text={{{1}}}|link={{{links|{{{link}}}}}}|rtl={{{rtl}}}|nocat={{{nocat}}}}}

]=]

function p.lang_xx (frame)
	local args = getArgs(frame);
	
	if not is_set (args.italic) then
		args.italic = 'yes';													-- DEFAULT for {{lang-xx}} templates is to italicize
	end
	
	args.size = nil;															-- size not supported in {{lang-xx}}
	
	local out = {};
	local language_name = mw.language.fetchLanguageName(args.code, mw.getContentLanguage():getCode());
	
	if not is_set (language_name) then
		if code_fallback [args.code] then
			language_name = mw.language.fetchLanguageName(code_fallback [args.code], mw.getContentLanguage():getCode());	-- try again with fallback code or 639-2 or -3 code
			if not is_set (language_name) then
				return 'error: unknown language code: ' ..  args.code;			-- if here then there is an error in the fall back table
			end
		elseif code_2_name [args.code] then										-- try to get name from table of 639-2, -3 names
			language_name = code_2_name [args.code];
		else
			return 'error: unknown language code: ' ..  args.code;				-- if here then language code not supported
		end
	end
	
	if 'no' == args.link then
		table.insert (out, language_name);										-- language name without wikilink
	else
		table.insert (out, make_wikilink (language_name .. ' language', language_name));	-- language name with wikilink
	end
	table.insert (out, ': ');													-- separator

	table.insert (out, make_text_span (args.code, args.text, args.rtl, args.italic, args.size))
	
	if is_set (args.lit) then													-- translation (not supported in {{lang}})
		table.insert (out, ', <small>');
		table.insert (out, make_wikilink ('Literal translation', 'lit.'));
		table.insert (out, "&nbsp;</small>'");
		table.insert (out, args.lit);
		table.insert (out, "'");
	end
	
	return table.concat (out);													-- put it all together and done
end

return p;
Retrieved from "https://zoophilia.wiki/index.php?title=Module:Lang&oldid=67114"