Translatable modules/Proposed solutions/nl

 Het project Translatable modules probeert een een nieuw framework te maken voor het vertalen van modules.

Er zijn meerdere voorstellen voor een oplossing voor de opslag in de discussie gebracht.

Een van de hoofddoelen van deze consultatie is het beslissen welke van deze voorstellen wordt geïmplementeerd en aan de module-bouwers wordt aanbevolen.



Beschrijving
Iets als Module:ModuleMsg op Meta gebruiken, maar dan gestandaardiseerd:


 * Zet alle berichten op een voor vertaling gemarkeerde gewone wikitext pagina.
 * Heeft de standaard Lua functies om ze te laden (eerder dan een module als Module:ModuleMsg op elke wiki).

Voordelen

 * Het voor vertaling markeren van pagina's is iets vertrouwds voor vertalingenbeheerders.
 * Het werkt ook voor sjablonen.
 * Elke vertaling is een wiki-pagina. Het is goed voor de credit, geschiedenis, gescheiden verwerking, enz.

Nadelen

 * De markering van een vertaaleenheid is een getal. Door getallen als keys voor de teksten te gebruiken wordt de code onleesbaar. Het is zoals hierboven aangegeven mogelijk om de getallen door teksten te vervangen, maar dat is in de extensie Translate matig gedocumenteerd. De documentatie van deze functie zou dus wat aangepast moeten worden in de documentatie.
 * Het is onduidelijk hoe de parameters ($1, enz.) en andere wiki syntaxis i18n functies (GENDER, PLURAL, enz.) werken. Ze hoeven nu niet compatibel te zijn met wikitext pagina's.
 * Dit kan op een wiki werken voor de module localization, maar hoeft niet te werken als de modules globaal worden.
 * Er is een oplossing nodig om de pagina's op te zoeken die vertaald moeten worden. Op dit moment toont de selectie van de berichtengroepen alle vertaalbare pagina's.
 * In de tijd van globale modules en sjablonen is het onduidelijk hoe het lokaal wordt aangepast op de wiki's.
 * Mogelijk problemen met de performance als elke vertaling per keer wordt geladen en het afhandelen van het terugvallen als de vertaling niet lukt. Er is een Action API, maar geen mooie Lua of Wikitext API voor het laden van vertalingen.

Description
Use something similar to what Module:TNT is doing, but formalized:


 * Plaats alle bronberichten in een JSON-bestand in de Data namespace op Commons in het “banana” formaat, zoals in MediaWiki extensies, met qqq voor documentatie.
 * Deze syntaxis kan ook worden gebruikt voor core en extensie teksten.
 * Voeg aan de extensie Translate toe het laden van de bronberichten en het schrijven van de vertalingen per taal naar JSON-bestanden.
 * Voeg Lua functies toe aan de standaard Scribunto bibliotheek om de berichten te laden.
 * Gebruik een ander JSON-bestand voor het organiseren van de vertaalbare bestand voor het in Translate gebruikersvriendelijker tonen van de selectie van de berichtengroep.

Voordelen

 * Het bestandsformaat is gelijk aan dat bij extensies.
 * Deze pagina's zijn voor modules al globaal benaderbaar.
 * De pagina's zijn in ruwe vorm eenvoudig benaderbaar voor JavaScript gadgets, die het JSON-bestand omzetten in een intern object dat alle verlangde vertalingen bevat. Er kan een API nodig zijn om een enkele taal op te halen of voor het terugvallen, wat het netwerkverkeer verbeterd. JavaScript gadgets hebben het liefst een enkele opdracht om alle vertalingen op te halen die dan in de client cache komen te staan.

Nadelen

 * A new file format support (FFS) will have to be developed and maintained in the Translate extension. We will need a new type of MessageGroup, as well as MessageLoading.
 * In the global modules and templates age, it’s unclear how it will be locally customized on wikis.



Beschrijving
Similar to “JSON .tab file in the Data namespace”, but:


 * Store all the source messages in a JSON file in the Data namespace on Commons in the “banana” format, like in MediaWiki extensions, including qqq for documentation.
 * (Need to decide whether to store all the languages in one JSON structure, or a slot per language.)
 * The JSON file is stored as an MCR slot with the wiki page that stores the module’s code.
 * The same syntax can be used as for core and extension messages.
 * Enhance the Translate extension to load the source messages and write the translations to JSON files by language.
 * Add Lua functions to the standard Scribunto library to load the messages.
 * Use another JSON file to organize the translatable file for convenient display in Translate’s message group selector.

