Page MenuHomePhabricator

Review/update copy and internationalisation (i18n) of all check/suggestion types
Closed, ResolvedPublic

Description

This task involves the work of reviewing all of the Edit Check/Suggestion UI copy before the Suggestion Mode is offered as a Beta Feature at all Wikipedias (T415320) so that we can be relatively confident the strings we will be asking volunteers to translate are stable.

Note: the same copy is applied between checks and suggestions, so any changes made need to be applicable to either mode.

List of types to review

https://en.wikipedia.beta.wmcloud.org/wiki/Special:EditChecks

Problem

At the moment, checks and suggestions do not follow a consistent copy structure across different types. As a result, when multiple checks/suggestions appear on the same page, they are harder to scan, compare, and understand as a set.

image (18).png (682×2 px, 197 KB)

Proposed solution

The goal is to use lighter, benefit-focused language that reinforces the optional nature of suggestions.

  • Title: Action-oriented ([Verb] + [object], e.g. “Add a citation”)
  • Description: Problem + Benefit (Help readers…)
  • Link (optional): if needed, an external link will always appear within the description text to be informative. We will avoid using "Learn more" generic links.
  • Buttons:
    • Primary: using the same verb as in the title (e.g. "Add citation")
    • Secondary: always Dismiss, to differentiate from Checks and reinforce they are optional improvements (we will revisit this decision in T416430)
  • Success message: Unified message for all suggestions to "Thank you for helping to make this section easier for people to read."
NOTE: See specific copy defined for suggestions following this new structure in T415849.

Decision(s) to be made

  • 1. Do we want to use the same copy for checks and suggestions? If yes, we will need to apply the new copy in both check + suggestions card
    • As discussed, we will use this new format and copy for suggestions that are just suggestions, while the checks that become suggestions will inherit the copy from the check.
  • 2. Where will we place links within copy? E.g. within Learn more links that appear after the card copy? Within the context of the card copy itself?
    • We will avoid "Learn more" links since it's too generic, and we will include the link within the suggestion's description instead to be more informative.
  • 3. What technical implementation will we us to enable links to be configured/defined independently of the messages/copy they are likely to be embedded within?
    • Approach #1
      • Can we embed the link directly on the other message? desc="something about [{{int:desc-link}} this policy]"
    • Approach #2
      • .
    • Approach #3
      • .
  • 4. How might we adapt the currently-named ExternalLinksEditCheck.js to account for the complexity/ambiguity @Quiddity highlighted here and copied in T414987#11581537.

Proposed copy

