Page MenuHomePhabricator
Create Task
Maniphest T165003

Syntax highlighting popover for first-time user
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

When a user enables syntax highlighting and opens an edit window for the first time, a popover appears, as seen here: https://wikimedia.invisionapp.com/share/25BK644SD#/232930653_default

Text -- NOTE: THIS IS DIFFERENT FROM THE MOCKUP
Syntax highlighting will help you easily distinguish article text from wikitext markup

Clicking the "Try it" button turns syntax highlighting on. Clicking "No, thank you" dismisses the popover.

Screenshot:

syntax highlight popup.png (968×2 px, 298 KB)

As per conversation in T163919: Design review for CodeMirror extension

Details

SubjectRepoBranchLines +/-
Show a popup for first time Codemirror usersmediawiki/extensions/CodeMirrormaster+112 -9
Make sure popup appears for both classic and wikitext editorsmediawiki/extensions/CodeMirrormaster+27 -19
Fixes for Codemirror popup patchmediawiki/extensions/CodeMirrormaster+18 -24
Add missing dependencymediawiki/extensions/CodeMirrormaster+2 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

• DannyH created this task.May 11 2017, 1:28 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 11 2017, 1:28 AM
• DannyH added a parent task: T101246: Highlighted wikisyntax while editing articles [AOI].May 11 2017, 1:28 AM
• DannyH updated the task description. (Show Details)
• DannyH added a project: MediaWiki-extensions-CodeMirror.
• DannyH added a comment.May 11 2017, 1:32 AM

The text is open for discussion.

Nirzar's original text:
Syntax highlighting will help you easily distinguish different parts of your edit by color coding them

My draft:
Syntax highlighting will help you easily distinguish article text from wikitext

This could be improved; does anyone have suggestions?

• DannyH mentioned this in T163919: Design review for CodeMirror extension.May 11 2017, 1:34 AM
• DannyH updated the task description. (Show Details)May 16 2017, 6:04 PM
• DannyH triaged this task as Medium priority.May 16 2017, 9:50 PM
kaldari added a comment.EditedMay 16 2017, 11:11 PM

Don't reinvent the wheel. Figure out how other beta features like RevisionSlider remember that you've already seem the pop-over, and use whatever they're doing. Or VisualEditor might be a better example.

kaldari set the point value for this task to 3.May 16 2017, 11:11 PM
• DannyH moved this task from Needs Discussion to Up Next on the Community-Tech board.May 16 2017, 11:23 PM
• Niharika subscribed.May 17 2017, 4:46 PM

Syntax highlighting will help you easily distinguish article text from wikitext

It's not clear to me what that means. The article text is in Wikitext. They aren't different entities. Every link, citation, template, they all work together to form the "article text".

kaldari edited projects, added Community-Tech-Sprint; removed Community-Tech.May 26 2017, 8:27 PM
kaldari updated the task description. (Show Details)Jun 9 2017, 8:05 PM

@Niharika: I changed it to say "wikitext markup".

• TBolliger subscribed.Jun 9 2017, 8:12 PM
dbarratt claimed this task.Jun 9 2017, 8:12 PM
dbarratt moved this task from Ready to In Development on the Community-Tech-Sprint board.
dbarratt removed dbarratt as the assignee of this task.Jun 9 2017, 8:15 PM
dbarratt moved this task from In Development to Ready on the Community-Tech-Sprint board.
dbarratt subscribed.
• DannyH added a comment.Jun 9 2017, 8:22 PM

@kaldari Good, that makes it clearer. Thanks

• Niharika claimed this task.Jun 13 2017, 12:31 AM
• Niharika moved this task from Ready to In Development on the Community-Tech-Sprint board.
gerritbot subscribed.Jun 26 2017, 11:40 PM

Change 361600 had a related patch set uploaded (by Niharika29; owner: Niharika29):
[mediawiki/extensions/CodeMirror@master] Show a popup for first time Codemirror users

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

gerritbot added a project: Patch-For-Review.Jun 26 2017, 11:40 PM
• Niharika added a comment.Jun 27 2017, 12:18 AM

Here's what it looks like:

