Module:TNT: Difference between revisions

From CAPipedia
en>Yurik
No edit summary
en>Yurik
implement p.doc
Line 48: Line 48:
return 'commons:' .. dataset
return 'commons:' .. dataset
end
end
end
function p.doc( frame )
local dataset, id
dataset = 'TemplateParams/Graph:Lines.tab'
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 = {}
for _, field in pairs(data.schema.fields) do
table.insert(names, field.name)
end
local params = {}
local paramOrder = {}
local index = 1
    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, index)
    index = index + 1
    end
    end
local templateData = {
params=params,
paramOrder=paramOrder,
description=data.description
}
templateData = mw.text.jsonEncode(templateData)
return frame:extensionTag('templatedata', templateData)
end
end


return p
return p

Revision as of 19:12, 11 January 2017

Documentation for this module may be created at Module:TNT/doc

--
-- 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
--
--    For example, this will use dataset https://commons.wikimedia.org/wiki/Data:Original/Template:Graphs.tab
--    to translate message with ID "source-table" with an argument $1 = "tablename" to a wikitext
--
--      {{#invoke:TNT | msg | Original/Template:Graphs.tab | source-table | tablename}}
--   

local p = {}

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

    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

-- Converts first parameter to a interwiki-ready link. For example, it converts
-- "Sandbox/Sample.tab" -> 'commons:Data:Sandbox/Sample.tab'
function p.link( frame )
	local dataset = 'Data:' .. (frame.args[1] or '')
	if mw.site.siteName == 'Wikimedia Commons' then
		return dataset
	else
		return 'commons:' .. dataset
	end
end

function p.doc( frame )
	local dataset, id
	dataset = 'TemplateParams/Graph:Lines.tab'
	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 = {}
	for _, field in pairs(data.schema.fields) do
		table.insert(names, field.name)
	end

	local params = {}
	local paramOrder = {}
	local index = 1
    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, index)
    		index = index + 1
    	end
    end
	
	local templateData = {
		params=params,
		paramOrder=paramOrder,
		description=data.description
	}
	
	templateData = mw.text.jsonEncode(templateData)

	return frame:extensionTag('templatedata', templateData)
end

return p