Manually Upgrading ckEditor

Introduction

This articles provides notes, guidance and method for manually upgrading ckEditor in Camino CMS.

Important Information

The version of ckEditor included with Camino is upgraded to the latest version with every significant Camino release. As ckEditor is slightly reconfigured for use by Camino, its' functionality is tested with every Camino upgrade. Calzada Media does not test every version of ckEditor with Camino - only the versions officially included. Consequently any manual upgrade may not work as intended.

Support for ckEditor and any of its' plugins are provided by ckSource and/or the respective plugin authors via http://ckeditor.com/support

Method

1. Rename your existing ckEditor folder (~/app/components/ckEditor/ckEditor) to a backup folder - for example ckeditor_old
   • Do not delete the existing ckEditor directory as it contains files and directories that will be required later.
2. Download latest ckEditor
   • To download the latest version of ckEditor with the default Camino configuration, click on http://ckeditor.com/builder/download/68fa6e0cfca41ae4dcd440ecd27f5905
   • If you wish to customise your ckEditor installation, you may use the ckEditor builder starting with the default Camino configuration http://ckeditor.com/builder/68fa6e0cfca41ae4dcd440ecd27f5905
3. Extract (decompress) the downloaded file to the original editor directory (~/app/components/ckEditor/ckEditor)
4. Copy configuration files from backup to the new ckEditor directory. These include
   1. config.js
   2. styles.js
5. Copy the cmsLink directory from the ckEditor backup plugins directory to new ckEditor's plugins directory
   • If this plugin is not copied across, then ckEditor will not work.
6. Delete the samples directory from the new ckEditor directory. This directory is not required for Camino.
7. Open contents.css in new ckEditor and add the following entry at the bottom:
   • cmsa {color:#60a522;text-decoration:underline;}

Testing

You may test ckEditor without creating any new content or endangering any existing content. To be able to perform any tests you will require access to the Camino CMS Administrator.

ckEditor Loading

1. Log into Camino CMS Administrator
2. Go to Pages > Add Page
3. If ckEditor is properly installed and configured, it will appear. If it doesn't then there is an error.

Test Internal Linking

An internal link is a link to any Camino content item. This may be another page, blog post or market product. To test links:

1. Enter some test
2. Select the text and then click on the blue globe in the editor toolbar
3. Select a content item from the drop down menu
4. Click on OK
5. If the selected text is now green and underlined, internal linking is working.

Image Browser / WebFileManager Integration

1. Click on the image icon in the toolbar
2. In the Image Properties dialog, click on Browse Server
3. Another dialog should open containing a web base file browser. If it does, then Image Browser functionality is working correctly.