Page MenuHomePhabricator
Create Task
Maniphest T284985

Add links to documentation in help messages
Closed, ResolvedPublic1 Estimated Story Points
Actions

Assigned To
Lena_WMDE
Authored By
ECohen_WMDE
Jun 15 2021, 8:50 AM
Tags
Referenced Files
F34854082: UndocumentedLink.png
Dec 7 2021, 11:08 AM
F34767088: Screen Shot 2021-11-25 at 16.43.58.png
Nov 25 2021, 3:49 PM
F34767097: Screen Shot 2021-11-25 at 16.43.51.png
Nov 25 2021, 3:49 PM
F34767085: Screen Shot 2021-11-25 at 16.44.43.png
Nov 25 2021, 3:49 PM
Subscribers
Aklapper
ECohen_WMDE
Lena_WMDE
thiemowmde
WMDE-Fisch

Description

Background

We improved the existing documentation and would like to link to it to provide in-context help for when users encounter confusing concepts and would like additional information.

Requirements

Dialog stateCurrent messageLinks
Undocumented parameters
Screen Shot 2021-11-25 at 16.44.43.png (88×574 px, 16 KB)
parameters (leave the same), undocumented (switch URL to be more specific)
Multi-part template content
Screen Shot 2021-11-25 at 16.43.58.png (96×568 px, 15 KB)
connected content
Autogenerated params
Screen Shot 2021-11-25 at 16.43.51.png (112×571 px, 23 KB)
autogenerated
  • Links should include Special:MyLanguage to see linked pages in preferred language
  • When links are pointing to sections make sure that the {{anchor|…}} templates are used on the page so we can help directing to the right section on translated versions

Details

SubjectRepoBranchLines +/-
Add link to undocumented parameter helpmediawiki/extensions/VisualEditormaster+2 -2
Parse new link in multipart messagemediawiki/extensions/VisualEditormaster+2 -1
Add links to documentation in help messagesmediawiki/extensions/VisualEditormaster+8 -8
Customize query in gerrit

Related Objects
Search...

Event Timeline

ECohen_WMDE created this task.Jun 15 2021, 8:50 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 15 2021, 8:50 AM
ECohen_WMDE moved this task from Backlog to In preparation on the WMDE-Templates-FocusArea board.Jun 28 2021, 11:07 AM
ECohen_WMDE mentioned this in T276574: Add reactive notices and warnings in VE template dialog.Aug 23 2021, 1:50 PM
ECohen_WMDE renamed this task from [Placeholder] Add links to documentation throughout template VE workflow to Add links to documentation in help messages.Nov 25 2021, 3:49 PM
ECohen_WMDE updated the task description. (Show Details)
ECohen_WMDE added a parent task: T276574: Add reactive notices and warnings in VE template dialog.Nov 25 2021, 3:51 PM
ECohen_WMDE moved this task from In preparation to Ready for pickup on the WMDE-Templates-FocusArea board.
Lena_WMDE updated the task description. (Show Details)Nov 25 2021, 4:03 PM
Lena_WMDE added a project: WMDE-TechWish-Sprint-2021-11-24.
WMDE-Fisch claimed this task.Nov 26 2021, 10:44 AM
WMDE-Fisch set the point value for this task to 1.
WMDE-Fisch moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2021-11-24 board.
WMDE-Fisch added a comment.Nov 26 2021, 11:02 AM

Links should include Special:MyLanguage to see linked pages in preferred language

The issue with that is, that the targeted headlines using the URL-fragment will not work when using Special:MyLanguage. They will not be translated AFAIK. When looking at other links in the i18n messages some of these still use Special:MyLanguage in combination with a fragment though. I'm not sure how translators deal with that. Without Special:MyLanguage they might be bold enough to manually set the title and fragment of the page, but with Special:MyLanguage they might think that part is fixed by the script.

So I'm not sure what's worse, "just" linking to the English page but hitting the right section or jumping the right Language page but just to the start of the page.

P.S.: And sorry if we talked about that already for several times and I forgot what we ended up with. :-D

WMDE-Fisch moved this task from Doing to UX/PM Review on the WMDE-TechWish-Sprint-2021-11-24 board.Nov 26 2021, 11:07 AM
WMDE-Fisch removed WMDE-Fisch as the assignee of this task.Nov 29 2021, 8:09 AM
WMDE-Fisch subscribed.
ECohen_WMDE added a comment.Nov 29 2021, 3:51 PM

So I'm not sure what's worse, "just" linking to the English page but hitting the right section or jumping the right Language page but just to the start of the page.

Neither of these is very ideal. I didn't know that it was only possible to do one or the other. Seems odd for such an important function?

In this case, I think linking to correct section would take priority. It's unfortunate but it's such a huge help page that I think helping people navigate is most important and then they can switch their language after. Is there somewhere we could also submit a phab ticket about updating Special:MyLanguage though?

