Module:TNT/doc
This is the documentation page for Module:TNT
| TNT | This module uses Module:TNT for localisation: |
Module Quality
| Module:TNT | File:OOjs UI icon check-constructive.svg All tests passed.
| ||||||||||||||||||||||||||||||||
| Module:TNT/sandbox | Lua error in mw.lua at line 177: invalid frame ID. |
- See test cases
- Diff sandbox code
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 fall back 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
}}
|
Use lang=xx to set language. For example, use with {{int:lang}} to use the interface language.
|
{{#invoke:TNT | msg
| I18n/Template:My Template.tab
| message-with-two-params
| param1
| param2
| lang={{int:lang}}
}}
|
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:
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', ...)
