aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2014-03-15 15:05:42 -0300
committerSilvio Rhatto <rhatto@riseup.net>2014-03-15 15:05:42 -0300
commit20f9884f9a52e810d7e3cdbdd92eabc64812e097 (patch)
treef01dbe4db567b7bebb38274286ca2b3fc02a6d66 /README.md
downloadelgg-20f9884f9a52e810d7e3cdbdd92eabc64812e097.tar.gz
elgg-20f9884f9a52e810d7e3cdbdd92eabc64812e097.tar.bz2
Squashed 'mod/ckeditor/' content from commit 9f4ede0
git-subtree-dir: mod/ckeditor git-subtree-split: 9f4ede06562e229a26d7ae8d32ebb23453c293e7
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..98bd5e331
--- /dev/null
+++ b/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.
+