public
Description: FCKEditor for the Radiant CMS
Clone URL: git://github.com/djcp/radiant-fckeditor.git
Search Repo:
name age message
folder README Thu Jun 12 19:46:15 -0700 2008 Readme updates [djcp]
folder Rakefile Fri May 23 18:53:13 -0700 2008 First commit [djcp]
folder app/ Thu Jun 12 19:38:50 -0700 2008 Add more allowed file types and remove the &quo... [djcp]
folder fckeditor.html Thu Jun 05 20:31:08 -0700 2008 Documentation fixes and change to a skin that b... [djcp]
folder fckeditor_extension.rb Thu Jun 05 20:37:10 -0700 2008 Version increment in preparation of release. [djcp]
folder lib/ Fri Jun 06 11:27:14 -0700 2008 Fix install task error. [djcp]
folder public/ Thu Jun 05 19:33:06 -0700 2008 Remove many extra non-essential files, some of ... [djcp]
folder spec/ Fri May 23 20:18:12 -0700 2008 A good start - the fckeditor controller is bein... [djcp]
README
= Fckeditor
This gives you the excellent FCKEditor (with file uploads and spell checking) in your Radiant page parts.

== Requirements
This extension has been tested on Radiant version 0.6.7. It *should* work on lower versions that have the Shards 
extension installed, but I can't confirm this.

You need to have aspell installed for spell checking to work.

== Installation
In $RADIANT_ROOT

1. Get the extension:
git clone git://github.com/djcp/radiant-fckeditor.git vendor/extensions/fckeditor

2. Install the relevant resources into $RADIANT_ROOT/app/public/javascripts/fckeditor*
rake radiant:extensions:fckeditor:update

3. Restart your deployment server.

== Uninstallation
Remove:
* vendor/extensions/fckeditor
* public/javascripts/fckeditor/
* public/javascripts/fckconfig.js
* public/uploads/File|Flash|Image|Media

== Notes
* There are no changes to your Radiant database.
* Uploaded files are saved in $RADIANT_ROOT/public/uploads
* You can have FCKEditor handle only some page parts - it won't interfere with parts handled by another filter.
* You can upload JPG, PNG, GIF and flash files, along with many common video, audio, and office document formats, 
including text and HTML.

== Usage
Set the filter on your page part to "Fckeditor" and the editor will be instantiated. You can remove the editor from a 
page part by setting the filter back to something other than "Fckeditor."

Use the "browse server" button on the Image, Flash, and Link tools to invoke the file upload feature.

== Gotchas
* Be sure to allow pop-ups from your Radiant site. The FCKEditor uses popups extensively.
* Radius tags may get mangled by FCKEditor. We've done our best to ensure FCKEditor ignores them, but there will still 
be quirks. See the Filter Reference on the /admin/pages/edit/ page for details.
* If you don't have aspell installed, spell checking will never find errors. It'll always return "no errors found."
* If you see multiple FCKEditors on your page parts, you're probably running Radiant 0.6.7 in development mode. Either:
** Downgrade to 0.6.6 with shards,
** Run in production mode, or
** Upgrade to the latest Radiant from github.

== TODOS
* Look into integrating this plugin with the PageAttachments plugin so that files live on pages and the same uploads are 
available in FCKEditor and Radius tags.
* Create an admin tab to allow for the specification of allowed MIME-types and customization of toolbar buttons.

== See Also
Based upon Scott Rutherford's Rails 2.0 plugin:
http://blog.caronsoftware.com/2008/2/6/fckeditor-plugin-0-4-3-released

http://www.fckeditor.net/

== Author
* Dan Collis-Puro, dan@endpoint.com, End Point Corporation

== Contributors
* Jereme Claussen, www.jeremeclaussen.com, for debugging help.