ECohen_WMDE moved this task from Ready for pickup to In sprint on the WMDE-Templates-FocusArea board.Nov 29 2021, 5:31 PM
WMDE-Fisch claimed this task.Dec 1 2021, 9:22 AM
WMDE-Fisch moved this task from UX/PM Review to Doing on the WMDE-TechWish-Sprint-2021-11-24 board.

Is there somewhere we could also submit a phab ticket about updating Special:MyLanguage though?

I'll have a look. Might be there is already a ticket for that.

WMDE-Fisch updated the task description. (Show Details)Dec 1 2021, 9:23 AM
gerritbot added a comment.Dec 1 2021, 9:33 AM

Change 742929 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/VisualEditor@master] Add links to documentation in help messages

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

gerritbot added a project: Patch-For-Review.Dec 1 2021, 9:33 AM
WMDE-Fisch moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2021-11-24 board.Dec 1 2021, 9:33 AM
WMDE-Fisch updated the task description. (Show Details)Dec 1 2021, 10:38 AM
WMDE-Fisch added a comment.Dec 1 2021, 10:45 AM
In T284985#7534220, @ECohen_WMDE wrote:

So I'm not sure what's worse, "just" linking to the English page but hitting the right section or jumping the right Language page but just to the start of the page.

Neither of these is very ideal. I didn't know that it was only possible to do one or the other. Seems odd for such an important function?

In this case, I think linking to correct section would take priority. It's unfortunate but it's such a huge help page that I think helping people navigate is most important and then they can switch their language after. Is there somewhere we could also submit a phab ticket about updating Special:MyLanguage though?

There seems to be a way to avoid that issue. See my updated description.

gerritbot added a comment.Dec 1 2021, 10:52 AM

Change 742929 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Add links to documentation in help messages

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

WMDE-Fisch added a comment.Dec 1 2021, 10:53 AM

Anchors added to the page, see https://www.mediawiki.org/w/index.php?diff=4942471&oldid=4921734&title=Help:VisualEditor/User_guide&type=revision&diffmode=source

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.12; 2021-12-06).Dec 1 2021, 11:00 AM
WMDE-Fisch moved this task from Tech Review to Demo on the WMDE-TechWish-Sprint-2021-11-24 board.Dec 1 2021, 11:04 AM
Maintenance_bot removed a project: Patch-For-Review.Dec 1 2021, 11:10 AM
ECohen_WMDE added a comment.Dec 1 2021, 2:03 PM

There seems to be a way to avoid that issue. See my updated description.

That's great news!

gerritbot added a comment.Dec 2 2021, 3:45 PM

Change 743199 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/VisualEditor@master] Parse new link in multipart message

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

gerritbot added a project: Patch-For-Review.Dec 2 2021, 3:45 PM
gerritbot added a comment.Dec 3 2021, 10:58 AM

Change 743199 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Parse new link in multipart message

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

WMDE-Fisch removed WMDE-Fisch as the assignee of this task.Dec 7 2021, 9:37 AM
WMDE-Fisch moved this task from Demo to Sprint Backlog on the WMDE-TechWish-Sprint-2021-11-24 board.
gerritbot added a comment.Dec 7 2021, 10:05 AM

Change 744766 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/VisualEditor@master] Add link to undocumented parameter help

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

thiemowmde subscribed.EditedDec 7 2021, 10:11 AM

From today's demo time:

WMDE-Fisch moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2021-11-24 board.Dec 7 2021, 10:24 AM
WMDE-Fisch added a comment.Dec 7 2021, 11:08 AM

I prepared a little patch for that. It would look like this :-)

UndocumentedLink.png (151×585 px, 20 KB)

thiemowmde added a project: WMDE-TechWish-Sprint-2021-12-08.Dec 8 2021, 11:20 AM
thiemowmde moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2021-12-08 board.
thiemowmde moved this task from Tech Review to Demo on the WMDE-TechWish-Sprint-2021-12-08 board.Dec 8 2021, 1:26 PM
ECohen_WMDE added a comment.Dec 13 2021, 11:08 AM

@thiemowmde @WMDE-Fisch looks good to me! agree repeating it there could be helpful. thanks for the catch!

gerritbot added a comment.Dec 13 2021, 1:56 PM

Change 744766 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Add link to undocumented parameter help

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.13; 2021-12-13); removed MW-1.38-notes (1.38.0-wmf.12; 2021-12-06).Dec 13 2021, 2:00 PM
Lena_WMDE moved this task from Demo to Done on the WMDE-TechWish-Sprint-2021-12-08 board.Dec 14 2021, 12:57 PM
Lena_WMDE closed this task as Resolved.Dec 14 2021, 1:05 PM
Lena_WMDE claimed this task.
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