Editor 2.7: Difference between revisions
(Added a link to paint web, previous GSOC project) |
Jason Fowler (talk | contribs) |
||
Line 181: | Line 181: | ||
* Good existing documentation | * Good existing documentation | ||
* Simple hook for file-picker: http://www.tinymce.com/wiki.php/Configuration:file_browser_callback | * Simple hook for file-picker: http://www.tinymce.com/wiki.php/Configuration:file_browser_callback | ||
* Uses LESS for style sheets | |||
Revision as of 03:42, 19 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 & Damyon @ Moodle HQ |
Moodle 2.7
Project goals
The purpose of this document is to plan how to update the default text editor in Moodle.
The aim of this change is to improve accessibility and usability, while replacing TinyMCE 3.5, which is now unsupported.
TinyMCE 3.5 will be kept in place for the next few releases, but will 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 need to be made compatible with the new editor.
Considerations
- Usability of the editor - is it easy to create content with?
- Accessibility of the editor - is it at or easy to get it to follow the WCAG AA standard?
- Accessibility of the code produced by the editor - will it produce content that is up to the WCAG AA standard?
- 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 its interface be modified to look like the other toolbars currently in Moodle?
- Do the dialogues look the same and have the same accessibility features we expect from Moodle dialogues? Do the dialogues scale/re-flow on small screens?
- Strong feature set - does it support the things our users have come to expect already?
- String support - how difficult will it be to allow strings to change when the Moodle language changes?
- Mobile support - how well does it scale on small screens and 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 - will it be supported for the lifetime we want (3 years+?)
- RTL support - does it include RTL support for the content, user interface and included dialogues?
Out there suggestions
- Add a picture editor to Moodle. (Paintweb - previous GSOC project: Paint_tool_integration )
- 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
- ??? Are there other alternatives?
.. | CKEditor 4 | Atto | TinyMCE 4 |
---|---|---|---|
Usable Editor |
|
|
|
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
- Ability to replace file browser with Moodle's filepicker
- baseFloatZIndex - allows the zIndex to be set in a more strict manner
Cons:
- Unfamiliar to Moodle developers
Atto
Pros:
- Excellent accessibility
- Excellent integration for Moodle strings
- Inline HTML Source editor - no need to open a dialogue to edit the source
Cons:
- Maintenance will rely on Moodle developers
- 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
- Simple hook for file-picker: http://www.tinymce.com/wiki.php/Configuration:file_browser_callback
- Uses LESS for style sheets
Cons:
- Swapping from WYSIWYG mode to Source mode launches a dialogue
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 Dialogues.
- Add file management plugin (Marinas or other)
- Disable TinyMCE