Module:TNT: Difference between revisions
Content added Content deleted
m (1 revision imported: Import request by SirFell) |
(Wiki update stage 1) |
||
Line 1: | Line 1: | ||
-- |
|||
-- INTRO: (!!! DO NOT RENAME THIS PAGE !!!) |
|||
-- This module allows any template or module to be copy/pasted between |
|||
-- wikis without any translation changes. All translation text is stored |
|||
-- in the global Data:*.tab pages on Commons, and used everywhere. |
|||
-- |
|||
-- SEE: https://www.mediawiki.org/wiki/Multilingual_Templates_and_Modules |
|||
-- |
-- |
||
-- ATTENTION: |
-- ATTENTION: |
||
Line 7: | Line 14: | ||
-- |
-- |
||
-- DESCRIPTION: |
-- DESCRIPTION: |
||
-- This module allows templates to use translations from the shared Datasets on Commons |
|||
-- |
|||
-- The "msg" function uses a Commons dataset to translate a message |
-- The "msg" function uses a Commons dataset to translate a message |
||
-- with a given key (e.g. source-table), plus optional arguments |
-- with a given key (e.g. source-table), plus optional arguments |
||
-- to the wiki markup in the current content language. |
-- to the wiki markup in the current content language. |
||
-- Use lang=xx to set language. |
-- Use lang=xx to set language. Example: |
||
-- |
|||
-- {{#invoke:TNT | msg |
|||
-- | I18n/Template:Graphs.tab <!-- https://commons.wikimedia.org/wiki/Data:I18n/Template:Graphs.tab --> |
|||
-- | source-table <!-- uses a translation message with id = "source-table" --> |
|||
-- | param1 }} <!-- optional parameter --> |
|||
-- |
|||
-- |
-- |
||
-- {{#invoke:TNT | msg | Original/Template:Graphs.tab | source-table | param1 }} |
|||
-- uses https://commons.wikimedia.org/wiki/Data:Original/Template:Graphs.tab |
|||
-- |
|||
-- 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. |
||
-- NOTE: "doc" assumes that all documentation is located in Data:Templatedata/* on Commons. |
-- NOTE: "doc" assumes that all documentation is located in Data:Templatedata/* on Commons. |
||
-- |
-- |
||
-- |
-- {{#invoke:TNT | doc | Graph:Lines }} |
||
-- |
-- uses https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab |
||
-- |
-- if the current page is Template:Graph:Lines/doc |
||
-- |
-- |
||
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 35: | 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 |
||
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 47: | Line 58: | ||
end |
end |
||
-- Identical to p.msg() above, but used from other lua modules |
|||
-- Converts first parameter to a interwiki-ready link. For example, it converts |
|||
-- Parameters: name of dataset, message key, optional arguments |
|||
-- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab' |
|||
-- 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 |
||
function p.doc(frame) |
|||
-- Given a dataset name, convert it to a title with the 'commons:data:' prefix |
|||
local dataset = 'Templatedata/' .. sanitizeDataset(frame.args[1]) |
|||
function link(dataset) |
|||
return frame:extensionTag('templatedata', p.getTemplateData(dataset)) .. |
|||
dataset = 'Data:' .. (dataset or '') |
|||
formatMessage(i18nDataset, 'edit_doc', {link(dataset)}) |
|||
if mw.site.siteName == 'Wikimedia Commons' then |
|||
return dataset |
|||
else |
|||
return 'commons:' .. dataset |
|||
end |
|||
end |
end |
||
function p. |
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 |
for _, field in ipairs(data.schema.fields) do |
||
table.insert(names, field.name) |
table.insert(names, field.name) |
||
end |
end |
||
Line 74: | Line 102: | ||
local params = {} |
local params = {} |
||
local paramOrder = {} |
local paramOrder = {} |
||
for _, row in ipairs(data.data) do |
|||
local newVal = {} |
|||
local name = nil |
|||
for pos, columnName in ipairs(names) do |
|||
if columnName == 'name' then |
|||
name = row[pos] |
|||
if columnName == 'name' then |
|||
else |
|||
name = val |
|||
newVal[columnName] = row[pos] |
|||
else |
|||
end |
|||
newVal[columnName] = val |
|||
end |
|||
if name then |
|||
end |
|||
params[name] = newVal |
|||
if name then |
|||
table.insert(paramOrder, name) |
|||
params[name] = newVal |
|||
end |
|||
table.insert(paramOrder, name) |
|||
end |
|||
end |
|||
-- Work around json encoding treating {"1":{...}} as an [{...}] |
|||
params['zzz123']='' |
|||
local templateData = { |
|||
local json = mw.text.jsonEncode({ |
|||
params=params, |
params=params, |
||
paramOrder=paramOrder, |
paramOrder=paramOrder, |
||
description=data.description |
description=data.description |
||
} |
}) |
||
templateData = mw.text.jsonEncode(templateData) |
|||
json = string.gsub(json,'"zzz123":"",?', "") |
|||
return frame:extensionTag('templatedata', templateData) .. tntMessage('edit_doc', {link(dataset)}) |
|||
return json |
|||
end |
end |
||
-- Local functions |
|||
function formatMessage(dataset, key, params, lang) |
|||
for _, row in pairs(loadData(dataset, lang).data) do |
|||
sanitizeDataset = function(dataset) |
|||
local id, msg = unpack(row) |
|||
if not dataset then |
|||
return nil |
|||
local result = mw.message.newRawMessage(msg, unpack(params)) |
|||
end |
|||
return result:plain() |
|||
dataset = mw.text.trim(dataset) |
|||
end |
|||
if dataset == '' then |
|||
end |
|||
return nil |
|||
if dataset == i18nDataset then |
|||
elseif string.sub(dataset,-4) ~= '.tab' then |
|||
-- Prevent cyclical calls |
|||
return dataset .. '.tab' |
|||
error('Invalid message key "' .. key .. '"') |
|||
else |
else |
||
return dataset |
|||
error(tntMessage('error_bad_msgkey', {key, link(dataset)})) |
|||
end |
end |
||
end |
end |
||
loadData = function(dataset, lang) |
|||
function tntMessage(key, params) |
|||
dataset = sanitizeDataset(dataset) |
|||
return formatMessage(i18nDataset, key, params) |
|||
if not dataset then |
|||
end |
|||
error(formatMessage(i18nDataset, 'error_no_dataset', {})) |
|||
end |
|||
-- Give helpful error to thirdparties who try and copy this module. |
|||
function normalizeDataset(dataset) |
|||
if not |
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; |
|||
error(tntMessage('error_no_dataset', {})) |
|||
Cannot load https://commons.wikimedia.org/wiki/Data:%s. |
|||
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 139: | Line 168: | ||
error('Missing Commons dataset ' .. i18nDataset) |
error('Missing Commons dataset ' .. i18nDataset) |
||
else |
else |
||
error( |
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 |
||