Tech:FCKEditor Integration

[Edit]Description

MediaWiki+FCKEditor is a Javascript-based GUI editor that offers an interface suitable for rich editing. Integrating this editor as an option for JAMWiki would provide a much simpler interface for new users to use when creating and editing wiki pages.

[Edit]Author(s)

[Edit]Status

Initial code committed on /branches/ronin.

[Edit]Comments

A few quick review comments:

  • jamwiki-core shouldn't have a dependency on bliki, if possible. The jamwiki-core package is used outside of JAMWiki by projects that simply want a Mediawiki parser, so I'd like to minimize dependencies as much as possible. Ideally it would be nice to create the FCKEditor integration as an addon, but that can be cleaned up later if needed.
  • JAMWiki 0.7.0 added the ability for users to choose different editors, so edit.jsp can still specify the toolbar, and simply add an addition option for FCK. To do so modify /jamwiki-war/src/main/resources/jamwiki-configuration.xml to add another editor, and that editor can then be selected as the "preferred editor" from Special:Account. Admins can also specify it as the "default editor" from Special:Admin.
  • It would be nice to refactor the EditServlet changes in a way so that they are configurable, based on the editor being used - for example, I prefer to edit directly by entering wiki syntax, and I'm sure others would probably prefer not to be forced to use a GUI editor.

I suspect you've already thought through some of these items, so please ignore anything that's not relevant. I didn't want to change anything on your branch, but if you want me to jump in and make a few updates to allow easier configuration or anything like that let me know - it's definitely cool to see this proceeding. -- Ryan • (comments) • 25-Mar-2009 20:01 PDT

I worked originally on 0.6.7 which has no editor preferences, and I didn't get time to look through new features. I'll be happy to let you make changes in my branch. Please go ahead.--ronin
I've looked at tinyMCE - http://tinymce.moxiecode.com too. once we can close FCKeditor, I'll work on tinyMCE integration.--ronin 28-Mar-2009 01:48 PDT.
The FCKeditor-2.3.jar referenced in branch is generated from recompiled FCKeditor.java 2.3 source with patch - http://dev.fckeditor.net/attachment/ticket/1552/1552.patch) to detect webkit and opera correctly.--ronin
I should have some time this afternoon to go through the code and make a few updates to get it in sync with the latest 0.7.0 developments - sorry it's taken so long! -- Ryan • (comments) • 29-Mar-2009 07:27 PDT
I get Unable to load tag handler class "com.fredck.FCKeditor.tags.FCKeditorTag" for tag "fck:editor" when I try to run this code. I tried adding the FCK java-core to the POM (see below), but the taglib TLD is referencing classes that aren't in the java-core-2.4.1.jar file. Is there a config missing or am I doing something wrong? -- Ryan • (comments) • 29-Mar-2009 19:34 PDT 
	<dependency>
		<groupId>net.fckeditor</groupId>
		<artifactId>java-core</artifactId>
		<version>2.4.1</version>
	</dependency>
could you resolve it yet? I don't think there is any need for java-core. I've already included FCKeditor-2.3.jar in /jamwiki-war/src/main/webapp/WEB-INF/lib/ with no dependency other than commons-fileupload. it builds for me alright.--ronin 30-Mar-2009 14:39 PDT
FCKeditor-2.3.jar doesn't end up in the WAR file that is generated when I build your branch - I'll try to investigate this tomorrow, but if you have any ideas please feel free to commit whatever changes you feel are needed. Sorry this is taking a bit long, but life has gotten crazy since I've returned from vacation... -- Ryan • (comments) • 30-Mar-2009 22:36 PDT
I spent fifteen minutes looking at this again last night - I'm trying to figure out if there's a Maven repository that can be added to the pom.xml file to include the necessary JAR file in the JAMWiki WAR, but haven't had any luck thus far. If anyone else can get this working I'd be grateful, otherwise I guess we can manually include the needed JAR file in the SVN repository. -- Ryan • (comments) • 01-Apr-2009 07:58 PDT
Ryan, I do maintain the FCKeditor.Java code. Scanning through your post I don't understand the problem. You simply have to declare the dependency and define the taglib in the JSP. Please check out the demo war file I have provided and the official site (java.fckeditor.net). My account 'mosipov' does not seem to be accessible :-( Mike
Ryan, there are 2 reasons I didn't go by maven repo route. 1) I'm using an old version 2.3 of FCKeditor.Java code 2) I had to recompile it for webkit/opera fix. If you can checkout branch code and have a look at build.sh in branch root, which I use to build and deploy code. It copies /jamwiki-war/src/main/webapp/WEB-INF/lib/FCKeditor-2.3.jar to final war file. I'm not sure how you are building the code.--ronin 01-Apr-2009 19:40 PDT
That explains it - I wasn't getting any FCKEditor java files in the final build, but I was using the standard Maven build commands. Thanks for the clarification; I'll take a closer look and get it working locally. -- Ryan • (comments) • 01-Apr-2009 20:01 PDT
Hi Ronin - first, I'm really, really sorry I've been so slow with feedback. I checked my local copy of your branch and I don't see a FCKeditor-2.3.jar file in it. Should I be obtaining that file from some other source? Where do I download it from? I looked at the build.sh and Quickbuild.sh files but both reference local sources. You had indicated that you were using a customized version with a patch for webkit/opera, so I assume it's not the standard version available from fckeditor.net. Sorry for the confusion and the slow feedback. -- Ryan • (comments) • 02-Apr-2009 21:04 PDT
Hi Ryan, I forgot to commit lib folder as it didn't show up as uncommited folder in subclipse(WEB-INF/lib is in svn:ignore). I apologize for wasting so much of your time. It should work now ---ronin 03-Apr-2009 12:48 PDT

If Fckeditor isn't working out - how about TinyMCE?

Thanks for the pointer - I'm hoping to revisit the GUI editor integration in the next 1-2 months and will definitely look at any alternative options that people can suggest. I don't personally use GUI editors for wiki editing, but I know this is a major issue for many installations and want to put something in place as soon as possible. -- Ryan • (comments) • 13-Dec-2009 18:48 PST

No worries. Another option that could be better is to GWTify your app. http://gwt.google.com/samples/Showcase/Showcase.html#CwRichText It's maybe not as sexy as FCKEditor or TinyMCE but it's java (kind of) and it's rock solid. Integration should be a snap.