Module:TNT/doc

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 Modèle:Anglais, Modèle: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.