Controlling TinyMCE (WYSIWYG) - Documentation topics on: compression,controlling tinymce,gzip,wysiwyg editor,wysiwyg field,.

Controlling TinyMCE (WYSIWYG)

You can control the behavior of the WYSIWYG editor in dotCMS by using the TinyMCE plugin. The plugin allows you to customize some of the default properties of the WYSIWYG editor to modify the look and feel, and define your own css file for the editor.

Note: Plugins are feature additions outside of the dotCMS core code and unless explicitly stated otherwise, are not covered under the dotCMS Enterprise warranty. However, support for plugins is available through our professional services department. Please contact us for more information.


To configure the plugin:

1. Download the TinyMCE plugin.

2. Install the plugin.

  • Unzip the contents of the plugin zip file.
  • Copy the org.dotcms.tinymce_extended directory from the zip file into your dotCMS plugins directory (i.e., plugins/org.dotcms.tinymce_extended).

3. Make sure the value of Enable GZIP is set to false.

4. Edit the file (plugins/org.dotcms.tinymce_extended/conf/ to change the values for any of the following parameters:

reload.forceIndicates whether the configuration properties are loaded just once
WYSIWYG_CSSPath of the css file
WYSIWYG_THEMEChoose between “advanced” or “simple”
WYSIWYG_PLUGINSList of the plugins enabled for the editor
WYSIWYG_BLOCKFORMATSList of block formats available from the editor
WYSIWYG_PASTEUSEDIALOGEnables or disables the dialog box that pops up when pasting content to the editor
WYSIWYG_DATEFORMATDate format used by the editor
WYSIWYG__TIMEFORMATTime format used by the editor
WYSIWYG_WIDTHWidth of the editor area
WYSIWYG_NUMBER_THEME_BUTTONNumber of rows where buttons can be arranged
WYSIWYG_THEME_BUTTON1Buttons to appear on row #1
WYSIWYG_THEME_BUTTON2Buttons to appear on row #2
WYSIWYG_THEME_BUTTON3Buttons to appear on row #3

5. Deploy the plugin.

6. Start dotCMS

Your WYSIWYG editor will now display using the options you set.


On some systems you may encounter an error similar to the following when trying to edit content in the WYSIWYG editor:

Unable to initialize WYSIWYG tinymce is not defined

This error occurs when compression of web pages is enabled in your application server.

Note: The Tomcat distribution that ships with dotCMS does not have compression enabled. You will only encounter this error if you add compression to the dotCMS Tomcat distribution or install dotCMS in an another application server which has compression enabled.


To solve the problem, disable compression on your application server. For example, to disable compression in Tomcat:

  1. Edit the Tomcat server.xml file (conf/server.xml in the Tomcat directory).
  2. Change the value of the compression property in the <Connector> tag to off, similar to the following:
    <Connector port="8080" protocol="HTTP/1.1"
           redirectPort="8443" URIEncoding="UTF-8"
           noCompressionUserAgents="gozilla, traviata"