Defining rich text options

You can configure IBM® Web Content Manager to use either the standard rich text editor, an advanced rich text editor, or a third-party rich text editor in rich text fields.

About this task

There are three options available when configuring the default rich text editor for your authoring portlet:

Default
Select this option to use the default JavaScript editor. This does not require a working Java runtime environment on the client computer.
Advanced
Select this option to use the Textbox.io editor. Browser pop-up windows must be enabled to use this editor.
Note:

The Ephox EditLive! Java based Rich Text Editor is deprecated as of CF21 and replaced by Textbox.IO.

Textbox.IO supports these browsers:
  • Internet Explorer 10, 11
  • Firefox latest (32)
  • Firefox ESR 31+
  • Chrome latest (37)
  • Safari 6.1+

The Textbox.IO editor service requires server-side configuration. The default configuration is defined in the JVM Settings. Details can be found here if you need to customize this configuration: http://docs.ephox.com/display/IBMWCMTB/Installing+Textbox.io+services+for+IBM+WCM

EditLive! JavaScript Editor
Select this option to use the EditLive! JavaScript editor. This does not require a working Java runtime environment on the client computer. This option is deprecated as of CF21.
EditLive! Java Editor
Select this option to use the EditLive! Java Editor. This requires a working Java runtime environment on the client computer. This option is deprecated as of CF21.
Custom

Selecting Custom allows you to use a third-party rich text editor as your default editor. Before using a compatible third-party rich text editor, you should read the installation and configuration instructions of the third-party rich text editor. These should include instructions for enabling the third-party rich text editor to be used in a Web Content Manager solution.

When configuring a third-party rich text editor, you need to copy a JSP file supplied by the third-party rich text editor. This file is used to launch the third-party rich text editor. You enter the name of this JSP file in the Rich Text Options section of the authoring portlet configuration.

If the third-party rich text editor is not available the standard rich text editor is used.

Storing JSP Files:

JSP files can be located:

  • within the was_profile_root/installedApps/node-name/wcm.ear/ilwwcm.war directory of your server.

    The JSP page is also stored in the client war directory of the local rendering portlet or of the servlet or portlet that calls the JSP, if using the Web Content Manager API. For example, to render a JSP page on a local rendering portlet, you would also need to store a copy of the JSP file under was_profile_root/installedApps/node-name/PA_WCMLocalRendering.ear/ilwwcm-localrende.war

  • within any other web application running on portal. When referencing JSP files in another web application, use the following path: contextPath;jspPath

    For example: /wps/customapplication;/jsp/editor.jsp

What to do next

Rich text editor toolbar configuration options:

Run these configuration tasks to change the configuration of the rich text editor toolbar.

Note: In a clustered environment, these tasks are only run on the primary server.
Using a custom Textbox.io editor toolbar
  1. The Textbox.io editor uses a custom configuration file that is named tbio_config.jsp to set custom parameters for the toolbar. Copy your custom configuration file to wp_profile_root\PortalServer\wcm\shared\app\config\textboxio.
    Note: Sample configurations can be found in PortalServer_root\wcm\prereq.wcm\wcm\config\templates\shared\app\config\textboxio
  2. Open a command prompt.
  3. Run the following command from the wp_profile_root/ConfigEngine directory:
    Windows
    ConfigEngine.bat configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    UNIX
    ./ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    IBM i
    ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    z/OS®
    ./ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    Note: An administrator user name and password is not required if you already specified the portal administrator user name and password with the PortalAdminId and PortalAdminPwd settings in the wkplc.properties file.
  4. Restart the server.
Note: To revert to the default editor toolbar, run the task that is named remove-wcm-ephox-editor-custom-configuration on the primary node only.
Using a custom EditLive! editor toolbar
Note: Ephox EditLive! is a deprecated feature as of CF11 or higher.
  1. The EditLive! editor uses a custom configuration file that is named config.xml.jsp to set custom parameters for the toolbar. Copy your custom configuration file to wp_profile_root\PortalServer\wcm\shared\app\config\ephox.
    Note: Sample configurations can be found in PortalServer_root\wcm\prereq.wcm\wcm\config\templates\shared\app\config\ephox
  2. Open a command prompt.
  3. Run the following command from the wp_profile_root/ConfigEngine directory:
    Windows
    ConfigEngine.bat configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    UNIX
    ./ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    IBM i
    ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    z/OS
    ./ConfigEngine.sh configure-wcm-ephox-editor-custom-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    Note: An administrator user name and password is not required if you already specified the portal administrator user name and password with the PortalAdminId and PortalAdminPwd settings in the wkplc.properties file.
  4. Restart the server.
Note: To revert to the default editor toolbar, run the task that is named remove-wcm-ephox-editor-custom-configuration on the primary node only.
Reverting to the EditLive! editor version 7 toolbar
Note: Ephox EditLive! is a deprecated feature as of CF11 or higher.
  1. Open a command prompt.
  2. Run the following command from the wp_profile_root/ConfigEngine directory:
    Windows
    ConfigEngine.bat configure-wcm-ephox-editor-v7-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    UNIX
    ./ConfigEngine.sh configure-wcm-ephox-editor-v7-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    IBM i
    ConfigEngine.sh configure-wcm-ephox-editor-v7-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    z/OS
    ./ConfigEngine.sh configure-wcm-ephox-editor-v7-configuration -DWasPassword=password -DPortalAdminId=username -DPortalAdminPwd=password
    Note: An administrator user name and password is not required if you already specified the portal administrator user name and password with the PortalAdminId and PortalAdminPwd settings in the wkplc.properties file.
  3. Restart the server.
Note: To revert to the default editor toolbar, run the task that is named remove-wcm-ephox-editor-v7-configuration on the primary node only.
  • Parent topic: Authoring portlet settings