Page MenuHomePhabricator
Create Task
Maniphest T386452

Clarify ambiguous concepts like "key" and "number" in the Cite codebase
Closed, ResolvedPublic
Actions

Description

There is extremely confusing terminology in the Cite codebase, notably:

  • The term "key" is used for a multitude of entirely different concepts. There are even comments left where "key" is used to describe the ability of naming <ref> with the name="…" attribute. This is also why messages like cite_error_ref_too_many_keys contain the word "key". See T299280#9384546 for the full explanation.
  • What is an "id"?
  • What qualifies as an "index" and what doesn't?
  • What does it mean for a reference to have a "number"? There are several numeric values assigned to each reference.

Details

Related Changes in Gerrit:
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

thiemowmde created this task.Feb 14 2025, 11:28 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 14 2025, 11:28 AM
thiemowmde moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2025-02-05 board.Feb 14 2025, 11:28 AM
gerritbot added a comment.Feb 14 2025, 11:31 AM

Change #1119690 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Make $name property non-nullable in both parsers

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

gerritbot added a project: Patch-For-Review.Feb 14 2025, 11:31 AM
gerritbot added a comment.Feb 14 2025, 11:37 AM

Change #1119517 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Try to clarify the meaning of "key" accross the codebase

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

gerritbot added a comment.Feb 14 2025, 11:58 AM

Change #1119692 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Rename and document normalizeKey methods and related code

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

gerritbot added a comment.Feb 14 2025, 1:28 PM

Change #1119517 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Try to clarify the meaning of "key" accross the codebase

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

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.17; 2025-02-18).Feb 14 2025, 2:00 PM
gerritbot added a comment.Feb 14 2025, 2:28 PM

Change #1119719 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Rename ambiguous "id" and "key" concepts in Parsoid code

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

gerritbot added a comment.Feb 14 2025, 2:42 PM

Change #1119728 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Drop redundant backlink id property from Parsoid code

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

gerritbot added a comment.Feb 14 2025, 3:53 PM

Change #1119735 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Drop redundant backlink tracking from the Parsoid code

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

gerritbot added a comment.Feb 17 2025, 7:58 AM

Change #1119719 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Rename ambiguous "id" and "key" concepts in Parsoid code

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

gerritbot added a comment.Feb 17 2025, 8:25 AM

Change #1119728 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Drop redundant backlink id property from Parsoid code

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

gerritbot added a comment.Feb 18 2025, 10:37 AM

Change #1120501 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Index by globalId and avoid slow loop in rollback code

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

gerritbot added a comment.Feb 18 2025, 4:17 PM

Change #1119692 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Rename and document normalizeKey methods and related code

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

ReleaseTaggerBot edited projects, added: MW-1.44-notes (1.44.0-wmf.18; 2025-02-25); removed: MW-1.44-notes (1.44.0-wmf.17; 2025-02-18).Feb 18 2025, 5:00 PM
thiemowmde added a project: WMDE-TechWish-Sprint-2025-02-19.Feb 19 2025, 8:26 AM
thiemowmde moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2025-02-19 board.
gerritbot added a comment.Feb 19 2025, 10:21 AM

Change #1119735 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Drop redundant backlink tracking from the Parsoid code

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

gerritbot added a comment.Feb 19 2025, 10:33 AM

Change #1120501 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Index by globalId and avoid slow loop in rollback code

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

gerritbot added a comment.Feb 19 2025, 2:45 PM

Change #1119690 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Make $name property nullable in both parsers

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

awight moved this task from Tech Review to Done on the WMDE-TechWish-Sprint-2025-02-19 board.Feb 19 2025, 3:22 PM
Maintenance_bot removed a project: Patch-For-Review.Feb 19 2025, 3:30 PM
thiemowmde closed this task as Resolved.Feb 21 2025, 9:24 AM
gerritbot added a comment.Feb 28 2025, 5:19 PM

Change #1123691 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Drop now obsolete parameter in internal rollback stack

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

gerritbot added a project: Patch-For-Review.Feb 28 2025, 5:19 PM
thiemowmde mentioned this in T387991: Clean up, merge, and share code between Cite legacy and Cite Parsoid.Mar 5 2025, 1:48 PM
gerritbot added a comment.Mar 7 2025, 8:32 AM

Change #1123691 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Drop now obsolete parameter in internal rollback stack

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

gerritbot added a comment.Mar 12 2025, 12:54 PM

Change #1123691 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Drop now obsolete parameter in internal rollback stack

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

ReleaseTaggerBot edited projects, added: MW-1.44-notes (1.44.0-wmf.21; 2025-03-18); removed: MW-1.44-notes (1.44.0-wmf.18; 2025-02-25).Mar 12 2025, 1:01 PM
gerritbot added a comment.Mar 18 2025, 9:49 AM

Change #1128810 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Move all (back)link generator logic into AnchorFormatter

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

gerritbot added a comment.Mar 18 2025, 11:59 AM

Change #1128844 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Rename ambiguous "target" to "noteId" in the Parsoid code

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

gerritbot added a comment.Mar 19 2025, 5:37 PM

Change #1128844 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Rename ambiguous "target" to "noteId" in the Parsoid code

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

ReleaseTaggerBot edited projects, added: MW-1.44-notes (1.44.0-wmf.22; 2025-03-25); removed: MW-1.44-notes (1.44.0-wmf.21; 2025-03-18).Mar 19 2025, 6:00 PM
gerritbot added a comment.Mar 21 2025, 12:01 PM

Change #1128810 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Move all (back)link generator logic into AnchorFormatter

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

gerritbot added a comment.Apr 10 2025, 10:04 AM

Change #1135682 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Reword all remaining uses of "key" in qqq.json

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

gerritbot added a comment.Apr 10 2025, 11:03 AM

Change #1135682 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Reword all remaining uses of "key" in qqq.json

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

ReleaseTaggerBot edited projects, added: MW-1.44-notes (1.44.0-wmf.25; 2025-04-15); removed: MW-1.44-notes (1.44.0-wmf.22; 2025-03-25).Apr 10 2025, 12:00 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits