Module:TNT

Lua

Code Discussion Edit History Links Link count Subpages:Documentation Tests Results Sandbox Live code All modules

Warning: Do not edit. This page is maintained by an automated tool. All edits should be done at mediawiki.org. (translate this warning)

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

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 JSONtemplatedata 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:

localTNT=require('Module:TNT')-- format <messageId> string with two parameters using a translation table.localtext=TNT.format('I18n/My_module_messages','messageId','param1','param2',...)-- Same, but translate to a specific language.localtext=TNT.formatInLanguage('fr','I18n/My_module_messages','messageId','param1','param2',...)

Code

---- 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:-- 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:-- 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.-- 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 -->------ 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 | Graph:Lines }}-- uses https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab-- if the current page is Template:Graph:Lines/doc--localp={}locali18nDataset='I18n/Module:TNT.tab'-- Forward declaration of the local functionslocalsanitizeDataset,loadData,link,formatMessagefunctionp.msg(frame)localdataset,idlocalparams={}locallang=nilfork,vinpairs(frame.args)doifk==1thendataset=mw.text.trim(v)elseifk==2thenid=mw.text.trim(v)elseiftype(k)=='number'thenparams[k-2]=mw.text.trim(v)elseifk=='lang'andv~='_'thenlang=mw.text.trim(v)endendreturnformatMessage(dataset,id,params,lang)end-- Identical to p.msg() above, but used from other lua modules-- Parameters: name of dataset, message key, optional arguments-- Example with 2 params: format('I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')functionp.format(dataset,key,...)localcheckType=require('libraryUtil').checkTypecheckType('format',1,dataset,'string')checkType('format',2,key,'string')returnformatMessage(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')functionp.formatInLanguage(lang,dataset,key,...)localcheckType=require('libraryUtil').checkTypecheckType('formatInLanguage',1,lang,'string')checkType('formatInLanguage',2,dataset,'string')checkType('formatInLanguage',3,key,'string')returnformatMessage(dataset,key,{...},lang)end-- Obsolete function that adds a 'c:' prefix to the first param.-- "Sandbox/Sample.tab" -> 'c:Data:Sandbox/Sample.tab'functionp.link(frame)returnlink(frame.args[1])endfunctionp.doc(frame)localdataset='Templatedata/'..sanitizeDataset(frame.args[1])returnframe:extensionTag('templatedata',p.getTemplateData(dataset))..formatMessage(i18nDataset,'edit_doc',{link(dataset)})endfunctionp.getTemplateData(dataset)-- TODO: add '_' parameter once lua starts reindexing properly for "all" languageslocaldata=loadData(dataset)localnames={}for_,fieldinipairs(data.schema.fields)dotable.insert(names,field.name)endlocalnumOnly=truelocalparams={}localparamOrder={}for_,rowinipairs(data.data)dolocalnewVal={}localname=nilforpos,columnNameinipairs(names)doifcolumnName=='name'thenname=row[pos]elsenewVal[columnName]=row[pos]endendifnamethenif((type(name)~="number")and((type(name)~="string")ornotstring.match(name,"^%d+$")))thennumOnly=falseendparams[name]=newValtable.insert(paramOrder,name)endend-- Work around json encoding treating {"1":{...}} as an [{...}]ifnumOnlythenparams['zzz123']=''endlocaljson=mw.text.jsonEncode({params=params,paramOrder=paramOrder,description=data.description,})ifnumOnlythenjson=string.gsub(json,'"zzz123":"",?',"")endreturnjsonend-- Local functionssanitizeDataset=function(dataset)ifnotdatasetthenreturnnilenddataset=mw.text.trim(dataset)ifdataset==''thenreturnnilelseifstring.sub(dataset,-4)~='.tab'thenreturndataset..'.tab'elsereturndatasetendendloadData=function(dataset,lang)dataset=sanitizeDataset(dataset)ifnotdatasetthenerror(formatMessage(i18nDataset,'error_no_dataset',{}))end-- Give helpful error to thirdparties who try and copy this module.ifnotmw.extornotmw.ext.dataornotmw.ext.data.getthenerror(string.format([['''Missing JsonConfig extension, or not properly configured;Cannot load https://commons.wikimedia.org/wiki/Data:%s.See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates''']],dataset))endlocaldata=mw.ext.data.get(dataset,lang)ifdata==falsethenifdataset==i18nDatasetthen-- Prevent cyclical callserror('Missing Commons dataset '..i18nDataset)elseerror(formatMessage(i18nDataset,'error_bad_dataset',{link(dataset)}))endendreturndataend-- Given a dataset name, convert it to a title with the 'commons:data:' prefixlink=function(dataset)return'c:Data:'..mw.text.trim(datasetor'')endformatMessage=function(dataset,key,params,lang)for_,rowinpairs(loadData(dataset,lang).data)dolocalid,msg=unpack(row)ifid==keythenlocalresult=mw.message.newRawMessage(msg,unpack(paramsor{}))returnresult:plain()endendifdataset==i18nDatasetthen-- Prevent cyclical callserror('Invalid message key "'..key..'"')elseerror(formatMessage(i18nDataset,'error_bad_msgkey',{key,link(dataset)}))endendreturnp