Module:TNT/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
No edit summary |
(Fix links, minor reformat) |
||
| Line 1: | Line 1: | ||
== Documentation == |
== Documentation == |
||
This module allows templates and modules to be easily translated as part of the [[Multilingual Templates and Modules|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 [[Help:Tabular_Data|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 <nowiki>{{PLURAL|...}}</nowiki> and [[Localisation#Message_parameters|other parameters]]. |
This module allows templates and modules to be easily translated as part of the [[mw:Multilingual Templates and Modules|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 [[mw:Help:Tabular_Data|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 [[mw:localisation|localisation]], and supports all standard localization conventions such as <nowiki>{{PLURAL|...}}</nowiki> and [[mw:Localisation#Message_parameters|other parameters]]. |
||
This module can be used from templates using #invoke, and from other modules. For a simple example, see [[commons:Data:I18n/Template:Graphs.tab|Data:I18n/Template:Graphs.tab]] - a table with two messages, each message having a single parameter. By convention, all translation tables should have <nowiki>'''</nowiki>Data:I18n/...<nowiki>'''</nowiki> prefix to separate them from other types of data. |
This module can be used from templates using #invoke, and from other modules. For a simple example, see [[commons:Data:I18n/Template:Graphs.tab|Data:I18n/Template:Graphs.tab]] - a table with two messages, each message having a single parameter. By convention, all translation tables should have <nowiki>'''</nowiki>Data:I18n/...<nowiki>'''</nowiki> prefix to separate them from other types of data. |
||
| Line 35: | Line 35: | ||
=== Using from Modules === |
=== Using from Modules === |
||
Just like templates, modules should also use |
Just like templates, modules should also use this module for localization: |
||
<syntaxhighlight lang="lua"> |
<syntaxhighlight lang="lua"> |
||
local TNT = require('Module:TNT') |
local TNT = require('Module:TNT') |
||
