Installing plugins to the editor for rich text fields

Important: The ‘Paste from Word’ functionality in CKEditor is no longer supported using the built-in button. The ‘Paste from Word’ functionality is only available using keyboard shortcuts ctrl/cmd + v.

The editor for rich text fields in Xperience 13 is implemented using CKEditor version 4.22.1.

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

Important: Xperience 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 Xperience administration interface.

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

Copy the plugin’s main directory into the CMS\CMSAdminControls\CKeditor\plugins folder of your Xperience project.
Edit the config.js file in the CMS\CMSAdminControls\CKeditor folder.
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 Xperience implementation. You need to directly add plugins to the config.plugins value instead.
- Notice the comma at the start of the config.plugins value.
If the plugin uses additional buttons on the editor toolbar, you need to add them to the toolbar sets defined in config.js.
- See Personalizing the editor for rich text fields.
- The button names that you need to add to the toolbar definitions usually match the plugin’s config.plugin value and folder name.
Add any additional config.js configuration settings required by the plugin.
Check the plugin’s dependencies and install any required plugins or components.
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 Xperience (each user must clear their own browser’s cache).