Module:TNT/doc - Revision history

Matt at 21:48, 9 April 2025

2025-04-09T21:48:05Z

← Older revision		Revision as of 17:48, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	~~{{High-use}}~~
	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 <nowiki>{{PLURAL\|...}}</nowiki> and other parameters.		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 <nowiki>{{PLURAL\|...}}</nowiki> and other parameters.

Matt at 13:57, 8 April 2025

2025-04-08T13:57:29Z

← Older revision		Revision as of 09:57, 8 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{High-use}}		{{High-use}}
	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 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 <nowiki>{{PLURAL\|...}}</nowiki> and 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 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.

	=== Using from Templates ===		=== Using from Templates ===
Line 11:		Line 11:
	! style="width: 40%" \| Wiki Markup		! style="width: 40%" \| Wiki Markup
	\|-		\|-
	\|In a template, this command translates '''source_table''' message using Commons' ~~[[commons:Data:I18n/Template:Graphs.tab\|~~Data:I18n/Template:Graphs.tab]] translation table.		\|In a template, this command translates '''source_table''' message using Commons' Data:I18n/Template:Graphs.tab translation table.
	\|<pre>		\|<pre>
	{{#invoke:TNT \| msg		{{#invoke:TNT \| msg
Line 31:		Line 31:

	=== Translating Template Parameters ===		=== Translating Template Parameters ===
	Template parameters are usually stored as a ~~[[mw:wikipedia:JSON\|~~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 ~~[[Commons:Data:Templatedata/Graph:Lines.tab\|~~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.<pre>		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.<pre>
	{{#invoke:TNT \| doc \| Graph:Lines }}		{{#invoke:TNT \| doc \| Graph:Lines }}
	</pre>		</pre>
Line 48:		Line 48:

	=== Using TNTTools ===		=== Using TNTTools ===
	[[Module:TNTTools]] has:		Module:TNTTools has:
	* Question functions: with boolean or numerical indexed return. To be called from other modules or from templates. With:		* Question functions: with boolean or numerical indexed return. To be called from other modules or from templates. With:
	** Case sensitive option.		** Case sensitive option.
Line 56:		Line 56:

	== See also==		== See also==
	* [[JSON]], a language-independent data format.		* JSON, a language-independent data format.

	<includeonly>		<includeonly>
	[[Category:Modules using tabular data]]		[[Category:Modules using tabular data]]
	</includeonly>		</includeonly>

Matt at 21:00, 5 March 2025

2025-03-05T21:00:24Z

← Older revision		Revision as of 17:00, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{High-use}}		{{High-use}}
	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 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]].

Matt: Protected "Module:TNT/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T19:40:36Z

Protected "Module:TNT/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:40, 5 March 2025
(No difference)

Matt: Created page with "{{High-use}} 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 th..."

2025-03-04T20:19:10Z

Created page with "{{High-use}} 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 th..."

New page

{{High-use}}
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.

=== Using from Templates ===
{| class="wikitable" style="width: 85%;"
|+
! style="width: 60%" | Description
! style="width: 40%" | Wiki Markup
|-
|In a template, this command translates '''source_table''' message using Commons' [[commons:Data:I18n/Template:Graphs.tab|Data:I18n/Template:Graphs.tab]] translation table.
|<pre>
{{#invoke:TNT | msg
| I18n/Template:Graphs.tab
| source_table
}}
</pre>
|-
|If your message contains parameters, you can specify them after the message ID.
|<pre>
{{#invoke:TNT | msg
| I18n/Template:My Template.tab
| message-with-two-params
| param1
| param2
}}
</pre>
|}

=== Translating Template Parameters ===
Template parameters are usually stored as a [[mw:wikipedia:JSON|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 [[Commons:Data:Templatedata/Graph:Lines.tab|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.<pre>
{{#invoke:TNT | doc | Graph:Lines }}
</pre>

=== 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>

=== Using TNTTools ===
[[Module:TNTTools]] has:
* Question functions: with boolean or numerical indexed return. To be called from other modules or from templates. With:
** Case sensitive option.
** Possibility of more than one translated text value (where each value is separated by "|").
* To put aside write, adding "I18n/" as a prefix and ".tab" extension as a suffix for the table names.
* Several examples.

== See also==
* [[JSON]], a language-independent data format.

<includeonly>
[[Category:Modules using tabular data]]
</includeonly>