Suggestion nameTitleDescriptionButton 1Button 2 (to decide in T416430)Global LinkEnwiki Link override[future?] Desired Wikidata link (but must NOT use the fallback language system)Done
addReferenceAdd a citationHelp readers understand where this information is coming from by adding a citation.Add citationSkip- [no link, because we're using the check-mode copy for now]https://en.wikipedia.org/wiki/Help:Introduction_to_referencing_with_VisualEditor/1https://www.wikidata.org/wiki/Q24238629 (VE Guide) OR https://www.wikidata.org/wiki/Q79951 (Verifiability)
disambiguationLink to a more specific pageThis link points to a disambiguation page. Help readers find the right topic by linking to a more specific page.Update linkSkipmw:Special:MyLanguage/Help:Suggestion Mode#Disambiguation linkshttps://en.wikipedia.org/wiki/Help:Disambiguationhttps://www.wikidata.org/wiki/Q22981376
duplicateLinkRemove duplicated linkThis link appears more than once in this section. Help readers navigate the article more easily by removing repeated links.Remove linkSkipmw:Special:MyLanguage/Help:Suggestion Mode#Duplicate linkshttps://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Linking#Repeated_linkshttps://www.wikidata.org/wiki/Q14767226
externalLinkRemove external linkThis link points to an external website. Help readers stay focused on the content by either removing this link, moving it to an “External links” section, or by converting it into a citation if appropriate.Remove linkSkip1. mw:Special:MyLanguage/Help:Suggestion Mode#External links 2. mw:Special:MyLanguage/Help:Suggestion Mode#External links1. https://en.wikipedia.org/wiki/Wikipedia:External_links 2. https://en.wikipedia.org/wiki/Help:Introduction_to_referencing_with_VisualEditor/11. https://www.wikidata.org/wiki/Q4657623 2. https://www.wikidata.org/wiki/Q24238629 (VE guide) OR https://www.wikidata.org/wiki/Q79951 (Verifiability)
headingLevelsAdjust heading levelThis heading level may not follow the correct sequential structure. Help readers navigate the content more easily by using the correct heading level.Adjust headingSkipmw:Special:MyLanguage/Help:Suggestion Mode#Heading levelshttps://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Accessibility#Headingshttps://www.wikidata.org/wiki/Q5525713
imageCaptionAdd image captionThis image does not have a description. Help readers understand why the image is relevant by adding a short caption.Add captionSkipmw:Special:MyLanguage/Help:Suggestion Mode#Image caption missinghttps://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Captionshttps://www.wikidata.org/wiki/Q27919587
yearLinkFix year linkThis link points to a different year than the one shown in the text. Help make the article more accurate by updating the displayed year and linked year to match.Fix link (to be solved in T416587)Skip---
convertReferenceConvert referenceThis reference is missing details. Help readers understand where the information is coming from by converting this into a formatted reference. After converting it, check the accuracy of the details that the tool has added, and remove anything that is wrong or confusing.ConvertSkipmw:Special:MyLanguage/Help:Suggestion Mode#Convert reference [if feasible, as we're re-using the Citoid copy here]https://en.wikipedia.org/wiki/Help:Introduction_to_referencing_with_VisualEditor/2https://www.wikidata.org/wiki/Q23891554

Acceptance criteria

StepDescriptionResponsibleTaskNotesDone
1.Ahead of initial en.wiki Beta Feature release, decide what (if any) copy changes need to be implemented@bmartinezcalvoT415849See current copy here: https://en.wikipedia.beta.wmcloud.org/wiki/Special:EditChecks
2.Define structure that all Suggestions will adhere to@bmartinezcalvoT414987
3.Before sending Suggestion card copy off for translation ahead of wider Beta Feature release (T415320), refine copy we defined in "1."@bmartinezcalvoT414987Assume this copy will remain in place for the foreseeable future. Share with @Dyolf77_WMF, @IZapico-WMF , @Geugeor-WMF for review. As part of this step, we will need to decide how we will technically make it possible for links to be included within Suggestion Cards. See discussion in Slack.
4.Implement copy refinements we converge on in "3."Editing EngineeringT414987

Related Objects

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Do we want to use the same copies con checks and suggestions? If yes, we will need to apply the new copies in both check + suggestions card

Just to note, it’s less work to apply to both, because there’s no internal distinction between check and suggestion cards like that. We’d have to go in and make a bunch of changes to be able to have different copy between modes, in fact.

bmartinezcalvo renamed this task from Experimental edit checks need internationalisation (i18n) to Suggestions: Review/update copies and internationalisation (i18n) of all suggestions types.Jan 26 2026, 4:23 PM
bmartinezcalvo updated the task description. (Show Details)
DLynch renamed this task from Suggestions: Review/update copies and internationalisation (i18n) of all suggestions types to Review/update copies and internationalisation (i18n) of all check/suggestion types.Jan 26 2026, 4:44 PM
DLynch updated the task description. (Show Details)
Esanders renamed this task from Review/update copies and internationalisation (i18n) of all check/suggestion types to Review/update copy and internationalisation (i18n) of all check/suggestion types.Jan 26 2026, 6:09 PM
ppelberg updated the task description. (Show Details)

After exploring how we could unify Suggestions (and Checks in some way), I'm proposing the following.

Note that this task is just to update the Suggestions copies, but due that some suggestions are checks from previous edit sessions, it worths reviewing all them at the same time for consistency.


Copy structure

I'm proposing the following copy structure for Checks and Suggestions so they feel part of the same system but with tone differences that clearly communicate the urgency of Checks versus the optional nature of Suggestions. The differences between both are mainly in the Description and the Decline button.

Checks:

More action-oriented and directive, since they signal urgent issues that should be addressed.

  • Title: Action-oriented ([Verb] + [object] e.g. “Add a citation”)
  • Description: Problem + Action to solve problem
  • Link (optional): if needed, we will link to an external page with more information about the Check being described. This link will always appear as a "Learn more" after the description, in order to unify all cards and also to be able to separate the description from the link.
  • Question before buttons (optional): Use this question just when there is some more risk in the check (e.g. Paste check)
  • Buttons:
    • Primary: using the same verb as in the title
    • Secondary: always Decline, except when needed to respond the button's question (e.g. Paste Check)
  • Success message: Specific for each check reinforcing the action completed
Suggestions:

Lighter, benefit-focused language to reinforce they’re optional.

  • Title: same as in Checks (we could evaluate using a question mark for all Suggestions to reinforce they are optional, but this could probably be more difficult to translate)
  • Description: Problem + Benefit (Help readers…)
  • Link (optional): as in Checks, it will always appear if needed after the description in the card, unified as a "Learn more" link.
  • Buttons:
    • Primary: same as Check, using the same verb as in the title
    • Secondary: always Skip, to differentiate from Checks and reinforce they are optional improvements
  • Success message: Unified message for all suggestions

New copies proposed

I've created this proposal for the copies updates for both Checks and Suggestions (to compare them) using this new structure.

image.png (662×1 px, 114 KB)
image.png (682×3 px, 246 KB)
Checks: action oriented copiesSuggestions: explaining benefits and reinforcing optional nature

Title: Action-oriented ([Verb] + [object] e.g. “Add a citation”)

I think this can lead to overly generic labels, for example "Disambiguation link" has become "Update link". As checks display collapsed initially I think it is helpful to know what the check is about from just the title, but "Update link" doesn't tell us much. Also there will be other link-based checks (e.g. Year link/label mismatch) that will have a similar action of "Update link".

Description: Problem + Action to solve problem
Description: Problem + Benefit (Help readers…)

This + the images seem to be proposing different copy between suggestion-mode and regular mode, which I thought we had ruled out?

Secondary: always Decline, except when needed to respond the button's question (e.g. Paste Check)
Secondary: always Skip, to differentiate from Checks and reinforce they are optional improvements

I'd rather keep the same label between the modes. The distinction between those words is subtle enough that I don't think it's worth adding complexity.

Success message: Unified message for all suggestions

Again, it seems simpler to not override existing messages if they're present. (And, again, we'd need to go through and actually make a unified system of how that's handled to have a place to do so.)

I also noticed that you removed the footer from the Tone check in only the suggestions mock. Is that an intentional change?

Per offline discussion, let's use T415849 to define what (if any) copy changes to the current hard-coded English versions we think need to be implemented before the en.wiki beta feature release. This is "Step 1." in the Acceptance criteria.

And let's use this ticket (T414987) for Acceptance Criteria "Steps 2 - 4."

Title: Action-oriented ([Verb] + [object] e.g. “Add a citation”)

I think this can lead to overly generic labels, for example "Disambiguation link" has become "Update link". As checks display collapsed initially I think it is helpful to know what the check is about from just the title, but "Update link" doesn't tell us much. Also there will be other link-based checks (e.g. Year link/label mismatch) that will have a similar action of "Update link".

I agree "Update link" sounds too generic. But we could use the action oriented format to be more specific: Update generic link or other copy we decide is more accurate for this suggestion.

El T414987#11563859, @DLynch escribió:

Description: Problem + Action to solve problem
Description: Problem + Benefit (Help readers…)

This + the images seem to be proposing different copy between suggestion-mode and regular mode, which I thought we had ruled out?

Secondary: always Decline, except when needed to respond the button's question (e.g. Paste Check)
Secondary: always Skip, to differentiate from Checks and reinforce they are optional improvements

I'd rather keep the same label between the modes. The distinction between those words is subtle enough that I don't think it's worth adding complexity.

Success message: Unified message for all suggestions

Again, it seems simpler to not override existing messages if they're present. (And, again, we'd need to go through and actually make a unified system of how that's handled to have a place to do so.)

There are open conversations about if we should use the same or different copies in Checks and Suggestions. This is something we need to evaluate and decide.

I also noticed that you removed the footer from the Tone check in only the suggestions mock. Is that an intentional change?

Ah no, this was an error sorry, it was not the intention to remove it.

I've included the new structure proposed for suggestions copies in this task's description. Based on conversations with @ppelberg we agreed that, if a link is needed in the card, it should be linked within the description for clarity, since “Learn more” is too generic and doesn’t clearly indicate what it links to.

image.png (448×1 px, 203 KB)

I've shared the specific copies proposed following this structure in T415849: Define Edit Suggestion card copy for en.wiki Beta Feature release.

RE ExternalLinksEditCheck.js via @Quiddity.

This Suggestion is one of the more complex ones. 
E.g. in https://commons.wikimedia.org/wiki/File:Suggestion_Mode_example_-_external_link.png -- that external link in the caption is going to https://www.ukssdc.ac.uk/wdcc1/msise90.html -- An experienced editor might either:
* Convert it into a reference
* Convert it into a redlink
* Convert it into a direct link to the existing article on the newer calculator, https://en.wikipedia.org/wiki/NRLMSISE-00 
* Delete it

In other instances of External links within the body, it might be appropriate to move the link to the bottom of the article into the ==External links== section. (but usually not)

I've reviewed the copies and they are ready for final review. @ppelberg and @Quiddity to review them

@bmartinezcalvo: I've reviewed the proposed copy and added some suggestions to the doc.

Next up
@Quiddity to review the copy and suggestions I've proposed and once done, ask Habib, Isa, and Georges to review and translate.

Image Caption
This image does not have a description. [...]

I feel I should point out that captions aren't descriptions. It'd be more accurate to call the "alt text" field a description:

CleanShot 2026-03-02 at 20.11.35@2x.png (742×972 px, 60 KB)

Change #1230949 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Create message strings for experimental checks

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

Change #1247434 had a related patch set uploaded (by Medelius; author: Esanders):

[mediawiki/extensions/VisualEditor@wmf/1.46.0-wmf.18] Create message strings for experimental checks

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

This link appears more than once in this section. Help readers navigate the article more easily by removing repeated links.

If I'm not too late on this, it's occurring to me that we might want to remove "the article" here. Removing duplicate links is mainly about helping readers navigate between articles rather than navigate within the article they are reading. So taking this out would both be more accurate and more concise.

Change #1247434 abandoned by Medelius:

[mediawiki/extensions/VisualEditor@wmf/1.46.0-wmf.18] Create message strings for experimental checks

Reason:

Messages are already showing up on translatewiki

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

Change #1247631 had a related patch set uploaded (by Medelius; author: Medelius):

[mediawiki/extensions/VisualEditor@master] DuplicateLink EditCheck: update copy

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

@Sdkb , I agree with that.

I finished updating the copies yesterday, but I've added a new patch for this.

Change #1247631 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] DuplicateLink EditCheck: update copy

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

Review complete: Content here matches the content in https://en.wikipedia.beta.wmcloud.org/wiki/Special:EditChecks except for the known issues regarding

  1. T416430: Suggestions: Define the meaning and label for the Dismiss/Skip button
  2. T419461: Add Special:MyLanguage/ to links for Suggestion Mode tasks
  3. Plus the recommendation above at T414987#11666366 about changing This image does not have a description. [...] to This image does not have a caption. [...] which seems sensible to me, but needs a decision.

Image Caption
This image does not have a description. [...]

I feel I should point out that captions aren't descriptions. It'd be more accurate to call the "alt text" field a description:

CleanShot 2026-03-02 at 20.11.35@2x.png (742×972 px, 60 KB)

Good spot, @DLynch and +1: T419487