Difference between revisions of "Module:TNT"

From FIThydrowiki
Jump to navigation Jump to search
what>Yurik
what>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
 
--
 
--
--    For example, this will use dataset https://commons.wikimedia.org/wiki/Data:Original/Template:Graphs.tab
+
--    The "msg" function uses a Commons dataset to translate a message
--    to translate message with ID "source-table" with an argument $1 = "tablename" to a wikitext
+
--    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 | tablename}}
+
--      {{#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)
    for _, row in pairs(mw.ext.data.get(dataset).data) do
 
    local id2, msg = unpack(row)
 
    if id2 == id then
 
    local result = mw.message.newRawMessage(msg, unpack(params))
 
    return result:plain()
 
    end
 
    end
 
 
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)
local dataset = 'Data:' .. (frame.args[1] or '')
+
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)
local dataset, id
+
dataset = normalizeDataset(frame.args[1])
dataset = 'TemplateParams/Graph:Lines.tab'
+
local data = loadData('templatedata/' .. dataset)
for k, v in pairs( frame.args ) do
 
if k == 1 then
 
dataset = v
 
end
 
end
 
 
 
local data = mw.ext.data.get(dataset)
 
 
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

Revision as of 02:32, 13 January 2017

-- -- ATTENTION: -- Please do NOT rename this module - it has to be identical on all wikis. -- This code is maintained at https://www.mediawiki.org/wiki/Module:TNT -- Please do not modify it anywhere else, as it may get copied and override your changes. -- Suggestions can be made at https://www.mediawiki.org/wiki/Module_talk:TNT -- -- 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 -- with a given key (e.g. source-table), plus optional arguments -- to the wiki markup in the current content language. -- -- Lua error at line 130: attempt to index field 'data' (a nil value). -- 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. -- -- Lua error at line 130: attempt to index field 'data' (a nil value). -- uses https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab -- if the current page is Template:Graph:Lines/doc --

local p = {} local i18nDataset = 'i18n/Module:TNT.tab'

function p.msg(frame) local dataset, id local params = {} for k, v in pairs(frame.args) do if k == 1 then dataset = v elseif k == 2 then id = v elseif type(k) == 'number' then table.insert(params, v) end end return formatMessage(dataset, id, params) end

-- Converts first parameter to a interwiki-ready link. For example, it converts -- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab' 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 return dataset else return 'commons:' .. dataset end end

function p.doc(frame) dataset = normalizeDataset(frame.args[1]) local data = loadData('templatedata/' .. dataset) local names = {} for _, field in pairs(data.schema.fields) do table.insert(names, field.name) end

local params = {} local paramOrder = {}

   for _, row in pairs(data.data) do
   	local newVal = {}
   	local name = nil
   	for pos, val in pairs(row) do
   		local columnName = names[pos]
   		if columnName == 'name' then
   			name = val
   		else
   			newVal[columnName] = val
   		end
   	end
   	if name then
   		params[name] = newVal
   		table.insert(paramOrder, name)
   	end
   end

local templateData = { params=params, paramOrder=paramOrder, description=data.description }

templateData = mw.text.jsonEncode(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

return p