Changes between Version 4 and Version 5 of CkEditorPlugin

Timestamp:

Jun 10, 2011, 12:07:31 PM (13 years ago)

Author:

Itamar Ostricher

Comment:

added installation instructions and full_integration disclaimer

CkEditorPlugin

@@ -6 +6 @@
 
 Wysiwyg wiki editor plugin using the open-source [http://ckeditor.com/ CKEditor], inspired by TracWysiwygPlugin.
+
+'''NOTE: The `full_integration` mode is not recommended for use in production! It is still experimental, and under massive development.'''
 
 The plugin does not contain the [http://ckeditor.com/ CKEditor] source (get it from their [https://svn.ckeditor.com/CKEditor SVN] - require >= 3.6).
@@ -46 +48 @@
 You can check out CkEditorPlugin from [http://trac-hacks.org/svn/ckeditorplugin here] using Subversion, or [source:ckeditorplugin browse the source] with Trac.
 
+== Installation ==
+Install the plugin:
+{{{
+easy_install http://trac-hacks.org/svn/ckeditorplugin/trunk
+}}}
+
+Get the CKEditor package and deploy it in a URL-accessible path, e.g. the `htdocs` directory of your Trac environmemt:
+{{{
+$ mkdir /path/to/trac-env/htdocs/js
+$ svn checkout http://svn.ckeditor.com/CKEditor/releases/stable /path/to/trac-env/htdocs/js/ckeditor
+}}}
+
+Enable it from the Plugins section of the Administration panel, or by adding the following to the `[components]` section of your `trac.ini`:
+{{{
+#!ini
+[components]
+ckintegration.* = enabled
+}}}
+
+The following options can be specified in the `[ckeditor]` section of your `trac.ini` (default values shown):
+{{{
+#!ini
+[ckeditor]
+editor_type = html_wrapper # mode of integration, as explained above
+editor_source = sites/js/ckeditor/ckeditor.js # The URL where CKEditor was installed (the default matches the example above for deploying CKEditor)
+}}}
+
 == Example ==