Weblearn CKEditor Plugins

Documentation and Help

About the project

In 2014, Oxford's virtual learning environment, WebLearn, received a major overhaul. In the process, its WYSIWYG editor, CKEditor, was also upgraded. With an opportunity to further improve the experience for WebLearn users, plugins were developed in order to make the configuration and embedding of new content types simpler and more convenient (and where possible, without leaving the editor).

These widgets were developed by the WebLearn team of the University of Oxford and created as part of the IT Services 2014 Internship Program. The source code can be obtained from the project Github page.

Please let us know of any problems with either the widgets or documentation through the issues page.

Installing the plugins

The General plugins were developed to be used for any CKEditor installation. Download the plugins from the repository and look at the README.md file for installation instructions, as well as the example.html file for an example of the implementation.

The WebLearn-specific plugins were developed to be used within the WebLearn environment, and hence can only be implemented on WebLearn.

IMPORTANT NOTICES

  1. When using the plugins, clicking OK in their dialogs will load their required dependencies into the editor. If somehow their dependencies are removed during the course of editing the content, simply right-click on one of the embed placeholders and click OK and its dependencies will be reinserted.

  2. Certain plugins will require jQuery to run on your editor-created pages in order to display the content. A valid version of jQuery will automatically be embedded on the page when you click OK on the respective dialog.

  3. If you run into a problem with how the dialog is displayed, close the dialog and reopen it. Sometimes the Javascript hasn't fully loaded by the time you first open the dialog, and re-opening it seems to fix most visual issues.