Difference between revisions of "Module:Lang"

From annadreambrush.com/wiki
Jump to navigation Jump to search
imported>Trappist the monk
(create;)
 
imported>Trappist the monk
Line 1: Line 1:
--[[
+
--[=[
 
This is an experiment to see what is required to consolodate all of the myriad {{lang-xx}} templates
 
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
 
and their subtemplates into a single module with a data table
]]
 
 
require('Module:No globals');
 
local getArgs = require('Module:Arguments').getArgs;
 
 
local p = {};
 
 
 
--[=[-------------------------< L A N G >----------------------------------------------------------------------
 
  
 
{{lang-es}} has parameters:
 
{{lang-es}} has parameters:
Line 36: Line 27:
 
2. {{language with name}} renders [[Spanish language|Spanish]] ({{{links}}} not set) or Spanish ({{{links}}} set) and calls {{lang}}
 
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
 
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 = {};
 +
 +
 +
--[[--------------------------< 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
 +
 +
 +
--[=[-------------------------< L A N G _ X X >----------------------------------------------------------------
 +
 +
 +
 +
{{#invoke:lang|lang_xx|code=es|text={{{1}}}|link={{{links|{{{link}}}}}}|rtl={{{rtl}}}|nocat={{{nocat}}}}}
  
 +
[[Spanish language|Spanish]]&#58; <span lang="es" >''<span style="font-style:normal;">Don Quixote</span>''</span>
 
]=]
 
]=]
  
function p.Lang (frame)
+
function p.lang_xx (frame)
 
local args = getArgs(frame);
 
local args = getArgs(frame);
 +
 +
local out = {};
 +
local language_name = mw.language.fetchLanguageName(args.code, mw.getContentLanguage():getCode()) or 'error: unknown language';
 +
 +
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, '<span lang="'); -- open <span> tag
 +
table.insert (out,  args.code); -- language attribute
 +
if is_set (args.rtl) then
 +
table.insert (out, ' dir="rtl"'); -- for right to left languages
 +
end
 +
table.insert (out, '> '); -- close the opening span tag
 +
if 'no' == args.italic then
 +
table.insert (out, args.text); -- text is not italicized
 +
else
 +
table.insert (out, table.concat ({"''", args.text, "''"})); -- text with italic markup
 +
end
 +
table.insert (out, '</span>'); -- close the span
 +
if is_set (args.rtl) then
 +
table.insert (out, '&lrm;'); -- make sure the browser knows that we're at the end of the rtl
 +
end
 +
 +
return table.concat (out); -- put it all together and done
 
end
 
end
  
 
return p;
 
return p;

Revision as of 15:17, 31 October 2017

Documentation for this module may be created at Module:Lang/doc

--[=[
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 = {};


--[[--------------------------< 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


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



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

[[Spanish language|Spanish]]&#58; <span lang="es" >''<span style="font-style:normal;">Don Quixote</span>''</span>
]=]

function p.lang_xx (frame)
	local args = getArgs(frame);
	
	local out = {};
	local language_name = mw.language.fetchLanguageName(args.code, mw.getContentLanguage():getCode()) or 'error: unknown language';
	
	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, '<span lang="');											-- open <span> tag
	table.insert (out,  args.code);												-- language attribute
	if is_set (args.rtl) then
		table.insert (out, ' dir="rtl"');										-- for right to left languages
	end
	table.insert (out, '> ');													-- close the opening span tag
	if 'no' == args.italic then
		table.insert (out, args.text);											-- text is not italicized
	else
		table.insert (out, table.concat ({"''", args.text, "''"}));				-- text with italic markup
	end
	table.insert (out, '</span>');												-- close the span
	if is_set (args.rtl) then
		table.insert (out, '&lrm;');											-- make sure the browser knows that we're at the end of the rtl
	end
	
	return table.concat (out);													-- put it all together and done
end

return p;