Voordelen

 * Stored elegantly with the module.
 * If the module becomes global, the data becomes global with it.
 * Creating MCR slots may require some privileges, but that’s probably OK because creating new messages files is not for total newbies anyway, while editing is still accessible to most editors.

Nadelen

 * Will require some development to create slot support.
 * A new FFS will have to be developed and maintained in Translate. We will need a new type of MessageGroup, as well as MessageLoading.
 * In the global modules and templates age, it’s unclear how it will be locally customized on wikis.
 * Common disadvantage of MCR slot approach: Permissions and history mixed altogether. Code programming has the same protection level as translations, every translator is permitted to modify the effective code. There is no history of the effective changes in global programming, but drowning among translation edits. If protection and history would be separated, these are individual pages but not MCR.

Beschrijving
Similar to the JSON proposals above, but with the JSON stored inside TemplateData:


 * Store all the source messages as a JSON value in TemplateData associated with a template that uses the module. Other than being part of a larger JSON structure, the format is otherwise the same as “banana” format, like in MediaWiki extensions, including qqq for documentation.
 * The same syntax can be used as for core and extension messages.
 * Enhance the Translate extension to load the source messages and write the translations to JSON files by language.
 * Add Lua functions to the standard Scribunto library to load TemplateData and the messages.
 * Use another JSON file to organize the translatable file for convenient display in Translate’s message group selector.

Voordelen

 * Continuity with existing TemplateData technology.
 * In particular, TemplateData already has some support for internationalization, e.g. template description can be in several languages.
 * Keys can be managed through the TemplateData editor (this will require updates to the editor UI, however).
 * The technology can be later shared with templates.
 * If TemplateData ever moves to MCR, it will move there, too.

Nadelen

 * There is a hard-coded limit of 64 KiB (gzipped) in the TemplateData extension’s code. While this is enough room for something like 700 messages, we have about 400 languages to manage. When using the rate at which MediaWiki core messages are localized, there is room for only 20 messages.
 * Requires adding TemplateData support to Scribunto.
 * A new file format support (FFS) will have to be developed and maintained in Translate.
 * In the global modules and templates age, it’s unclear how it will be locally customized on wikis.



Beschrijving

 * Store the translatable messages in the MediaWiki namespace, like core and extension messages.
 * Create message groups for Translate using a JSON or YAML file stored as a wiki page. This is already supported (WikiMessageGroup) as whitespace separated lists, however, there is no mechanism exposed to define groups inside the wiki itself.

Voordelen

 * Mostly natural for Translate to process (but support for the message group organizer will probably have to be developed).
 * Mostly natural for Scribunto to process—message loading parsing functions already exist.
 * Can be customized on local wikis when modules become global the same way that messages from core and extensions are customized.

Nadelen

 * Double duty of listing messages as well as creating them separately.
 * Creating the messages will require sysop or edit-interface permissions, making comprehensive module development and bug fixing accessible to much fewer people.
 * Lack of packaging. Many distributed development teams will create and maintain packages of module, global template, accompanied by TemplateData, or JavaScript gadget, but should not conflict in naming between packages of similar targets. Should be bundled per package.

Description
Do it similarly to existing solutions in Module:I18n on Commons and Module:Wikidades/i18n on the Catalan Wikipedia, but:


 * Standardize the Lua table format: Decide whether it is one message key pointing to many translations indexed by language, or language codes pointing to many message keys, etc.
 * Add functions to the Scribunto standard library to load these messages.
 * Add support for reading and writing this file format to Translate.

Voordelen

 * Natural for Lua.
 * Continuity with at least some existing solutions.

Nadelen

 * This is actual code, which is error-prone and less safe. (We already used to have messages in PHP arrays, and moved away from it.)
 * It’s natural for Lua, but what if Scribunto acquires support for other programming languages? There are recurring requests to support JavaScript, Python, Rexx, etc.
 * Language codes that have hyphens have to be written with square brackets, which is non-obvious and error-prone.

 = Tabel met voorgestelde oplossingen =



Meer informatie

 * Discussie over Translatable modules.