Module:TNT : Différence entre versions
Ligne 1 : | Ligne 1 : | ||
− | |||
− | |||
− | |||
− | |||
− | |||
-- | -- | ||
-- ATTENTION: | -- ATTENTION: | ||
Ligne 12 : | Ligne 7 : | ||
-- | -- | ||
-- 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. | ||
− | |||
-- | -- | ||
− | -- | + | -- {{#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 | {{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 = ' | + | 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 | ||
Ligne 46 : | Ligne 38 : | ||
elseif type(k) == 'number' then | elseif type(k) == 'number' then | ||
table.insert(params, v) | table.insert(params, v) | ||
− | |||
− | |||
end | end | ||
end | end | ||
− | return formatMessage(dataset, id, params | + | return formatMessage(dataset, id, params) |
end | end | ||
Ligne 70 : | Ligne 60 : | ||
function p.doc(frame) | function p.doc(frame) | ||
− | dataset = | + | dataset = normalizeDataset(frame.args[1]) |
− | + | local data = loadData('templatedata/' .. dataset) | |
− | local data = loadData(dataset) | ||
local names = {} | local names = {} | ||
for _, field in pairs(data.schema.fields) do | for _, field in pairs(data.schema.fields) do | ||
Ligne 105 : | Ligne 94 : | ||
templateData = mw.text.jsonEncode(templateData) | templateData = mw.text.jsonEncode(templateData) | ||
− | return frame:extensionTag('templatedata', templateData | + | return frame:extensionTag('templatedata', templateData) |
end | end | ||
− | function formatMessage(dataset, key, params | + | function formatMessage(dataset, key, params) |
− | for _, row in pairs(loadData(dataset | + | for _, row in pairs(loadData(dataset).data) do |
local id, msg = unpack(row) | local id, msg = unpack(row) | ||
if id == key then | if id == key then | ||
Ligne 138 : | Ligne 127 : | ||
end | end | ||
− | function loadData(dataset | + | function loadData(dataset) |
− | local data = mw.ext.data.get(dataset | + | local data = mw.ext.data.get(dataset) |
if data == false then | if data == false then | ||
if dataset == i18nDataset then | if dataset == i18nDataset then |
Version du 12 octobre 2019 à 02:23
warning Erreur Lua : bad argument #1 to "get" (not a valid title) | Erreur Lua : bad argument #1 to "get" (not a valid title) Erreur Lua : bad argument #1 to "get" (not a valid title) |
Sommaire
Module Quality
Module:TNT | success: 0, error: 6, skipped: 0 |
Module:TNT/sandbox | success: 1, error: 5, skipped: 0 |
Documentation
This module allows templates and modules to be easily translated as part of the multilingual templates and modules project. Instead of storing English text in a module or a template, TNT module allows modules to be designed language-neutral, and store multilingual text in the tabular data pages on Commons. This way your module or template will use those translated strings (messages), or if the message has not yet been translated, will fallback to English. When someone updates the translation table, your page will automatically update (might take some time, or you can purge it), but no change in the template or module is needed on any of the wikis. This process is very similar to MediaWiki's localisation, and supports all standard localization conventions such as {{PLURAL|...}} and other parameters.
This module can be used from templates using #invoke, and from other modules. For a simple example, see Data:I18n/Template:Graphs.tab - a table with two messages, each message having a single parameter. By convention, all translation tables should have '''Data:I18n/...''' prefix to separate them from other types of data.
Using from Templates
Description | Wiki Markup |
---|---|
In a template, this command translates source_table message using Commons' Data:I18n/Template:Graphs.tab translation table. | {{#invoke:TNT | msg | I18n/Template:Graphs.tab | source_table }} |
If your message contains parameters, you can specify them after the message ID. | {{#invoke:TNT | msg | I18n/Template:My Template.tab | message-with-two-params | param1 | param2 }} |
Translating Template Parameters
Template parameters are usually stored as a JSON templatedata block inside the template's /doc subpage. This makes it convenient to translate, but when a new parameter is added to a global template, all /doc pages need to be updated in every language. TNT helps with this by automatically generating the templatedata block from a table stored on Commons. Placing this line into every /doc sub-page will use Data:Templatedata/Graph:Lines.tab table to generate all the needed templatedata information in every language. Even if the local community has not translated the full template documentation, they will be able to see all template parameters, centrally updated.{{#invoke:TNT | doc | Graph:Lines }}
Using from Modules
Just like templates, modules should also use this module for localization: <syntaxhighlight lang="lua"> local TNT = require('Module:TNT')
-- format <messageId> string with two parameters using a translation table. local text = TNT.format('I18n/My_module_messages', 'messageId', 'param1', 'param2', ...)
-- Same, but translate to a specific language. local text = TNT.formatInLanguage('fr', 'I18n/My_module_messages', 'messageId', 'param1', 'param2', ...) </syntaxhighlight>
-- -- 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. -- -- {{#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 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