summaryrefslogtreecommitdiffstatsabout
blob: 37694d6aeee474d9ad878b0fb0d8dce83c08de3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# CKEditor for RAP 2.1

This is a custom widget for the Remote Application Platform (RAP) that wraps the CKEditor, a web-based WYSIWYG/Rich-Text editor. 
This version is based on the remote API that has been added in RAP 2.0. If you wish to run it with RAP 1.5,
check out the "streams/1.5" branch.

## API
Currently, the API consists of the two methods <code>getText</code> and <code>setText</code>. 
The text can be any valid HTML, but should be limited to the subset the editor can handle.

## Customization

The editor can be customized by editing the files in the <code>src/resources</code> folder of the <code>org.eclipse.rap.addons.ckeditor</code> bundle.
You might need to clear the browsers cache and restart the server for all changes to take effect.

### Editor Configuration

Editing the file <code>config.js</code> lets you change the toolbar, language, and formatting options (fonts, colors).
Be careful, all changes here bear the risk of breaking the editor.

### Editor Theming

To change the icons, edit or replace <code>icons.png</code>.
To change the editors colors, borders, spacings, etc, edit <code>editor.css</code>. You can use a tool like Firebug to examine which CSS classes are used where in the editor.

### Advanced Customization

For various reasions some plugins have been removed from <code>ckeditor.js</code> and disabled in <code>config.js</code>, therefore not all options of the full CKEdtior are working.
If you wish, you can compile your own <code>ckeditor.js</code>. Get more info here: http://docs.cksource.com/CKEditor_3.x/Developers_Guide/CKPackager
The <code>ckeditor.pack</code> used for this project can be found in the bundles <code>docs</code> folder.

## Bundle overview

### org.eclipse.rap.addons.ckeditor

The Widget itself (<code>org.eclipse.rap.addons.ckeditor.CKEditor</code>) and the required resources.

### org.eclipse.rap.demo.ckeditor

A demo application for the widget.
Contains a launch configuration.

### org.eclipse.rap.examples.pages.ckeditor

A page addition to the RAP Examples Demo.

### org.eclipse.rap.addons.ckeditor.test

JUnit an Jasmine Tests.

## Legal

=== License ===

All classes are published under the terms of the Eclipse Public License v1.0