Installation Guide

Requirements:
You need at least JRE 1.4 and a Servlet 2.4/JSP 2.0 compliant server implementation to run the library and the demo webapp.

Using Maven 2

Attention:
The integration pack will be available on the central repo after it has gone gold, from then on the additional repository location will be obsolete!

Include a dependency reference to the library in the dependencies section of your POM:

<project>
  ...
  <repositories>
    <repository>
      <releases>
        <enabled>true</enabled>
      </releases>
      <id>fckeditor-java-releases</id>
      <name>FCKeditor.Java Releases</name>
      <url>http://java.fckeditor.net/m2repo</url>
      <layout>default</layout>
    </repository>
  </repositories>
  ...
  <dependencies>
    <dependency>
      <groupId>net.fckeditor</groupId>
      <artifactId>java-core</artifactId>
      <version>2.4-beta-1</version>
    </dependency>
  </dependencies>
  ...
</project>

Manual installation

The distribution comes in three flavors, pick one from the download area which fits best in your environment.

  • fckeditor-java-core-2.4-beta-1.jar

    If you already have all dependencies on your classpath, simply put this jar on your classpath (usually WEB-INF/lib) and you are ready to go.

  • fckeditor-java-2.4-beta-1-bin.zip (or tar.gz)

    If you are starting from scratch, this distribution fits best. This package comes with pre-built jars, all dependencies, the entire documentation for offline usage and the license file.

    The pre-built jars are:

    FileDescription
    fckeditor-java-core-2.4-beta-1.jarmain jar
    fckeditor-java-core-2.4-beta-1-javadoc.jaroptional javadoc for IDE integration

    The lib folder contains the following dependencies:

    FileDescription
    commons-fileupload-1.2.jarApache Commons FileUpload library
    commons-io-1.3.2.jarApache Commons IO library
    slf4j-api-1.5.0.jarSimple logging facade library

    Drop the main jar and the dependencies in your classpath (usually WEB-INF/lib) and you are ready to go.

  • fckeditor-java-2.4-beta-1-src.zip (or tar.gz)

    If you want to check out the integration's source code, refit to your needs (obeying the license terms) or compile yourself, this is the perfect distribution for you. Building the WAR yourself requires having the a fckeditor folder at the same level as the fckeditor-java-2.4-beta-1 folder.

FCKeditor installation

Although the public distribution is fine, it still contains a lot of superfluous files for a Java environment. Use the following Ant target on the FCKeditor zip file (1,25 MiB) to create a cleaner and smaller distribution zip file (986 KiB).

<target name="clean-fckeditor" description="Creates a clean FCKeditor distribution">
  <!-- Adapt properties to your needs -->
  <property name="fckeditor-tmp" location="fckeditor-tmp" />
  <property name="fckeditor-basename" value="FCKeditor_2.6" />
  <property name="fckeditor-destfile" value="${fckeditor-basename}_clean.zip" />

  <delete file="${fckeditor-destfile}" />
  <unzip dest="${fckeditor-tmp}" src="${fckeditor-basename}.zip" />
  <zip destfile="${fckeditor-destfile}">
    <zipfileset dir="${fckeditor-tmp}/fckeditor" prefix="fckeditor">
      <include name="_samples/_plugins/" />
      <include name="editor/" />
      <include name="fckconfig.js" />
      <include name="*.xml" />
      <exclude name="editor/filemanager/connectors/" />
    </zipfileset>
  </zip>
  <delete dir="${fckeditor-tmp}" />
</target>

A word on Logging

Attention:
Do not skip this section otherwise your application will fail!

We use the state-of-the-art logging facade SLF4J. To make SFL4J work at runtime, you have to add one binding and the appropriate backend (may be optional) into your classpath.
Please check the SLF4J website for more information on bindings and the API itself.