Page MenuHomePhabricator

Unify the copy of "Citation needed" and "Add a citation" suggestion cards
Open, Needs TriagePublic

Assigned To
Authored By
ppelberg
Jul 7 2026, 5:34 AM
Referenced Files
F92807197: image.png
Jul 10 2026, 3:22 PM
F92748065: image.png
Jul 10 2026, 8:10 AM
F92259778: image.png
Jul 7 2026, 12:04 PM
F92240452: image.png
Jul 7 2026, 9:55 AM
F91575719: image.png
Jul 7 2026, 9:51 AM
F91575709: image.png
Jul 7 2026, 9:51 AM

Description

T430966 will deploy the community-driven "Citation needed" suggestion as a default-on suggestion.

In doing so, we will make the title of the suggestion card "Citation needed." In doing so, there is now a discrepancy between AddReferenceEditCheck.js and CitationNeededEditCheck.js.

This task involves the work of reconciling them.

image.png (310×183 px, 13 KB)

image.png (310×161 px, 12 KB)

Requirements

Both AddReferenceEditCheck.js + CitationNeededEditCheck.js suggestion cards ought to read as follows:

image.png (714×488 px, 109 KB)

  • Title: Add a citation
  • Description: Help readers understand where this information is coming from by adding a citation. Please also verify the article text aligns with the source you add.
  • Buttons: Add citation Dismiss
    • Note: links will be added in a soon-to-be-filed follow-on task.
  • Footer text (CitationNeededEditCheck.js ONLY): Reported by an editor.

Event Timeline

In my opinion, "Add reference" is better at least because it uses a verb and therefore functions as a "personal direction" towards the user.

Esanders updated the task description. (Show Details)

Note that the CN check reuses the messages from the existing CN popup:

image.png (848×236 px, 48 KB)

We should defeinitly consider the buttons in addReference:

image.png (310×183 px, 13 KB)

Icons are not used in any other checks anymore and "No" doesn't really make sense when there is no prompt (other checks use "Dismiss")

I agree on unifying both addReference and CN copies. In fact, I think they should be the same suggestion, since both of them serve the same purpose. The only difference is that Citation needed indicates the issue was flagged by an editor, while Add reference does not. If that distinction is important, we could just show it as a supporting text in the card, similar to how Tone Check indicates that a suggestion was identified by the BERT model.

image.png (1,460×488 px, 207 KB)

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

[mediawiki/extensions/VisualEditor@master] CitationNeededEditCheck: Match copy to addReference

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

@Esanders the unified cards look good. Just an observation about the copy. The copy Indicated by an editor feels too generic. What about one of the following alternatives?

  • "Flagged by another editor"
  • "Reported by another editor"

Also, should we include the date it was flagged?

ppelberg renamed this task from Reconcile the titles of "Citation needed" and "Add a citation" suggestions to Unify the copy of "Citation needed" and "Add a citation" suggestion cards.Jul 9 2026, 6:28 PM
ppelberg updated the task description. (Show Details)

@Esanders the unified cards look good. Just an observation about the copy. The copy Indicated by an editor feels too generic. What about one of the following alternatives?

  • "Flagged by another editor"
  • "Reported by another editor"

Also, should we include the date it was flagged?

Yes but it will require some refactoring so we should file a separate task.

Note: MONTH YEAR will only be included if it's been defined. In the future, it would be cool if we could automatically extract and present this context from the edit/diff that added the template.

Actually, in ruwiki such a thing was done a few months ago -- a bot added placement dates to all "problem templates", even those added ton of time ago. So maybe it's simpler to just run such a bot on major wikis (and disallow such templates without using subst).

bmartinezcalvo moved this task from Incoming to Done on the Design board.

@Esanders the unified cards look good. Just an observation about the copy. The copy Indicated by an editor feels too generic. What about one of the following alternatives?

  • "Flagged by another editor"
  • "Reported by another editor"

Also, should we include the date it was flagged?

I think "Reported by an editor" is the simplest language. (Strictly speaking it isn't always 'another' editor, it could be you, but 'an editor' seems just as good)

I think "Reported by an editor" is the simplest language. (Strictly speaking it isn't always 'another' editor, it could be you, but 'an editor' seems just as good)

@Esanders ok, updated copy in the task description using Reported by an editor.

There's also a good idea from Femke at https://www.mediawiki.org/wiki/Talk:VisualEditor/Suggestion_Mode#Prompt_text_for_Add_a_reference -- Copying/Rephrasing slightly:

Often, when an editor finds a source for an uncited paragraph, it does not fully support the text. New editors often do not change the text to align with the citation they found.
Could the prompt that editors get in the Suggestion, include something like this?

  • "Do not forget to update the text based on your new source"

I agree it would be very helpful to add this detail, as we really don't want newcomers to add references that aren't perfectly suitable. Alternative rephrasing ideas:
"[Please/Also] update the text based on the source you use."
"Make sure the article text is aligned with the source you add."

ppelberg added a subscriber: Femkemilene.

There's also a good idea from Femke at https://www.mediawiki.org/wiki/Talk:VisualEditor/Suggestion_Mode#Prompt_text_for_Add_a_reference -- Copying/Rephrasing slightly:

Often, when an editor finds a source for an uncited paragraph, it does not fully support the text. New editors often do not change the text to align with the citation they found.
Could the prompt that editors get in the Suggestion, include something like this?

  • "Do not forget to update the text based on your new source"

I agree it would be very helpful to add this detail, as we really don't want newcomers to add references that aren't perfectly suitable. Alternative rephrasing ideas:
"[Please/Also] update the text based on the source you use."
"Make sure the article text is aligned with the source you add."

Great spot, @Femkemilene and thank you for surfacing this here, @Quiddity.

I've updated the description to include this propsal.

Change #1309163 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] CitationNeededEditCheck: Match copy to addReference

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