[[PageOutline(2-5,Contents,pullout)]]

= CKEditor Wysiwyg Plugin =

== Description ==

Wysiwyg wiki editor plugin using the open-source [http://ckeditor.com/ CKEditor], inspired by TracWysiwygPlugin.

The plugin does not contain the [http://ckeditor.com/ CKEditor] source (get it from their [https://svn.ckeditor.com/CKEditor SVN] - require >= 3.6).
After installation of both the plugin and [http://ckeditor.com/ CKEditor], set the `[ckeditor] editor_source` option for this plugin to the path of the CKEditor `ckeditor.js` script.

The plugin has 3 modes of integration, determined by the `[ckeditor] editor_type` option:
|| `html_wrapper` || CKEditor with HTML output wrapped in html-processor ||
|| `full_integration` || CKEditor with TracWiki output (experimental, under development) ||
|| `none` || No integration - plain old textarea ||

The `full_integration` mode is the holy grail, but currently just a handful of elements are supported in this mode (see the [source:ckeditorplugin/trunk/ckintegration/htdocs/tracwiki.js tracwiki plugin] for details on that) - '''help with this is needed! '''

Disclaimer:
 - Does not co-exist with TracWysiwygPlugin - have only one of them enabled.
 - When using the `html_wrapper` mode and editing an existing wiki page, the page will be rendered in HTML upon save (macros are lost, etc.)


== Help Wanted ==
Help wanted for further development:
 - Killer Feature: Support TracWiki syntax (by HTML<->TracWiki conversions? or by making CKEditor's rendering engine emit TracWiki?)
 - Insert WikiLinks using cool dialogs (e.g. choose existing page from TitleIndex, insert link to stubbed page & open new tab to create the stubbed page)
 - Insert other kinds of TracLinks using cool dialogs (changesets, tickets, other resources...)
 - Insert images intuitively (selector from attachments / repositories / upload from file-system as attachment or into repository, maybe even drag-and-drop)
 - Macro-awareness - select macro to insert from supported macros, expand inserted macros inline

== Bugs/Feature Requests == 

Existing bugs and feature requests for CkEditorPlugin are 
[report:9?COMPONENT=CkEditorPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=CkEditorPlugin&owner=itamarost new ticket].

== Download ==

Download the zipped source from [download:ckeditorplugin here].

== Source ==

You can check out CkEditorPlugin from [http://trac-hacks.org/svn/ckeditorplugin here] using Subversion, or [source:ckeditorplugin browse the source] with Trac.

== Example ==


== Recent Changes ==

[[ChangeLog(ckeditorplugin, 5)]]

== Author/Contributors ==

'''Author:''' Edan Maor, [wiki:itamarost] [[BR]]
'''Maintainer:''' [wiki:itamarost] [[BR]]
'''Contributors:'''