Page MenuHomePhabricator

Support links in help messages & field descriptions
Closed, ResolvedPublic2 Estimated Story Points

Description

As reported in , some CC1.0 help messages contained links. In CC2.0 there's no support for that since the help text is render on the client with Vue and it requires special treatment with v-i18n-html.

This task also supports the Moderator-Tools-Team work on Automoderator: T365046: Integrate Community Configuration into AutoModerator.

Status quo

figma designeswiki beta
Screen Shot 2024-05-28 at 4.41.25 PM.png (716×1 px, 156 KB)
Screen Shot 2024-05-28 at 4.51.13 PM.png (920×2 px, 177 KB)

Acceptance criteria

  • Add support for links in help panel messages
  • Add support for links in field descriptions (Related: T368160)
  • Help messages containing a link in CC1.0 also contain the same link in CC2.0, list below:
    • Infobox templates in Suggested edits

Open questions

  • Is there any convention to check if a message needs parsing or not? If not, is there any problem on parsing all help messages?

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

I don't see a problem with parsing all help-text messages. It is part of the intended design of the Codex Field component: https://doc.wikimedia.org/codex/latest/components/demos/field.html#with-rich-description-and-help-text

For ControlWrapper this change should be as simple as:

ControlWrapper.vue
-			{{ helpText.text() }}
+			<span v-i18n-html="helpText"></span>

We mainly need to be mindful that there is less syntax available in js: https://www.mediawiki.org/wiki/Manual:Messages_API#Feature_support_in_JavaScript

Michael added a subscriber: KStoller-WMF.

We probably want this improvement to copy either before the pilot release or really soon afterward? Though that would seem to be ultimately Product's call to make @KStoller-WMF

I agree we should add this soon, but I don't think it needs to block our release to pilot wikis.

Since T368160 we also have field descriptions, I would suggest to also allow links there.

KStoller-WMF renamed this task from Support links in help messages to Support links in help messages & field descriptions.Jul 19 2024, 3:38 PM
KStoller-WMF updated the task description. (Show Details)

Since T368160 we also have field descriptions, I would suggest to also allow links there.

Agreed. I updated the description, but let me know if you think this needs to be a separate subtask.

KStoller-WMF raised the priority of this task from Medium to High.Jul 22 2024, 4:09 AM

Moving to higher priority since this is functionality that would help support Automoderator .

KStoller-WMF set the point value for this task to 2.Jul 23 2024, 4:18 PM

Change #1056496 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/CommunityConfiguration@master] Support links in help messages & field descriptions

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

Change #1056497 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/GrowthExperiments@master] Support links in help messages & field descriptions

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

Change #1056496 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] Support links in help messages & field descriptions

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

Change #1056497 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Support links in help messages & field descriptions

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

Etonkovidova subscribed.

Checked in wmf.18. The links are present (and work correctly).

There is a minor discrepancy between the figma design for CommunityConfiguration/GrowthSuggestedEdits and the implementation - two sentences ("Please note that updates to this form will not impact Suggested Edits...") are displayed a next line from the other text and in italic. Since the info in those two sentences clarifies different Suggested Edits features (on mobile apps), probably it make sense to make text to match the figma design, so the clarification will look different from other info text - @KStoller-WMF?

fgma designwmf.18
Screen Shot 2024-08-15 at 4.18.33 PM.png (1×2 px, 758 KB)
Screen Shot 2024-08-15 at 4.12.31 PM.png (916×2 px, 262 KB)

Change #1063088 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/GrowthExperiments@master] i18n(CC): fix i18n formatting on GrowthSuggestedEdits form intro text

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

There is a minor discrepancy between the figma design for CommunityConfiguration/GrowthSuggestedEdits and the implementation - two sentences ("Please note that updates to this form will not impact Suggested Edits...") are displayed a next line from the other text and in italic. Since the info in those two sentences clarifies different Suggested Edits features (on mobile apps), probably it make sense to make text to match the figma design, so the clarification will look different from other info text - @KStoller-WMF?

fgma designwmf.18
Screen Shot 2024-08-15 at 4.18.33 PM.png (1×2 px, 758 KB)
Screen Shot 2024-08-15 at 4.12.31 PM.png (916×2 px, 262 KB)

That's a tiny thing to fix, I just created a a very quick change to adjust it.

Change #1063088 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] i18n(CC): fix i18n formatting on GrowthSuggestedEdits form intro text

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

Change #1063088 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] i18n(CC): fix i18n formatting on GrowthSuggestedEdits form intro text

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

Checked in beta - the fix is in place.thx, @Michael!