Editor 2.7: Difference between revisions
Jason Fowler (talk | contribs) |
Jason Fowler (talk | contribs) |
||
Line 54: | Line 54: | ||
! TinyMCE 4 | ! TinyMCE 4 | ||
|- | |- | ||
| Accessible Editor | | '''Accessible Editor''' | ||
| | | | ||
* Still minor room for improvement | * Still minor room for improvement | ||
Line 62: | Line 62: | ||
* Lots of warnings on the Chrome Accessibility Audit | * Lots of warnings on the Chrome Accessibility Audit | ||
|- | |- | ||
| Accessible Content | | '''Accessible Content''' | ||
| | | | ||
* '''Unknown''' | * '''Unknown''' | ||
Line 71: | Line 71: | ||
* Decorative images need empty alt tag | * Decorative images need empty alt tag | ||
|- | |- | ||
| Maintainable with Moodle | |''' Maintainable with Moodle''' | ||
| | | | ||
* '''Unknown''' | * '''Unknown''' | ||
Line 79: | Line 79: | ||
* '''Unknown''' | * '''Unknown''' | ||
|- | |- | ||
| Editor Appearance | | '''Editor Appearance''' | ||
| | | | ||
* Can be themed to look like existing toolbars | * Can be themed to look like existing toolbars | ||
Line 89: | Line 89: | ||
* Can the menu visibility be toggled? | * Can the menu visibility be toggled? | ||
|- | |- | ||
| Feature set | | '''Feature set''' | ||
| | | | ||
* Almost 100% matching what we have already | * Almost 100% matching what we have already | ||
Line 98: | Line 98: | ||
|- | |- | ||
| String Support | | '''String Support''' | ||
| | | | ||
* May need some work to get it working | * May need some work to get it working | ||
Line 106: | Line 106: | ||
* Will need some work to get it working | * Will need some work to get it working | ||
|- | |- | ||
| Mobile Support | | '''Mobile Support''' | ||
| | | | ||
* Editor works well, the the dialogues don't | * Editor works well, the the dialogues don't | ||
Line 114: | Line 114: | ||
* Editor works well, the the dialogues don't | * Editor works well, the the dialogues don't | ||
|- | |- | ||
| Plugin Support | | '''Plugin Support''' | ||
| | | | ||
* Plugins are easy to write | * Plugins are easy to write | ||
Line 126: | Line 126: | ||
* Plenty of 3rd party plugins already out there | * Plenty of 3rd party plugins already out there | ||
|- | |- | ||
| Loading Speed | | '''Loading Speed''' | ||
| | | | ||
* Stock editor loads fairly quickly | * Stock editor loads fairly quickly |
Revision as of 03:46, 15 November 2013
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Text Editor Revamp | |
---|---|
Project state | In Development |
Tracker issue | |
Discussion | https://moodle.org/mod/forum/discuss.php?d=243197 |
Assignee | Jason Fowler @ Moodle HQ |
Moodle 2.7
Project goals
The primary purpose is to update the default text editor in Moodle to a new editor.
This will improve accessibility, and usability, while replacing the now unsupported TinyMCE 3.5.8.
TinyMCE 3.5.8 will be kept in place for the next few releases, but will likely be disabled by default.
Along with the replacement of the Editor, plugins for TinyMCE 3.5.8 that are included as part of the Moodle release will be made compatible with the new Editor.
What other changes can we make to Moodle and the text editors to give a better user experience?
Considerations
- Accessibility of the editor - is it at or easy to get it to WCAG AA?
- Accessibility of the code produced by the editor - is it at or easy to get it to WCAG AA?
- Maintainability of the links between the editor and Moodle - how much work will we need to do every time we upgrade?
- Appearance of the editor - can it be modified to look like the other toolbars currently in Moodle?
- Do the dialogues look the same and have the same accessibilty features we expect from moodle dialogues? Do the dialogues scale/reflow on small screens?
- Stong feature set - does it support the things our users have come to expect already?
- String support - how difficult will it be to allow the strings to change when the Moodle language changes?
- Mobile support - how well does it scale on small screens + touchscreens?
- Plugin support - can our community write plugins easily?
- Browser support - does it support all the browsers Moodle does?
- Loading speed - how quick is it to load the editor ready for use?
- Upstream support - is the source willing to support it for the lifetime we want (3 years+?)
Out there suggestions
- Add a picture editor to Moodle
- Add a "html_tiny" text format with a super cut down editor that supports it (e.g. - no toolbar at all - but still html with bold, italics, cut/paste etc)
- Drag and drop handling of media
Candidates
- CKEditor4
- Atto
- TinyMCE 4
- ???
.. | CKEditor 4 | Atto | TinyMCE 4 |
---|---|---|---|
Accessible Editor |
|
|
|
Accessible Content |
|
|
|
Maintainable with Moodle |
|
|
|
Editor Appearance |
|
|
|
Feature set |
|
|
|
String Support |
|
|
|
Mobile Support |
|
|
|
Plugin Support |
|
|
|
Loading Speed |
|
|
|
CKEditor 4
Pros:
- Huge community of developers
- Plenty of plugins
- Good existing documentation
- Inline HTML Source editor - no need to open a dialogue to edit the source
Cons:
Atto
Pros:
- Excellent accessibility
- Excellent integration for Moodle strings
- Inline HTML Source editor - no need to open a dialogue to edit the source
Cons:
- No table/grid support
- No Dragmath/ Tex Support
- We need to document it ourselves
- No external community to lean on
TinyMCE 4
Pros:
- Menus allow the toolbars to be less cluttered
- Huge community of developers
- Plenty of plugins
- Good existing documentation
Cons:
- Swapping from WYSIWYG mode to Source mode launches a dialog
Sub Tasks
- Assess different editors
- Prototype alternatives
- Ask some users
- Decide on an editor
- Implement editor
- Getting the new editor to render without altering the existing DOM - prevents changes needed to maintain third party plugins.
- Getting AMOS strings working within Editor.
- Getting Filepicker working within Editor Dialogs.
- Add file management plugin (Marinas or other)
- Disable tinyMCE