@akordacorp/liter v3.0.0

Akorda Updates

This fork of LoopIndex's seeks to modernize some of the underlying code by converting to Typescript and adding a Create React App (CRA) test application (with additional CKEditor plugin webpack build code).

The initial conversion to Typescript seeks only to have a working implementation. Little to no work has been done to type the underlying code properly.

Track Changes Plugin for CKEditor

• Track changes plugin for CKEditor, based on ICE (NYTimes track changes for contentEditable documents).

Main Features

• Enable / disable track changes mode
• Show / hide tracked changes
• Accept/Reject all/some changes
• Accept/Reject a single change
• Display customizable tooltips for each change

##Demo

Demo Page

##Site LoopIndex

##Getting Started

• Add the lite plugin to ckeditor. The simplest way to do this is by adding the following line to ckeditor's config.js:

	config.extraPlugins = 'lite';

• Optionally include lite-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/lite/lite-interface.js"></script>

• See the documentation for all the configuration options.

##Configuration The LITE plugin is automatically activated after you install it and edit config.js as described above. For the full details of tweaking the loading process, toolbar commands, users and more, see the documentation.

API

Events

The LITE plugin events are listed in lite-interface.js under LITE.Events. The following events are fired by the LITE plugin instance through its instance of ckeditor, with the parameter in the data member of the event info:

##Known Issues

• Adjacent changes from different collaborators may affect each other if you accept/reject a single change in the sequence. This is related to an issue in ICE which we hope to resolve with the developers.
• See the ICE page for known issues related to ICE.
• Note that the ICE engine adds markup to the editor content.
• LITE tracks only text insertion and deletion. Other changes, such as style edits, are not tracked.

##Browser Compatibility LITE has been tested on Firefox 15+, Chrome 13+ and MSIE 9+. Support for MSIE 8 is not guaranteed, although the current version seems to work on it.

##License

Copyright (c) LoopIndex.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program as the file gpl.txt. If not, see http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Written by (David *)Frenkiel (https://github.com/imdfl)