This documentation is for a legacy version of the TinyMCE add-on when it was included in the Optimizely Content Management System (CMS) package. The documentation for the latest [TinyMCE editor](🔗).
Optimizely Content Management System (CMS) supports TinyMCE editor version 3.5.11. See the [TinyMCE website](🔗) for information on how to create the client-side code of a TinyMCE plug-in.
This section describes how to configure the style sheet files used with the TinyMCE editor, and how to use the Optimizely attributes to define the TinyMCE editor’s styles and the handling of element-specific classes. It also covers how to add your own plug-ins, and tips for using TinyMCE on your template page. It also describes how to customize the TinyMCE editor (v1) through code, see [Property settings for TinyMCE (Legacy)](🔗).
## Configure the TinyMCE editor CSS files
Editor CSS styles let website editors select predefined formatting options from the styles drop-down toolbar of the TinyMCE editor. This ensures consistent formatting of content throughout the website.
To configure the CSS files that the TinyMCE editor loads and uses, use the methods described below. You can define an editor style sheet that applies to all instances of the TinyMCE editor (XHTML string property), or you can define property-specific settings. These override the corresponding _web.config_ settings.
### uiEditorCssPaths setting
If no page property specifies alternate style sheets, TinyMCE uses the `
uiEditorCssPaths` setting, which contains the path to the editor style sheet. You can set this in the _web.config_ file, or from the admin view > **Config** tab > **System Settings** screen.
### Content CSS Path setting in the TinyMCE editor
Custom and global settings are essentially the same, except you can reuse global settings for several XHTML properties. After you define a global settings set, it is available in the Use global settings drop-down for all XHTML string properties.
To change the Content CSS Path setting, do the following:
Log in and go to **CMS **>** Admin.**
Select the **Content Type** tab.
Select the page type that contains the desired XHTML string property.
Select the property's name, and then the **Custom Settings** tab.
Edit the XHTML string property to create a global settings set that contains the desired CSS path value. This will become available in the drop-down for global settings.
Or, select **Use custom settings** and set the Content CSS Path value.
### Standard page property
Name the property UIEditorCssPaths and assign a comma-separated list of paths to the style sheets. The following examples shows a comma-separated css-path list:
## Optimizely attributes to extend the CSS file
To define the TinyMCE editor’s styles and handling of element-specific classes, use the following Optimizely attributes.
ChangeElementType` – Lets you apply a class and change the element type for text block elements (p, h1, h2, and so on).
You should only apply element-specific classes (such as p.myClass) to elements of the correct type. For example, if you apply `
p.myClass` to an h1 element, nothing happens.
EditMenuTitle` – Adds a new drop-down menu heading.
EditMenuName` – Adds menu items under the parent heading.
Note that the Styles tool shows styles in the order you define them in the CSS file. Also, in `
EditMenuName` and `
EditMenuTitle` values, replace spaces with underscores.
The following example shows CSS menu attributes and the resulting drop-down menu.
## Localize a styles menu
Follow these steps to localize the `
EditMenuName` and `
EditMenuTitle` attribute values.
In the _lang_ folder, add the translations to an XML file.
At _language\_root/editorstyleoptions_, create a new element.
Add translation strings as children of the new element. The following example shows the XML code and resulting drop-down menu when an editor selects the Swedish style sheet.
## Add a TinyMCE plug-in
The following steps show how to add your own plug-ins to the TinyMCE editor.
You have the following options of adding plugin files to CMS:
Add a physical folder structure from site root: _/Util/Editor/tinymce/plugins_. Place plug-in files there.
The name of the plug-in folder you create should match the name of the plug-in added to TinyMCE `
Add another virtual path pointing to either _~/Util/ folder_ or directly to _~/Util/Editor/tinymce/plugins_, as shown in the following XML example.
If you add a virtual path, remember that the last VPP added is the first one called when the system looks for files. So, you should add your new VPP in the beginning of all VPPs.
### Step 2: Create an empty class with TinyMCEPlugIn attribute
CMS plug-ins have an empty class with the attribute, so you must create a new class when you create a new plug-in. The following plug-in attributes (with examples) contain data that Optimizely CMS needs to correctly show the plug-in in edit view and admin view. If a plug-in has one or more buttons, use `
TinyMCEPluginButton`; if not, use `
**TinyMCEPlugin propertiesTinyMCEPluginNonVisual **
**The <tinymce> section of a language XML file contains the plug-ins for the CMS. The LanguagePath parameter must match this XML path.PlugInName** The name of the TinyMCE plug-in, which must correspond to the plug-in name registered in TinyMCE PluginManager (and sub-folder name in plugins folder).
**LanguagePath** Set this path to the language XML file where the new plug-in was placed. This path gets correct translations of the plug-in in the Plug-in Manager.
**EditorInitConfigurationOptions** A string representing a JSON object with configuration settings to set in the TinyMCE init. You can override init settings but be aware of conflicts between plug-ins. Normally, settings are overridden but configuration settings can merge where several plug-ins alter the same setting. The settings that are merged (if nothing is changed in the configuration file) are **valid\_elements**, **extended\_valid\_elements**, **invalid\_elements**, and **valid\_child\_elements**. To change which settings are merged, add an element called <tinyMCE> in the `
<EPiServer>` section of the configuration file, and set the `
mergedConfigurationProperties` attribute on the element to the elements that are merged, as shown in the following XML.
The following C# code shows how to use `
EditorInitConfigurationOptions` if your plug-in needs to extend the `
img` element with some attributes:
You can find information about plug-in overrides for each page type in admin view. On the **Page Type** tab, click on a page type to check if there is any plug-in conflicts for the type. If there is, a yellow warning message is shown specifying which plug-in that has overridden a specific value. Overriding CMS default configuration options do not cause warning messages.
**DynamicConfigurationOptionsHandler** Specifies a class that implements the `
IDynamicConfigurationOptions` interface, which has only one method: `
IDictionary\<string, object> GetConfigurationOptions()` that creates a list of init options. The following C# code shows how the image editor plug-in uses this functionality.
**GroupName** (TinyMCEPluginButton only)
The group name of the plug-in used in admin view for grouping tools in the inactive buttons area. You can specify your own values, or use one of the following default values:
If you specify your own group, also add translations in the language files as shown in the following XML code:
**ButtonSortIndex** (TinyMCEPluginButton only)
Sort index used when sorting the buttons within a group in the inactive part of the editor admin view.
**ButtonName** (TinyMCEPluginButton only)
**IconClass** (TinyMCEPluginButton only)
The CSS class to use for the plug-in icon. This attribute is for internal use but is useful if you want to map existing CSS classes to other buttons.
**IconUrl** (TinyMCEPluginButton only)
If there is no CSS class to style the button with background image, you can enter an URL to an image that is displayed in admin view. The URL is relative to Util folder.
**AlwaysEnabled** (TinyMCEPluginNonVisual only)
To enable the plug-in, set to true. To disable, disable the plug-in in the Plug-in Manager in admin view.
### Step 3: Handle translations
Organize plug-ins in the `
<plugins>` section with the same name as the plug-in. For example, add elements `
<displayname>` and `
<description>` with descriptive text to provide translations for the plug-in in the CMS Plug-in Manager. If the plug-in has one or more buttons, create a sub-element for each button and, within that, insert the `
<displayname>` and `
<description>` elements, as shown in the following example.
If you have an existing TinyMCE plug-in, naming conventions for the elements are as follows: To also get translations for the editor, add a section under <tinymce> element at same level as <admin> element, as shown in the following example.
Button element with the same name as each button in the plug-in followed by **\_desc**. Admin view uses these to get a translated tooltip for each button.
### Step 4: Test the plug-in
After you add the plug-in, go to a page type in admin view, and click **MainBody** on the page type.
Go to the **Custom settings** tab and select **Use custom settings**. The new plug-in appears under **Inactive tools** or **Plugins without a button**, depending on the type of plug-in you created.
Mouse over the button and look at the tooltip.
Add the plug-in to the `
PropertyXhtmlStringControl` by dragging it to one of the rows under the editor toolbar. Or, if it is a non-button plug-in, select the check box.
Save changes and go to edit mode to test the plug-in.
## Use TinyMCE on your template pages
If you want to use TinyMCE on your template pages, download your own version and place it on your website, because the TinyMCE version shipped with Optimizely has a dependency to the user interface.