Installing CKEditor plugins

The editor in Kentico 10 is implemented using CKEditor version 4.5.4.

If you wish to add custom functionality to the editor, you can install CKEditor plugins. Either search for existing plugins at http://ckeditor.com/addons/plugins/all or develop your own plugins.

Important: Kentico does not guarantee compatibility with third-party CKEditor plugins that are not included in the default installation. Some plugins may not work correctly within the Kentico administration interface.

Use the following process to add plugins to the Kentico CKEditor:

  1. Copy the plugin's main directory into the CMS\CMSAdminControls\CKeditor\plugins folder of your Kentico project.
  2. Edit the config.js file in the CMS\CMSAdminControls\CKeditor folder.
  3. Use the following configuration to add plugins. The values added to config.plugins must match the names of the corresponding plugin folders.

    CKEDITOR.editorConfig = function (config) {
    
    	/* Custom plugins */
    	config.plugins += ',codemirror,youtube,templates';
    
    	... 

    Notes:

    • The standard setting for adding CKEditor plugins (config.ExtraPlugins) cannot be used, because it is overridden by the Kentico implementation. You need to directly add plugins to the config.plugins value instead.
    • Notice the comma at the start of the config.plugins value.
  4. If the plugin uses additional buttons on the editor toolbar, you need to add them to the toolbar sets defined in config.js.
  5. Add any additional config.js configuration settings required by the plugin.
  6. Check the plugin's dependencies and install any required plugins or components.
  7. Clear your browser's cache and test the editor functionality in your browser.

The installed plugin should now be available for all users working with the editor in Kentico (each user must clear their own browser's cache).


Was this page helpful?