Модуль:Ref-lang

Документація модуля[перегляд] [редагувати] [історія] [очистити кеш]

Цей модуль впроваджує шаблон Шаблон:Ref-lang. Він може викликатися як з вікітексту, так і з модуля.

Використання

Використання в іншому модулі

Щоб використати цей модуль з іншого модуля Lua, то спершу вам його потрібно завантажити.

local ref_lang = require('Module:Ref-lang')

Щоб створити оформлений текст, то використайте функцію _main. Вона приймає два або п'ять параметрів у формі таблиці:

• |1= — мовний тег IETF або скорочення назви мови. Обов'язковий параметр.
• |2= — назва мови в орудному відмінку для словосполучень типу «ххх мовою». Обов'язковий параметр, якщо |1= є скорочення назви мови та не встановлено параметри 3 або 4.
• |3= — назва мови в орудному відмінку для словосполучень типу «мовою ххх». Обов'язковий параметр, якщо |1= є скорочення назви мови та не встановлено параметри 2 або 4.
• |4= — повне словосполучення, якщо параметри 2 і 3 не пасують. Обов'язковий параметр, якщо |1= є скорочення назви мови та не встановлено параметри 2 або 3.
• |nocat= — вимикає додавання категорії помилки. Корисно для документування шаблону. Необов'язковий параметр.

Приклад виклику функції _main:

local formatted_text = ref_lang._main({'en'})

Використання у вікітексті

У більшості випадків у вікітексті варто використовувати шаблон Шаблон:Ref-info, однак шаблон можна викликати через #invoke. Він приймає як і шаблон один або чотири параметри, про які описано вище. Приклад виклику: {{#invoke:Ref-lang|main|en}}.

local getArgs = require ('Модуль:Arguments').getArgs;
local lang = require ('Модуль:Lang')
local ref_info = require('Модуль:Ref-info')

--[[---------------------< 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 _ E R R O R _ M S G >--------------------------------------------------

assembles an error message from template name, message text, help link, and error category.

]]

local function make_error_msg (error_text, nocat)
	local category = nocat and '' or '[[Категорія:Помилки Ref-lang]]'
	local msg =  '<span class="error">Помилка: {{Ref-lang}}: ' .. error_text .. ' ([[Шаблон:Ref-lang#Помилки|допомога]])<span>'
	return msg .. category
end	

--[[--------------------------< F O R M A T _ T I P >----------------------------------------------------------

Returns formated tip based on gramatical type of the langauge name. If langauge name is adjective in singular 
form, then language name added before «мовою». If langauge name is adjective in plural, then language name added 
before «мовами». If langauge name is noun, then language name added after «мовою».

]]

local function format_tip(noun, adjective, is_plural)
	local tip
	
	if is_set(noun) then														--якщо назва іменник, то
		tip = 'мовою ' .. noun													--формуємо підказку, де «мовою» йде перед назвою мови, назву мови вибираємо залежно від того чи вкзано орудний відмінок для мови
	else																		--якщо назва прикметник, то
		local lang_form = (true == is_plural) and ' мовами' or ' мовою'			--if plural change form from «мовою» to «мовами»
		tip = adjective .. 	lang_form											--формуємо підказку, де «мовою» йде після назви мови та використовуємо назву мови в орудному відмінку
	end
	
	return tip
end	

--[[--------------------------< _ M A I N >-------------------------------------------------------------------

entry point for {{Ref-lang}}

]]

local function _main(args)														
	local abbr
	local tip
	local nocat = args.nocat
	local formated_text
	
	if not is_set (args[1]) then
		return make_error_msg('Пропущений або порожній параметр &#124;1=', nocat)
	end	
	
	if lang._is_ietf_tag(args[1]) then											-- if the first parameter is valid ietf tag then format with the lang module
		local lang_name = lang._name_from_tag({args[1]})						-- get the language name
		abbr = lang._abbr_from_tag({args[1]})									-- get the abbriviation of the language name
		
		 if mw.ustring.find (lang_name, 'ька', 1, true) then					-- if femine adjective and not plural
		 	tip = format_tip(nil, lang_name:gsub('ька', 'ькою'))				-- formats tip like adjective with noun 
		 elseif mw.ustring.find (lang_name, 'ькі', 1, true) then
		 	tip = format_tip(nil, lang_name:gsub('ькі', 'ькими'), true)
		 else 
		 	if mw.ustring.find (lang_name, 'іврит', 1, true) then
		 		lang_name = lang_name:gsub('іврит', 'івритом')					-- if language name is hebrew, then choose genetive declension
		 	end	
		 	tip = format_tip (lang_name)										-- formats tip like noun with noun 
		 end	
	else
		abbr = args[1]
		local adj_lang_name = args[2] or ''
		local noun_lang_name = args[3] or ''
		
--		if not is_set(adj_lang_name) and is_set(noun_lang_name) and is_set(args[4]) then
--			return make_error_msg('Пропущений або порожній один з обов\'язкових параметрів &#124;2=, &#124;3= або &#124;4=', nocat)
--		end	
		
		tip = args[4] or format_tip(noun_lang_name, adj_lang_name)
	end	

	formated_text = ref_info._main({abbr, tip})
	
	return formated_text
end

--[[--------------------------< M A I N >-------------------------------------------------------------------

Module entry point from an {{#invoke:}}

]]

local function main(frame)														-- entry point from an {{#invoke:Lang|main|<ietf tag or abbriviation>|<language name (adjective) in instrumental case>|<language name (noun) in instrumental case>|<tip>|nocat=<nocat>}}
    return _main(getArgs(frame))												-- pass-on the args table, nothing else; getArgs() so we also get parent frame
end

return {
	main = main,
	_main = _main
}