FCKEditor API

I have been using eWebEditPro for years, but for a new project I am thinking of switching to FCKeditor. Problem is, I can't find the API. Nothing in the zip/gz files and I can't find the link on the docs wiki. Does anybody know where I can find the API.

Yes, I am assuming there is an API somewhere. Open-source software is not very useful without documentation.

Wed, 04/02/2008 - 16:53

escovado

Joined: 29/03/2008

Posts: 4

Re: FCKEditor API

The developer's documentation.

The JavaScript API.

Wed, 04/02/2008 - 17:21

lefty

Joined: 02/04/2008

Posts: 4

Re: FCKEditor API

The developer's documentation != API. The devel docs only expose a limited view of the available API.

The JavaScript API is not a printed API spec. I want to read want functions are available and what parameters are used, perhaps even offline, not something that needs an editor instance loaded on a page.

Wed, 04/02/2008 - 19:13

escovado

Joined: 29/03/2008

Posts: 4

Re: FCKEditor API

lefty wrote:The developer's documentation != API.

That is correct. However, that's all there is as far as I have been able to find. You'll have to start digging through the source code.

Fri, 04/04/2008 - 20:56

lefty

Joined: 02/04/2008

Posts: 4

Re: FCKEditor API

Thanks for all the help.

I can't believe how a project of this size has such little documentation. I spent an hour and a half trying to fix code found in a FCK HowTo. If I had proper API documentation, I could have solved it within 5 minutes.

Selection.MoveToNode( eSelected ) ; is now Selection.SelectNode( eSelected ) ;

Looking into TinyMCE now. Lack of documentation makes me weary of using FCKEditor.

Sat, 04/05/2008 - 12:05

alfonsoml

Joined: 31/12/2006

Posts: 3735

Re: FCKEditor API

The API is the public part that could be used without problems. If you want to use the internal functions, you are free to do so, but as that Howto that you have found, if you want rely on objects or functions that aren't in the public part, then you must follow the development and update your code when those functions are changed.

To learn about the internal APIs you don't need anything special, just browse the _source folders and everything is there, you can even try to use something like JSDoc if that makes you happy, but the fact is that the code is usually placed in a way that usually is very quick to find the proper object or function (that doesn't mean that the documentation doesn't need to be improved)