Setting up CKEditor on MODx Evolution
I’ve been using the default TinyMCE rich text editor that comes bundled with MODx Evolution on all my sites. Recently though, I’ve been a little dissatisfied with it and decided to try a different RTE. Digging through the forums and the repository, I came across CKEditor as a possible alternative rich text editor. So far I’ve installed it on two client sites and it works fabulously! This little writeup walks through just the basics of how to install and set up CKEditor for your MODx Evolution site. (I am using MODx Evolution 1.0.2).
Getting the Plugin
At the time of this writing, the only available CKEditor plugin in the MODx repository is for MODx Revolution. I had to dig a little through the forums to find the one for Evolution. I recommend that you download the one on this post: http://modxcms.com/forums/index.php/topic,39191.msg263209.html#msg263209. This forum post is also a great place to do some reading if you’re having problems with setting things up. Here is the direct download link – http://code.google.com/p/modx-ja/downloads/detail?name=ckeditor331-alpha.zip (thanks Byzantium for bringing the updated link to my attention, [the older version ckeditor31-test.zip is now DEPRECATED]). Extract the archive to your desktop or directly on your server, whichever you prefer.
Installing the Plugin
- Inside the assets->plugins folder of your extracted folder is the ckeditor folder. Move this to the plugins folder on your MODx site (assets->plugins).
- Go into Elements->Manage Elements->Plugins, and create a new plugin called ckeditor. Copy the contents of the plugin.ckeditor.tpl file to it.
- Next, while still on the plugin code page, click on the System Events tab and check the following events: OnRichTextEditorInit, OnRichTextEditorRegister, and OnInterfaceSettingsRender
- Save your new plugin and then go into Tools->Configuration->Interface & Features. Scroll down to Editor to Use. CKEditor should show on the drop down list, select it and save your changes
That’s it for the basic set up. Now when you to to create a new resource, you should see the CKEditor as your RTE.
I’m interested to see what you think of CKEditor vs. other RTEs that you’ve tried with MODx. Before this I’ve only worked with TinyMCE but so far I like CKEditor much better and so do my clients.