Welcome to FLITE for CKEditor

Full API documentation Demo Page LoopIndex site

Requirements

• FLITE has been tested on Firefox 15+, Chrome 13+, Safari 10.x and Edge. Support for MSIE 11 is not guaranteed, although the current version seems to work on it.

Main Features

• Enable / disable track changes mode
• Show / hide tracked changes
• Accept/Reject all/some changes
• Display customizable tooltips over tracked changes

Getting Started

• Add the flite plugin to ckeditor. The simplest way to do this is by adding the following line to ckeditor's configuration:
  config.extraPlugins = 'flite';

• Optionally include flite-interface.js in your source, so you can use the various constants defined in it rather than string literals.

  <script type="text/javascript" src="ckeditor/plugins/flite/js/flite-interface.js"></script>

Configuration

The FLITE plugin is automatically activated after you install as described above. For tracking to take place, you must configure FLITE with a current user. See the demo code for an example. For the full details of tweaking the loading process, toolbar commands, users and more, see the API documentation for full details.

API

The FLITE plugin exposes a wide range of methods, events and properties for controlling and reporting the tracked changes. See the API documentation for details.

In order to interact with a FLITE plugin instance, you need to obtain a reference to one.

The simplest way to do this is through a fully initialized CKEditor instance, e.g. myEditor.plugins.flite.findPlugin(myEditor).

The reason you can't access the instance directly, is that CKEditor maintains one plugin instance per web page, regardless of the number of editors. The master FLITE plugin creates plugin instances per editor and these can be accessed through the findPlugin(editor) API.

You can also get a reference to a FLITE plugin instance by listening to the editor event "flite:init" (or FLITE.Events.INIT if you include js/flite-interface.js).

var editor = CKEditor.replace({
// configuration parameters
});
editor.on("flite:init", function(event) {
	var flite = event.data.flite;
	// do something with the instance
});

Notes

• The FLITE tracking engine adds markup to the editor content. All the change tracking data is stored inline, as part of the document.
• FLITE tracks a wide range of editing actions, but not all of them. Most notably, style edits and search/replace operations are not tracked (they're on our roadmap, though).

License

Please visit our License page