Translatable modules: Add ability to provide a description for MessageBundle message groups
Closed, ResolvedPublic4 Estimated Story Points
Actions

Assigned To

Authored By

	abi_
	Jun 28 2022, 12:17 PM

Description

Currently the description of a MessageBundle is hard coded and fetched from JSON localisation files. Instead add a string in @metadata that allows dynamic description for MessageBundle message group.

{
  "@metadata": {
    "sourceLanguage": "fr",
    "priorityLanguages": [],
    "allowOnlyPriorityLanguages": true,
    "description": "Description for the component"
  },
  "T1": "This is the string to be translated in the text unit T1",
  "T2": "This is the string to be translated in the text unit T2"
}

We would have to see how to make this text translatable into different languages

Details

	Subject	Repo	Branch	Lines +/-
	Add feature to save description for a message bundle	mediawiki/extensions/Translate	master	+80 -14

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Open	Feature	None	T66475 Make crosswiki bits and pieces truly global (tracking)
Open		None	T176787 Automatic infobox implementation
Open		None	T121470 Central Global Repository for Templates, Lua modules, and Gadgets
Stalled		None	T52329 We need a common repository for Scribunto modules and templates
Open		None	T238341 Structured localization framework for Templates, Lua modules, and Gadgets
Open		None	T238417 Structured localization framework for Scribunto modules
Resolved		abi_	T311503 Translatable modules: Add ability to provide a description for MessageBundle message groups

Event Timeline

abi_ created this task.Jun 28 2022, 12:17 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 28 2022, 12:18 PM

Pginer-WMF added a project: Language-Team (Language-2022-July-September).Jul 4 2022, 12:26 PM

Pginer-WMF moved this task from Quarter Backlog to Priority: Localization infrastructure on the Language-Team (Language-2022-July-September) board.

abi_ triaged this task as Medium priority.Jul 5 2022, 4:50 AM

abi_ set the point value for this task to 4.

I looked at how this functionality has been implemented for WikiPageMessageGroup. We allow for adding a custom group description by using: MediaWiki:Tp-custom-<group ID>.

For MessageBundleMessageGroup the description will be initially provided via the @metadata section in the JSON under a description key.

I see two approaches to handling the description:

Store the description in the translate_metadata table, and load and display the description from there. The drawback with this approach is that the description cannot be translated or edited without editing the message bundle.
Store the description in a separate page like we do for the WikiPageMessageGroup. This page could be marked for translations, and users can edit it without editing the message bundle. The challenge would be keeping this description in the separate page, and description property in the JSON in sync.

I'll go ahead with the second approach for now without worrying about the syncing.

Change 811878 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):

[mediawiki/extensions/Translate@master] Add feature to save description for a message bundle

https://gerrit.wikimedia.org/r/811878

gerritbot added a project: Patch-For-Review.Jul 7 2022, 8:00 AM

abi_ claimed this task.Jul 7 2022, 11:57 AM

abi_ moved this task from Priority: Localization infrastructure to In Review on the Language-Team (Language-2022-July-September) board.

Pginer-WMF moved this task from Backlog to group management on the MediaWiki-extensions-Translate board.Jul 18 2022, 11:29 AM

abi_ moved this task from In Review to In Progress on the Language-Team (Language-2022-July-September) board.Jul 28 2022, 7:58 AM

Change 811878 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] Add feature to save description for a message bundle

https://gerrit.wikimedia.org/r/811878

Maintenance_bot removed a project: Patch-For-Review.Aug 2 2022, 12:32 PM

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.25; 2022-08-15).Aug 2 2022, 1:00 PM

abi_ moved this task from In Progress to In Review on the Language-Team (Language-2022-July-September) board.Aug 2 2022, 1:51 PM

abi_ moved this task from In Review to Check after deployment on the Language-Team (Language-2022-July-September) board.

Tested on Translatewiki:

Nikerabbit moved this task from group management to message bundles on the MediaWiki-extensions-Translate board.Sep 5 2022, 2:20 PM

	F35388116: image.png
	Aug 3 2022, 12:06 PM

Translatable modules: Add ability to provide a description for MessageBundle message groupsClosed, ResolvedPublic4 Estimated Story PointsActions

Description

Details

Related ObjectsSearch...

Event Timeline

Translatable modules: Add ability to provide a description for MessageBundle message groups
Closed, ResolvedPublic4 Estimated Story Points
Actions

Related Objects
Search...