Module:TNT: Difference between revisions

Jump to navigation Jump to search
metawikimedia>Gareth
copy from https://www.mediawiki.org/wiki/Module:TNT
 
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 17 revisions imported
 
(18 intermediate revisions by 10 users not shown)
Line 4: Line 4:
--    wikis without any translation changes. All translation text is stored
--    wikis without any translation changes. All translation text is stored
--    in the global  Data:*.tab  pages on Commons, and used everywhere.
--    in the global  Data:*.tab  pages on Commons, and used everywhere.
--
-- SEE:  https://www.mediawiki.org/wiki/Multilingual_Templates_and_Modules
--
--
-- ATTENTION:
-- ATTENTION:
Line 21: Line 23:
--    | source-table              <!-- uses a translation message with id = "source-table" -->
--    | source-table              <!-- uses a translation message with id = "source-table" -->
--    | param1 }}                <!-- optional parameter -->
--    | param1 }}                <!-- optional parameter -->
--  
--
--  
--
--    The "doc" function will generate the <templatedata> parameter documentation for templates.
--    The "doc" function will generate the <templatedata> parameter documentation for templates.
--    This way all template parameters can be stored and localized in a single Commons dataset.
--    This way all template parameters can be stored and localized in a single Commons dataset.
Line 34: Line 36:
local p = {}
local p = {}
local i18nDataset = 'I18n/Module:TNT.tab'
local i18nDataset = 'I18n/Module:TNT.tab'
-- Forward declaration of the local functions
local sanitizeDataset, loadData, link, formatMessage


function p.msg(frame)
function p.msg(frame)
Line 41: Line 46:
for k, v in pairs(frame.args) do
for k, v in pairs(frame.args) do
if k == 1 then
if k == 1 then
dataset = v
dataset = mw.text.trim(v)
elseif k == 2 then
elseif k == 2 then
id = v
id = mw.text.trim(v)
elseif type(k) == 'number' then
elseif type(k) == 'number' then
table.insert(params, v)
params[k - 2] = mw.text.trim(v)
elseif k == 'lang' and v ~= '_' then
elseif k == 'lang' and v ~= '_' then
lang = v
lang = mw.text.trim(v)
end
end
end
end
Line 53: Line 58:
end
end


-- Converts first parameter to a interwiki-ready link. For example, it converts
-- Identical to p.msg() above, but used from other lua modules
-- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab'
-- 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', 2, key, 'string')
return formatMessage(dataset, key, {...})
end
 
 
-- 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])
end
end


-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
function p.doc(frame)
function link(dataset)
local dataset = 'Templatedata/' .. sanitizeDataset(frame.args[1])
dataset = 'Data:' .. (dataset or '')
return frame:extensionTag('templatedata', p.getTemplateData(dataset)) ..
if mw.site.siteName == 'Wikimedia Commons' then
  formatMessage(i18nDataset, 'edit_doc', {link(dataset)})
return dataset
else
return 'commons:' .. dataset
end
end
end


function p.doc(frame)
function p.getTemplateData(dataset)
dataset = 'Templatedata/' .. normalizeDataset(frame.args[1])
-- 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 80: 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 = row[pos]
    name = val
else
    else
newVal[columnName] = row[pos]
    newVal[columnName] = val
end
    end
end
    end
if name then
    if name then
params[name] = newVal
    params[name] = newVal
table.insert(paramOrder, name)
    table.insert(paramOrder, name)
end
    end
end
    end
 
-- Work around json encoding treating {"1":{...}} as an [{...}]
local templateData = {
params['zzz123']=''
 
local json = mw.text.jsonEncode({
params=params,
params=params,
paramOrder=paramOrder,
paramOrder=paramOrder,
description=data.description
description=data.description
}
})
templateData = mw.text.jsonEncode(templateData)


return frame:extensionTag('templatedata', templateData) .. tntMessage('edit_doc', {link(dataset)})
json = string.gsub(json,'"zzz123":"",?', "")
 
return json
end
end


function formatMessage(dataset, key, params, lang)
-- Local functions
    for _, row in pairs(loadData(dataset, lang).data) do
 
    local id, msg = unpack(row)
sanitizeDataset = function(dataset)
    if id == key then
if not dataset then
    local result = mw.message.newRawMessage(msg, unpack(params))
return nil
    return result:plain()
end
    end
dataset = mw.text.trim(dataset)
    end
if dataset == '' then
if dataset == i18nDataset then
return nil
-- Prevent cyclical calls
elseif string.sub(dataset,-4) ~= '.tab' then
error('Invalid message key "' .. key .. '"')
return dataset .. '.tab'
else
else
error(tntMessage('error_bad_msgkey', {key, link(dataset)}))
return dataset
end
end
end
end


function tntMessage(key, params)
loadData = function(dataset, lang)
return formatMessage(i18nDataset, key, params)
dataset = sanitizeDataset(dataset)
end
if not dataset then
error(formatMessage(i18nDataset, 'error_no_dataset', {}))
end


function normalizeDataset(dataset)
-- Give helpful error to thirdparties who try and copy this module.
if not dataset or dataset == '' then
if not mw.ext or not mw.ext.data or not mw.ext.data.get then
error(tntMessage('error_no_dataset', {}))
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
if string.sub(dataset,-4) ~= '.tab' then
dataset = dataset .. '.tab'
end
return dataset
end


function loadData(dataset, lang)
local data = mw.ext.data.get(dataset, lang)
local data = mw.ext.data.get(dataset, lang)
if data == false then
if data == false then
if dataset == i18nDataset then
if dataset == i18nDataset then
Line 145: Line 168:
error('Missing Commons dataset ' .. i18nDataset)
error('Missing Commons dataset ' .. i18nDataset)
else
else
error(tntMessage('error_bad_dataset', {link(dataset)}))
error(formatMessage(i18nDataset, 'error_bad_dataset', {link(dataset)}))
end
end
end
end
return data
return data
end
-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
link = function(dataset)
return 'c:Data:' .. mw.text.trim(dataset or '')
end
formatMessage = function(dataset, key, params, lang)
for _, row in pairs(loadData(dataset, lang).data) do
local id, msg = unpack(row)
if id == key then
local result = mw.message.newRawMessage(msg, unpack(params or {}))
return result:plain()
end
end
if dataset == i18nDataset then
-- Prevent cyclical calls
error('Invalid message key "' .. key .. '"')
else
error(formatMessage(i18nDataset, 'error_bad_msgkey', {key, link(dataset)}))
end
end
end


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