Module:TNT: Difference between revisions

Jump to navigation Jump to search
← Older edit
metawikimedia>DiBabelYurikBot
m Copying 4 changes by Yurik: "no auto I18n/ prefix, breaks some graphs, fixed doc link, Trim parameter whitespaces, docs link" from mw:Module:TNT. See docs.
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 17 revisions imported
 
(15 intermediate revisions by 9 users not shown)
Line 36: Line 36:
local p = {}
local p = {}
local i18nDataset = 'I18n/Module:TNT.tab'
local i18nDataset = 'I18n/Module:TNT.tab'
local checkType = require('libraryUtil').checkType


-- Forward declaration of the local functions
-- Forward declaration of the local functions
local formatMessage, loadData, link
local sanitizeDataset, loadData, link, formatMessage


function p.msg(frame)
function p.msg(frame)
Line 51: Line 50:
id = mw.text.trim(v)
id = mw.text.trim(v)
elseif type(k) == 'number' then
elseif type(k) == 'number' then
table.insert(params, mw.text.trim(v))
params[k - 2] = mw.text.trim(v)
elseif k == 'lang' and v ~= '_' then
elseif k == 'lang' and v ~= '_' then
lang = mw.text.trim(v)
lang = mw.text.trim(v)
Line 60: Line 59:


-- Identical to p.msg() above, but used from other lua modules
-- Identical to p.msg() above, but used from other lua modules
function p.format(dataset, key, params, lang)
-- Parameters:  name of dataset, message key, optional arguments
-- Example with 2 params:  format('I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.format(dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('format', 1, dataset, 'string')
checkType('format', 1, dataset, 'string')
checkType('format', 2, key, 'string')
checkType('format', 2, key, 'string')
checkType('format', 3, params, 'table', true)
return formatMessage(dataset, key, {...})
checkType('format', 4, lang, 'string', true)
return formatMessage(dataset, key, params, lang)
end
end


-- Converts first parameter to a interwiki-ready link. For example, it converts
 
-- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab'
-- Identical to p.msg() above, but used from other lua modules with the language param
-- Parameters:  language code, name of dataset, message key, optional arguments
-- Example with 2 params:  formatInLanguage('es', I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.formatInLanguage(lang, dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('formatInLanguage', 1, lang, 'string')
checkType('formatInLanguage', 2, dataset, 'string')
checkType('formatInLanguage', 3, key, 'string')
return formatMessage(dataset, key, {...}, lang)
end
 
-- Obsolete function that adds a 'c:' prefix to the first param.
-- "Sandbox/Sample.tab" -> 'c:Data:Sandbox/Sample.tab'
function p.link(frame)
function p.link(frame)
return link(frame.args[1])
return link(frame.args[1])
Line 75: Line 87:


function p.doc(frame)
function p.doc(frame)
return frame:extensionTag(
local dataset = 'Templatedata/' .. sanitizeDataset(frame.args[1])
'templatedata',
return frame:extensionTag('templatedata', p.getTemplateData(dataset)) ..
p.getTemplateData(mw.text.trim(frame.args[1]))
  formatMessage(i18nDataset, 'edit_doc', {link(dataset)})
) .. formatMessage(i18nDataset, 'edit_doc', {link(dataset)})
end
end


function p.getTemplateData(page)
function p.getTemplateData(dataset)
dataset = 'Templatedata/' .. mw.text.trim(page)
-- TODO: add '_' parameter once lua starts reindexing properly for "all" languages
-- TODO: add '_' parameter once lua starts reindexing properly for "all" languages
local data = loadData(dataset)
local data = loadData(dataset)
local names = {}
local names = {}
for _, field in pairs(data.schema.fields) do
for _, field in ipairs(data.schema.fields) do
table.insert(names, field.name)
table.insert(names, field.name)
end
end
Line 92: Line 102:
local params = {}
local params = {}
local paramOrder = {}
local paramOrder = {}
for _, row in pairs(data.data) do
for _, row in ipairs(data.data) do
local newVal = {}
local newVal = {}
local name = nil
local name = nil
for pos, val in pairs(row) do
for pos, columnName in ipairs(names) do
local columnName = names[pos]
if columnName == 'name' then
if columnName == 'name' then
name = val
name = row[pos]
else
else
newVal[columnName] = val
newVal[columnName] = row[pos]
end
end
end
end
Line 124: Line 133:


-- Local functions
-- Local functions
sanitizeDataset = function(dataset)
if not dataset then
return nil
end
dataset = mw.text.trim(dataset)
if dataset == '' then
return nil
elseif string.sub(dataset,-4) ~= '.tab' then
return dataset .. '.tab'
else
return dataset
end
end


loadData = function(dataset, lang)
loadData = function(dataset, lang)
if not dataset or dataset == '' then
dataset = sanitizeDataset(dataset)
if not dataset then
error(formatMessage(i18nDataset, 'error_no_dataset', {}))
error(formatMessage(i18nDataset, 'error_no_dataset', {}))
end
end
if string.sub(dataset,-4) ~= '.tab' then
 
dataset = dataset .. '.tab'
-- Give helpful error to thirdparties who try and copy this module.
if not mw.ext or not mw.ext.data or not mw.ext.data.get then
error(string.format([['''Missing JsonConfig extension, or not properly configured;
Cannot load https://commons.wikimedia.org/wiki/Data:%s. Please properly enable the JSONConfig extension at Special:ManageWiki/extensions#mw-prefsection-other
See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates''']], dataset))
end
end


Line 148: Line 176:
-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
link = function(dataset)
link = function(dataset)
dataset = 'Data:' .. mw.text.trim(dataset or '')
return 'c:Data:' .. mw.text.trim(dataset or '')
if mw.site.siteName == 'Wikimedia Commons' then
return dataset
else
return 'commons:' .. dataset
end
end
end


Retrieved from "https://meta.skywiki.org/wiki/Module:TNT"