Screen Shot 2017-06-26 at 4.31.49 PM.png (275×246 px, 29 KB)

Only shown for first time users and a key/value pair is stored in localstorage. As long as that key/value exists, the popup won't be shown again. This is consistent with how Revision Slider and VE do it, afaik. They also use cookies but from my chat with Ryan, we can just skip showing it if there is no localstorage. That'd be rare, probably.

• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Jun 27 2017, 8:38 PM

CI failing currently due to non-related issues.

kaldari moved this task from Needs Review/Feedback to In Development on the Community-Tech-Sprint board.Jun 28 2017, 5:53 AM
• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Jun 28 2017, 10:54 PM
kaldari added a comment.Jun 29 2017, 8:06 PM

@DannyH: The code looks good now. Can you sign off on the screenshot above? (or suggest improvements if needed)

• DannyH added a comment.Jun 29 2017, 8:35 PM

Sorry, I thought I'd said this out loud a couple days ago :) -- yes, that looks great to me.

gerritbot added a comment.Jun 29 2017, 9:48 PM

Change 361600 merged by jenkins-bot:
[mediawiki/extensions/CodeMirror@master] Show a popup for first time Codemirror users

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

• Niharika closed this task as Resolved.Jun 29 2017, 10:13 PM
• Niharika moved this task from Needs Review/Feedback to Q1 2018-19 on the Community-Tech-Sprint board.
gerritbot added a comment.Jun 30 2017, 6:36 PM

Change 362452 had a related patch set uploaded (by Niharika29; owner: Niharika29):
[mediawiki/extensions/CodeMirror@master] Fixes for Codemirror popup patch

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

gerritbot added a comment.Jun 30 2017, 6:52 PM

Change 362452 merged by jenkins-bot:
[mediawiki/extensions/CodeMirror@master] Fixes for Codemirror popup patch

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

gerritbot added a comment.Jun 30 2017, 7:35 PM

Change 362460 had a related patch set uploaded (by Niharika29; owner: Niharika29):
[mediawiki/extensions/CodeMirror@master] Add missing dependency

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

gerritbot added a comment.Jun 30 2017, 7:47 PM

Change 362460 merged by jenkins-bot:
[mediawiki/extensions/CodeMirror@master] Add missing dependency

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

kaldari reopened this task as Open.Jun 30 2017, 11:25 PM

Currently, it only shows the pop-up when the user is using the Classic ("default") toolbar, but it doesn't show it when the user is using the WikiEditor (aka "enhanced") toolbar. We need to have it work in both.

kaldari moved this task from Q1 2018-19 to In Development on the Community-Tech-Sprint board.Jun 30 2017, 11:25 PM
gerritbot added a comment.Jul 3 2017, 8:53 PM

Change 363090 had a related patch set uploaded (by Niharika29; owner: Niharika29):
[mediawiki/extensions/CodeMirror@master] Make sure popup appears for both classic and wikitext editors

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

• DannyH raised the priority of this task from Medium to High.Jul 3 2017, 11:46 PM
• Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Jul 4 2017, 12:17 AM
kaldari closed this task as Resolved.Jul 6 2017, 5:37 PM
kaldari moved this task from Needs Review/Feedback to Q1 2018-19 on the Community-Tech-Sprint board.
gerritbot added a comment.Jul 6 2017, 5:38 PM

Change 363090 merged by jenkins-bot:
[mediawiki/extensions/CodeMirror@master] Make sure popup appears for both classic and wikitext editors

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

ReleaseTaggerBot added a project: MW-1.30-release-notes (WMF-deploy-2017-07-11_(1.30.0-wmf.9)).Jul 8 2017, 4:01 AM
• DannyH edited projects, added Community-Tech; removed Community-Tech-Sprint.Jul 18 2017, 10:37 PM
• DannyH moved this task from Up Next to Archive on the Community-Tech board.Jul 18 2017, 10:46 PM
Esanders mentioned this in T171292: Refactor and upstream Education Popups.Jul 21 2017, 10:56 AM
Liuxinyu970226 moved this task from Backlog to Done on the MediaWiki-extensions-CodeMirror board.Feb 9 2018, 4:02 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