Page MenuHomePhabricator
Create Task
Maniphest T164806

Improve documentation for CodeMirror extension
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Current documentation: https://www.mediawiki.org/wiki/Extension:CodeMirror

Please update with the following goals in mind:

Let's put the documentation for end-users (editors) at https://meta.wikimedia.org/wiki/Community_Tech/Wikitext_editor_syntax_highlighting. That should include:

  • Provide a color coding key explaining what the available highlights are, and how they're colored.
  • Explain how a user can override the CodeMirror styles with their own styles (via their user common.css page).
  • Some screenshots

Related Objects
Search...

Event Timeline

kaldari created this task.May 8 2017, 10:40 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 8 2017, 10:40 PM
kaldari moved this task from New & TBD Tickets to Needs Discussion on the Community-Tech board.May 8 2017, 10:40 PM
Aklapper added a project: Documentation.May 9 2017, 7:47 AM
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.May 9 2017, 10:07 AM
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.
Aklapper reopened this task as Open.May 9 2017, 10:19 AM
• DannyH added a parent task: T101246: Highlighted wikisyntax while editing articles [AOI].May 11 2017, 1:01 AM
• DannyH triaged this task as Medium priority.May 16 2017, 9:50 PM
kaldari updated the task description. (Show Details)May 16 2017, 11:53 PM
kaldari set the point value for this task to 3.
• DannyH moved this task from Needs Discussion to Up Next on the Community-Tech board.May 16 2017, 11:55 PM
• DannyH edited projects, added Community-Tech-Sprint; removed Community-Tech.May 26 2017, 8:23 PM
Niharika claimed this task.Jun 30 2017, 12:06 AM
Niharika moved this task from Ready to In Development on the Community-Tech-Sprint board.
Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Jul 11 2017, 12:40 AM
Niharika added a subscriber: Quiddity.Jul 11 2017, 12:43 AM

This is now live at https://meta.wikimedia.org/w/index.php?title=Community_Tech/Wikitext_editor_syntax_highlighting (with a TON of help from @Quiddity).

kaldari updated the task description. (Show Details)Jul 11 2017, 6:39 PM
kaldari updated the task description. (Show Details)Jul 11 2017, 6:51 PM

@Niharika: The new end-user documentation looks great. We still need to update the extension documentation though. See the first 3 bullet points in the description.

kaldari moved this task from Needs Review/Feedback to In Development on the Community-Tech-Sprint board.Jul 11 2017, 6:53 PM
Niharika added a comment.Jul 11 2017, 6:53 PM

@kaldari: We are directing our beta feature users to the talk page on mediawiki and the features page on meta. This is inconsistent. We should fix this.

Niharika added a comment.Jul 12 2017, 8:22 PM
== Integrating other extensions with CodeMirror ==
If your extension adds a special tag or code and you want to make sure CodeMirror highlights it, you can make your extension depend on CodeMirror. Here's [https://gerrit.wikimedia.org/r/#/c/348673/ the first] and [https://gerrit.wikimedia.org/r/#/c/350840/ the second example] for doing this.

[[File:Pride and codemirror.png|300px|thumb|Screenshot of Syntax Highlighting in English.]]
[[File:Codemirror hindi.png|thumb|300px|Screenshot of Syntax Highlighting in Hindi.]]
[[File:Codemirror popup.png|thumb|250px|Screenshot of Syntax Highlighting with the popup for first-time users.]]

@kaldari I don't have any idea how the integration stuff works. The above is what I can add to the page. Is there anything you'd like to add to that?

Niharika moved this task from In Development to Needs Review/Feedback on the Community-Tech-Sprint board.Jul 12 2017, 8:24 PM
kaldari added a comment.Jul 12 2017, 8:25 PM

@Niharika: That'll work.

Niharika added a comment.Jul 12 2017, 8:30 PM

@Quiddity Hey! Can you help me update that page now? It still gives me weird Translate errors if I try to update it.

Add the below after 'Configuration parameters' section.

== Integrating other extensions with CodeMirror ==
If your extension adds a special tag or code and you want to make sure CodeMirror highlights it, you can make your extension depend on CodeMirror. Here's [https://gerrit.wikimedia.org/r/#/c/348673/ the first] and [https://gerrit.wikimedia.org/r/#/c/350840/ the second example] for doing this.

And update the screenshots gallery with
Pride and codemirror.png
Codemirror hindi.png
Codemirror popup.png
(Remove the existing screenshot)

Thank you!

Quiddity added a comment.Jul 12 2017, 10:39 PM

Done. Plus I split up the To do list, so that adding/removing new items won't invalidate the whole block. :-)

kaldari closed this task as Resolved.Jul 12 2017, 10:56 PM
kaldari moved this task from Needs Review/Feedback to Q1 2018-19 on the Community-Tech-Sprint board.
• DannyH edited projects, added Community-Tech; removed Community-Tech-Sprint.Jul 18 2017, 10:39 PM
• DannyH moved this task from Up Next to Archive on the Community-Tech board.Jul 18 2017, 10:46 PM
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