Okay, so I've been using CKEditor for a while. And recently I've been trying to edit/write a plugin. I do think CKEditor is pretty awesome, but I do have some issues about the 'easy customization' claim.. (and I know I'm not the only one). I will admit it's highly customizable, but easy?.. No..
So please allow me to make some suggestions. Do with them as you like:
I really wish the documentation would be more comprehensible. I'm not a newbie to learning new types of scripts, frameworks, etc., but modifying CKEditor has one of the steepest learning curves I've ever experienced. Every time I figure something out, i seem to hit a new obstacle which takes another 30 minutes to figure out. It's like trying to find something in a big dark warehouse with only a flashlight and no map or signs to point you in the right direction.
I'm hoping that at some point the documentation will be more like php.net, having a single page for every function actually explaining what it does, how to use it, refer to related functions, show some examples and allow for comments. For example:
That doesn't really tell me much.. does it need to return anything? How do I select elements to get data / write text to the editor, etc.. How is it related in the bigger scheme of things? What is it's proper/best use? Are there similar functions I should check out instead?
In my searches it seems that the forums here (and other websites) are flooded by people trying to figure out some pretty basic stuff (like me), and very few real solutions are given. There's a lot of 'just check the examples' or 'read the documentation', which is more of a user attitude problem (seriously, if you know the answer, take some time to explain, or at least give some useful pointers)..
But again, the documentation is not much of a help to me, and apparently, a lot of other people seem to have the same problem. Also, the forums could be much better structured. Adding more categories for different issues should be a big help. Plenty of people here who are willing to help make it easier, but it can be a real feat to find the right info.
I can never quite seem to find what I need to know. It's been pretty frustrating at times. And that's a bad thing for your user base. The easier you make it for us, the more we can help make awesome plugins and other customizations. Which in turn will make your editor better and more popular. Add the possibility of people uploading their skins, plugins, snippets, whatever. More usable examples from users will only make things easier to understand.
Bottom line: I'm sure it's not all that hard to customize CKEditor when you know how to do it.. getting to know how seems to be the biggest problem.
I hope this is of some help. Maybe other people have some suggestions as well..
So please allow me to make some suggestions. Do with them as you like:
I really wish the documentation would be more comprehensible. I'm not a newbie to learning new types of scripts, frameworks, etc., but modifying CKEditor has one of the steepest learning curves I've ever experienced. Every time I figure something out, i seem to hit a new obstacle which takes another 30 minutes to figure out. It's like trying to find something in a big dark warehouse with only a flashlight and no map or signs to point you in the right direction.
I'm hoping that at some point the documentation will be more like php.net, having a single page for every function actually explaining what it does, how to use it, refer to related functions, show some examples and allow for comments. For example:
{Function} onOk Since: 3.0
The function to execute when OK is pressed.
That doesn't really tell me much.. does it need to return anything? How do I select elements to get data / write text to the editor, etc.. How is it related in the bigger scheme of things? What is it's proper/best use? Are there similar functions I should check out instead?
In my searches it seems that the forums here (and other websites) are flooded by people trying to figure out some pretty basic stuff (like me), and very few real solutions are given. There's a lot of 'just check the examples' or 'read the documentation', which is more of a user attitude problem (seriously, if you know the answer, take some time to explain, or at least give some useful pointers)..
But again, the documentation is not much of a help to me, and apparently, a lot of other people seem to have the same problem. Also, the forums could be much better structured. Adding more categories for different issues should be a big help. Plenty of people here who are willing to help make it easier, but it can be a real feat to find the right info.
I can never quite seem to find what I need to know. It's been pretty frustrating at times. And that's a bad thing for your user base. The easier you make it for us, the more we can help make awesome plugins and other customizations. Which in turn will make your editor better and more popular. Add the possibility of people uploading their skins, plugins, snippets, whatever. More usable examples from users will only make things easier to understand.
Bottom line: I'm sure it's not all that hard to customize CKEditor when you know how to do it.. getting to know how seems to be the biggest problem.
I hope this is of some help. Maybe other people have some suggestions as well..
Re: Some feedback on CKEditor customization and documentatio
Thanks for your feedback and taking your time to explain the problem. We are aware of this unfortunate situation
Once we finish the User's Guide for CKEditor, we'll start working on improving the documentation for Developers.
Wiktor Walc
CTO, CKSource - http://cksource.com
--
Follow CKEditor on: Twitter | Facebook | Google+
Re: Some feedback on CKEditor customization and documentatio
Okay, that's good news
It must be quite a task.. especially if you actually 'get' the system you made, it's hard to overlook the 'simpler' parts because they've become 2nd nature.
I think you can start out with a lot of the questions people are asking on the forums. Also, if you set up a documentation on the site with one function per page, and add a comments feature, you don't have to do everything by yourself immediately. Some of your user base may already put some really useful information there even before you add the official info.