Module:TNT

Documentation[voir] [modifier] [historique] [purger]

Ne pas modifier. Cette page est maintenue par un outil externe. Toutes les modifications doivent être effectuées sur mediawiki.org.

Présentation

Ce module permet une traduction simple du texte des modèles et modules entre les différentes versions linguistiques de Wikipédia dans le cadre du projet de modèles et modules multilingues. Le module TNT (abréviation de Template Namespace Translation, litt. « Traduction de l'espace de nom Modèle ») permet aux modules d'être conçus indépendamment de la langue et de stocker du texte pour chaque langue dans les pages de données tabulaires sur Commons. Lorsqu'un texte n'a pas encore été traduit, l'anglais est utilisé par défaut. Lorsque la table de traduction est mise à jour, les modèles et modules utilisant ces textes sont automatiquement mis à jour (une purge du cache peut être nécessaire) et aucune modification du modèle ou du module n'est nécessaire sur aucun des wikis. Ce processus est très similaire à l'internationalisation de MediaWiki et prend en charge toutes les conventions d'internationalisation standard telles que {{plural:...}}.

Ce module peut être invoqué à partir de modèles en utilisant #invoke et être importé à partir d'autres modules. Pour un exemple simple, voir Data:I18n/Template:Graphs.tab - une table avec deux messages, chaque message ayant un seul paramètre. Par convention, toutes les tables de traduction doivent avoir le préfixe Data:I18n/... pour les séparer des autres types de données.

Utilisation dans un modèle


Code	Utilisation
{{#invoke:TNT \| msg \| I18n/Template:Graphs.tab \| table_source }}	Dans un modèle, ce code appelle la fonction `msg` du module TNT pour obtenir la traduction du texte `table_source` depuis la table de traductions Data:I18n/Template:Graphs.tab.
{{#invoke:TNT \| msg \| I18n/Template:My Template.tab \| id-message \| param1 \| param2 }}	Les éventuels paramètres sont spécifiés après l'id du message.

Traduction des templatedata des modèles

Les paramètres d'un modèle sont généralement stockés sous la forme d'un bloc templatedata JSON à l'intérieur de la sous-page de documentation du modèle. Cela facilite la traduction, mais lorsqu'un nouveau paramètre est ajouté à un modèle global, les pages de documentation doivent être mises à jour dans chaque langue. TNT facilite la traduction en générant automatiquement le bloc templatedata à partir d'une table stockée sur Commons. Placer le code ci-dessous ligne dans une sous-page de documentation utilisera le tableau Data:Templatedata/Graph:Lines.tab pour générer les templatedata dans chaque langue. Même si la communauté locale n'a pas traduit la documentation complète du modèle, elle pourra voir tous les paramètres du modèle, mis à jour de manière centralisée.

{{#invoke:TNT | doc | Graph:Lines }}

Utilisation dans un Module

De même que les modèles, les modules peuvent utiliser le module TNT pour la traduction dans la langue locale (c'est-à-dire en français) des textes affichés :

local TNT = require('Module:TNT')

-- format <idMessage> chaîne de caractères avec deux paramètres utilisant une table de traduction
local texte = TNT.format('I18n/Messages_de_mon_module', 'idMessage', 'param1', 'param2', ...)

-- Même chose, mais en précisant la langue pour la traduction
local texte = TNT.formatInLanguage('en', 'I18n/Messages_de_mon_module', 'idMessage', 'param1', 'param2', ...)

Fonctions exportables

msg(frame) – Pour un frame contenant les paramètres non nommés : dataset (exemple : pour commons:Data:I18n/Template:Graphs.tab, le paramètre dataset vaut I18n/Template:Graphs.tab), id (l'identifiant dans le dataset), et d'éventuels paramètres supplémentaires params au format des paramètres de mw.param, et le paramètre nommé lang (code langue, fr par défaut), et renvoie le wikitexte du message issu du dataset avec cet id dans la langue indiquée, les éventuels paramètres ayant été évalués.

format(dataset, key, ...) – Équivalent de msg(frame) sans le paramètre lang pour un usage depuis un module.

formatInLanguage(lang, dataset, key, ...) – Équivalent de msg(frame) avec le paramètre lang pour un usage depuis un module.

doc(frame) – Prend en argument un frame contenant pour unique paramètre non nommé dataset (au même format que pour msg(frame)) et renvoie le wikitexte des TemplateData associées à ce dataset.

getTemplateData(dataset) – Prend en argument une chaîne de caractères dataset et renvoie le JSON (encodé comme chaîne de caractères) des TemplateData associées à ce dataset.

Modules externes et autres éléments dont ce module a besoin pour fonctionner

mw.text.trim – Enlève les espaces au début et à la fin d'une chaine de caractères ;
mw.text.jsonEncode – Transforme la valeur en chaine JSON ;
frame:extensionTag() – Permet l'utilisation d'équivalents lua aux fonctions d'analyse syntaxique, appelées via le mot magique {{#tag:}} ;
mw.ext.data.get – Permet la récupération des données tabulaires sur commons ;
mw.message.newRawMessage – Crée un nouvel objet message en utilisant le texte donné en paramètre ;
mw.message:plain() – Convertit un objet message en wikitexte ;

libraryUtil – Bibliothèque de fonctions pour retourner une erreur lorsque le type d'un objet n'est pas celui attendu.

Projet Scribunto

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.

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

local p = {}
local i18nDataset = 'I18n/Module:TNT.tab'

function p.msg(frame)
	local dataset, id
	local params = {}
	local lang = nil
	for k, v in pairs(frame.args) do
		if k == 1 then
			dataset = mw.text.trim(v)
		elseif k == 2 then
			id = mw.text.trim(v)
		elseif type(k) == 'number' then
			table.insert(params, v)
		elseif k == 'lang' and v ~= '_' then
			lang = mw.text.trim(v)
		end
	end
	return formatMessage(dataset, id, params, lang)
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:' .. mw.text.trim(dataset or '')
	if mw.site.siteName == 'Wikimedia Commons' then
		return dataset
	else
		return 'commons:' .. dataset
	end
end

function p.doc(frame)
	return frame:extensionTag(
		'templatedata',
		p.getTemplateData(frame.args[1])
	) .. tntMessage('edit_doc', {link(dataset)})
end

function p.getTemplateData(page)
	dataset = 'Templatedata/' .. normalizeDataset(page)
	-- TODO: add '_' parameter once lua starts reindexing properly for "all" languages
	local data = loadData(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
    
    -- Work around json encoding treating {"1":{...}} as an [{...}]
    params['zzz123']=''
	
	local json = mw.text.jsonEncode({
		params=params,
		paramOrder=paramOrder,
		description=data.description
	})

	json = string.gsub(json,'"zzz123":"",?', "")

	return json
end

function formatMessage(dataset, key, params, lang)
    for _, row in pairs(loadData(dataset, lang).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, lang)
	local data = mw.ext.data.get(dataset, lang)
	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