aboutsummaryrefslogtreecommitdiff
path: root/mod/ckeditor/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mod/ckeditor/README.md')
-rw-r--r--mod/ckeditor/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/mod/ckeditor/README.md b/mod/ckeditor/README.md
new file mode 100644
index 000000000..98bd5e331
--- /dev/null
+++ b/mod/ckeditor/README.md
@@ -0,0 +1,21 @@
+CKEditor WYSIWYG plugin
+========================
+
+Configuration options
+----------------------
+CKEditor configuration is set in the view js/ckeditor. The configuration object
+is elgg.ckeditor.config. A plugin can modify the configuration object by registering
+a function to run before the ckeditor.init function on the 'init', 'system' hook.
+This is where toolbar options and the skin are set.
+
+Content CSS
+------------
+The content CSS is stored in the view css/wysiwyg. This view is extended by the
+css/elements/reset and css/elements/typography views so that content appears the
+same when editing and viewing. It also contains all the CSS applied to the
+elgg-output class for the same reason (see the typography view).
+
+Hints
+------------
+ * If your theme does not use borders with tables, enable the CKEditor showborders plugin.
+