This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

This page presents some information regarding the upgrade process. You may find references to the SVN version (which will become a future version). For more information about the SVN, see Subversion (SVN) Access.

The advices listed in this page are cumulative, so if you are upgrading from an older version to a newer one, please take note of all advices between both versions.

If you don't find any advice for your current version here, you will much probably have no problems with the upgrade. '

Note: this page contains information starting from version 2.3.1. For older versions, please take a look in the "_whatsnew.html" file, which can be found in the editor distribution package.

From 2.x to 2.y

General Guidelines

Usually, upgrading from version 2.x to version 2.y is simple as overwriting the old editor installation directory with the new one. Just remember that any configuration or customization made in the previous installation must be backup-ed, saved and remembered.

For configurations, we highly recommend to place a custom configurations file outside the editor installation directory, and then use the "CustomConfigurationsPath" setting to point to that file (see Configuration). We recommend having the same approach with custom skins, plugins, smileys, XML files, etc...

From 2.6 to SVN

  • No important recommendations.

From 2.5 to 2.6

  • A new dialog system has been introduced, which brought some changes to the skin CSSs. Any custom skin must be reviewed.

From 2.4.3 to 2.5

  • API: The GetHTML function has been deprecated in favor of GetData.
  • API: The SetHTML function has been deprecated in favor of SetData.
  • All the connectors have been moved from filemanager/default/connectors and f ilemanager/upload to /filemanager/connectors, so their paths in fckconfig.js must be adjusted accordingly.
  • Now a single file will control both the filebrowser and quick upload for each server language.
  • The default connector has been changed from ASP to PHP.
  • The configuration file for the connectors (currently ASP and PHP) has been extended so it's possible to adjust the name of the subfolders for each file type.
  • The ForceStrongEm configuration setting has been removed. You can use now the CoreStyles to control the output.

From 2.4.2 to 2.4.3

  • API: The CreateLink function now returns an array of <a> nodes, instead of a single <a> node.

From 2.4 to 2.4.1

  • The default keystroke combination for "Save" has been changed from <Ctrl>+<Alt>+to <Ctrl>+<Shift>+<S> (see ticket #138).
  • The new FCKpackager is now used to generate the compressed scripts of FCKeditor. FCKeditor.Packager has been discontinued.

From 2.3.3 to 2.4

  • The new <Enter> key handler system is being introduced.
  • The UseBROnCarriageReturn configuration is no longer valid. The EnterMode setting can now be used to precisely set the enter key behavior.
  • The default folder used in the distribution package is now named "fckeditor" (in lowercase), instead of "FCKeditor". All integration files are pointing to the lowercase folder. This change may impact installations on case sensitive OSs, like Linux.
  • All connectors are now pointing by default to the "/userfiles/" folder instead of "/UserFiles/" (case change). Also, the inner folder for each type (file, image, flash and media) are all lowercased too.
  • All JavaScript Core extension function have been renamed to "PascalCase" (some were in "camelCase"), to standardize the editor code, and make our customizations easily visible. This may have impact on plugins that use any of those functions.
  • The extensions "html", "htm" and "asis" have been added to the list of denied extensions on upload.

From 2.3.2 to 2.3.3

  • The Universal Keyboard has been removed from the package. If the toolbar contains the 'UniversalKey' command the editor will warn that the command isn't known: you'll need to remove the command from your toolbar or create a plugin based on the code existing in the previous version.

From 2.3.1 to 2.3.2

  • The Template dialog window has now a new checkbox which makes it possible to tell the editor to paste the template in the cursor position. This operation may not be wanted, so use the "TemplateReplaceCheckbox" configuration option to remove the checkbox.
  • The File Browser now may display scrollbars. If you have a custom File Browser and it is showing up any undesirable scrollbar, just set:
    <body style="overflow: hidden;">

From 1.x to 2.x

The editor has been completely rewritten for version 2.0. Hundreds of new features have been added and the editor is now compatible with more browsers.

The integration code for the 1.x is not compatible with the 2.x, so you must make a clean installation of version 2.x and review all your code that uses the editor.

This page was last edited on 21 October 2008, at 14:22.