Changes between Version 4 and Version 5 of CkEditorPlugin


Ignore:
Timestamp:
Jun 10, 2011, 2:07:31 PM (3 years ago)
Author:
itamarost
Comment:

added installation instructions and full_integration disclaimer

Legend:

Unmodified
Added
Removed
Modified
  • CkEditorPlugin

    v4 v5  
    66
    77Wysiwyg wiki editor plugin using the open-source [http://ckeditor.com/ CKEditor], inspired by TracWysiwygPlugin.
     8
     9'''NOTE: The `full_integration` mode is not recommended for use in production! It is still experimental, and under massive development.'''
    810
    911The plugin does not contain the [http://ckeditor.com/ CKEditor] source (get it from their [https://svn.ckeditor.com/CKEditor SVN] - require >= 3.6).
     
    4648You can check out CkEditorPlugin from [http://trac-hacks.org/svn/ckeditorplugin here] using Subversion, or [source:ckeditorplugin browse the source] with Trac.
    4749
     50== Installation ==
     51Install the plugin:
     52{{{
     53easy_install http://trac-hacks.org/svn/ckeditorplugin/trunk
     54}}}
     55
     56Get the CKEditor package and deploy it in a URL-accessible path, e.g. the `htdocs` directory of your Trac environmemt:
     57{{{
     58$ mkdir /path/to/trac-env/htdocs/js
     59$ svn checkout http://svn.ckeditor.com/CKEditor/releases/stable /path/to/trac-env/htdocs/js/ckeditor
     60}}}
     61
     62Enable it from the Plugins section of the Administration panel, or by adding the following to the `[components]` section of your `trac.ini`:
     63{{{
     64#!ini
     65[components]
     66ckintegration.* = enabled
     67}}}
     68
     69The following options can be specified in the `[ckeditor]` section of your `trac.ini` (default values shown):
     70{{{
     71#!ini
     72[ckeditor]
     73editor_type = html_wrapper # mode of integration, as explained above
     74editor_source = sites/js/ckeditor/ckeditor.js # The URL where CKEditor was installed (the default matches the example above for deploying CKEditor)
     75}}}
     76
    4877== Example ==
    4978