LITE (LoopIndex Tracking Enhancement) for CKEditor

1. Include the lite plugin's interface in your html, e.g.

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

   You don't have to include this file, but doing so will allow you to use the constants defined in it, e.g. LITE.Commands.TOGGLE_TRACKING, LITE.Events.ACCEPT
2. If LITE is not included in ckedito's plugins list, add it to the editor's configuration. The simplest way to do this is by adding the following line to ckeditor's config.js:

   	config.extraPlugins = 'lite';
   

   If your configuration already contains some plugin tweaking, just make sure that LITE is included in the editor's plugins list.
3. If you wish to make any other configuration changes via config.js, verify that the editor's configuation contains a lite section by adding the following lines to ckeditor's config.js:

   	var lite = config.lite|| {};
   	config.lite = lite;
   

4. If your page doesn't include jQuery, the LITE plugin will load it during its initialization. By default the code is loaded from the lits/js folder. If you want to provide a different path, you can do so by configuring the value of lite.jQueryPath in ckeditor's config.js. The path you specify should be relative to the lite folder.

   	config.lite.jQueryPath = "../common/jquery.min.js";
   

Configuration

• By default, LITE loads a minifed version of ice, located in its js folder. To load ice from a different location, or load other versions (e.g. full sources for debugging), edit your config.js and set a value to config.lite.includes, e.g.

  	config.lite.includes = ["js/my-includes.min.js", "js/some-plugins.min.js"];
  

  Paths are relative to the LITE plugin folder
• Select the LITE commands you want to include in ckeditor's toolbar. By default all the commands in lite-interace.js are available in the toolbar except for toggle tooltips. To configure this, edit config.js and set a value to the config.lite.commands, e.g.

  // display only the show/hide, accept all and reject all commands.
  	config.lite.commands = [LITE.Commands.TOGGLE_SHOW, LITE.Commands.ACCEPT_ALL, LITE.Commands.REJECT_ALL];
  

• Some more LITE options may be set through the config.lite object:
  • userName - the initial username used by the ICE change tracker
  • userId - the initial user ID used by the ICE change tracker
  • titleTemplate - the template of the text shown as a title (tooltip) when the cursor hovers over a tracked change region. The default value is Changed by %u %t, %u representing the user name and %t representing a time stamp relative to the current time (e.g. now, 2 minutes ago, May 31). The titles are refreshed periodically. If you provide an empty template, no title will be displayed.
  • userStyles - a map of id=>style number which allows you to consistenly display styles per user id. By default LITE creates a new style per user as it is introduced.
  • tooltips - set to true (or omit altogether) to get the default implementation of LITE tooltips, based on Opentip. You can also set tooltips to an object with various configuration options.
  • isTracking - set to false to start the plugin's life with change tracking turned off.
• You may also tweak the configuration in your code by listening to the CKEditor configLoaded event and then modifying the editor's config.lite object.

• Get a reference to the lite plugin

  To interact with the lite plugin, you need to obtain a reference to the actual plugin object which is unique for each instance of CKEditor. The safest way to do this is by listening to the event LITE.Events.INIT fired by the editor instance. The data member of the event will contain a property called lite which references the lite plugin instance, initialized and ready for action.

  You can also obtain a reference directly from a fully initialized CKEditor by calling myEditor.plugins.lite.findPlugin(myEditor).

• toggleTracking(bTrack, bNotify)

  Toggles change tracking in the editor.

  Parameters

  • bTrack - boolean. If undefined, change tracking is toggled, otherwise it is set to this value
  • bNotify - boolean. If false, the LITE.Events.TRACKING event is not fired.

• toggleShow(bShow, bNotify)

  Change the visibility of tracked changes. Visible changes are marked by a special style, otherwise insertions appear in their original format and deletions are hidden.

  Parameters

  • bShow - boolean. If undefined, change visibility is toggled, otherwise it is set to this value
  • bNotify - boolean. If false, the LITE.Events.SHOW_HIDE event is not fired.

• acceptAll(options)

  Accept some or all the pending changes.

  Parameters

  • options - optional object filter the changes to which this operation applies with the following properties:
    • exclude
      an array of user ids to exclude from the the operation (takes precedence over include)
    • include
      an array of user ids to include from the the operation
    • filter
      a filter function that accepts an object of the form {userid, time, data} and returns a boolean. Only changes for which the filter returns true are included in the operation. The filter option can work with both exclude and include.
    All the fields you include in the options block, including custom ones, are preserved when it is sent back in the ACCEPT or REJECT events (see below).

  • rejectAll(options)

    Reject all the pending changes.

    Parameters

    • options - optional object to filter the changes to which this operation applies. See the acceptAll method for details.

  • countChanges(options)

    Returns a count of the tracked changes in the editor.

    Parameters

    • options - optional object to filter the counted changes. See the acceptAll method for details.

  • hasChanges()

    Sets the name and id of the current user. Each tracked change is associated with a user id.

    Parameters

    • none

  • setUserInfo(info)

    Sets the name and id of the current user. Each tracked change is associated with a user id.

    Parameters

    • info - An object with two members - id and name

  • setChangeData(data)

    Associates an arbitrary string with the changes made from now on. This string is passed to the optional filter function in options block passed to various methods that accept change filtering. For example, you may associate a revision number with the current change set and later on filter changes according to their revision.

    Parameters

    • data - Arbitrary data (converted to a string by the LITE plugin).