ExpressionEngine® 3 User Guide

Legacy Documentation

You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.

Rich Text Editor Module Control Panel

Control Panel Location: Developer Tools ‣ Add-On Manager ‣ Rich Text Editor

This page allows you to configure ExpressionEngine’s built-in Rich Text Editor (RTE).

General Preferences

Enable the Rich Text Editor

If “Yes”, the Rich Text Editor will be applied to any Channel Fields of the Textarea (Rich Text) fieldtype. If “No”, the field will appear as a normal textarea instead.

Note

If using the Site Manager, this preference is per-site.

Default Tool Sets

Determines which tool set will be shown for any member that has not specifically chosen one in RTE tool set.

Note

If using the Site Manager, this preference is per-site.

Tool Sets

This section allows you to create, edit, enable, disable and delete tool sets. Each tool set listed will be available (unless it is disabled) to all members of your ExpressionEngine installation, even across Site Manager sites.

Creating a Tool Set

  • Click the Create New button and the tool set creation form will appear.
  • Enter a tool set name.
  • Select the tools you wish to have in your new tool set.
  • Click Save Tool Set to save your changes.

Editing a Toolset

  • Click a tool set’s name to open the tool set Editor.
  • Modify the tool set’s name, if desired.
  • Select the tools you wish to have in this tool set.
  • Click Save Tool Set to save your changes.

Enabling and Disabling Tool Sets

To enable or disable a tool set, check the tool set’s checkbox in the tool set table listing. Once one or more tool sets are selected, the bulk action control will appear below the table where you can perform bulk actions on the tool sets. Click the drop down to choose enable or disable and then click Submit.

A disabled tool set will not appear as a choice to members, but can still be referred to by ID. This is useful in combination with the Channel Form’s rte_selector= and rte_toolset_id= parameters, for example.

Deleting a Tool Set

To delete a tool set, check the tool set’s checkbox in the tool set table listing. Once one or more tool sets are selected, the bulk action control will appear below the table where you can perform bulk actions on the tool sets. Click the drop down to choose delete and then click Submit.

Tools

This section lists the Tools that are currently installed and allows you to enable or disable them. Disabled Tools will not appear as part of any Toolset.

See RTE Tools API for information on developing your own Tools.