Difference between revisions of "Module:TNT"
no edit summary
>Yurik |
>Yurik |
||
| Line 9: | Line 9: | ||
-- This module allows templates to use translations from the shared Datasets on Commons | -- This module allows templates to use translations from the shared Datasets on Commons | ||
-- | -- | ||
-- | -- The "msg" function uses a Commons dataset to translate a message | ||
-- | -- with a given key (e.g. source-table), plus optional arguments | ||
-- to the wiki markup in the current content language. | |||
-- | -- | ||
-- {{#invoke:TNT | msg | Original/Template:Graphs.tab | source-table | | -- {{#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. | |||
-- 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. | |||
-- | |||
-- {{#invoke:TNT | doc | {{BASEPAGENAME}} }} | |||
-- 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' | |||
function p.msg( frame ) | function p.msg(frame) | ||
local dataset, id | local dataset, id | ||
local params = {} | local params = {} | ||
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 = v | ||
| Line 29: | Line 40: | ||
end | end | ||
end | end | ||
return formatMessage(dataset, id, params) | |||
end | end | ||
-- Converts first parameter to a interwiki-ready link. For example, it converts | -- Converts first parameter to a interwiki-ready link. For example, it converts | ||
-- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab' | -- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab' | ||
function p.link( frame ) | function p.link(frame) | ||
return link(frame.args[1]) | |||
end | |||
-- Given a dataset name, convert it to a title with the 'commons:data:' prefix | |||
function link(dataset) | |||
dataset = 'Data:' .. (dataset or '') | |||
if mw.site.siteName == 'Wikimedia Commons' then | if mw.site.siteName == 'Wikimedia Commons' then | ||
return dataset | return dataset | ||
| Line 50: | Line 59: | ||
end | end | ||
function p.doc( frame ) | function p.doc(frame) | ||
dataset = normalizeDataset(frame.args[1]) | |||
dataset = | local data = loadData('templatedata/' .. dataset) | ||
local data = | |||
local names = {} | local names = {} | ||
for _, field in pairs(data.schema.fields) do | for _, field in pairs(data.schema.fields) do | ||
| Line 93: | Line 95: | ||
return frame:extensionTag('templatedata', templateData) | return frame:extensionTag('templatedata', templateData) | ||
end | |||
function formatMessage(dataset, key, params) | |||
for _, row in pairs(loadData(dataset).data) do | |||
local id, msg = unpack(row) | |||
if id == key then | |||
local result = mw.message.newRawMessage(msg, unpack(params)) | |||
return result:plain() | |||
end | |||
end | |||
if dataset == i18nDataset then | |||
-- Prevent cyclical calls | |||
error('Invalid message key "' .. key .. '"') | |||
else | |||
error(tntMessage('error_bad_msgkey', {key, link(dataset)})) | |||
end | |||
end | |||
function tntMessage(key, params) | |||
return formatMessage(i18nDataset, key, params) | |||
end | |||
function normalizeDataset(dataset) | |||
if not dataset or dataset == '' then | |||
error(tntMessage('error_no_dataset', {})) | |||
end | |||
if string.sub(dataset,-4) ~= '.tab' then | |||
dataset = dataset .. '.tab' | |||
end | |||
return dataset | |||
end | |||
function loadData(dataset) | |||
local data = mw.ext.data.get(dataset) | |||
if data == false then | |||
if dataset == i18nDataset then | |||
-- Prevent cyclical calls | |||
error('Missing Commons dataset ' .. i18nDataset) | |||
else | |||
error(tntMessage('error_bad_dataset', {link(dataset)})) | |||
end | |||
end | |||
return data | |||
end | end | ||
return p | return p | ||