You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/add-ons/rte.md
+20-46Lines changed: 20 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,9 @@
11
11
12
12
[TOC]
13
13
14
-
ExpressionEngine's built-in Rich Text Editor (RTE) is a fieldtype that can be used for entry editing in the Control Panel as well as frontend Channel Forms. It is offering [CKEditor 5](https://ckeditor.com/ckeditor-5/) and [Redactor](https://imperavi.com/redactor/) as editing engine.
14
+
ExpressionEngine's built-in Rich Text Editor (RTE) is a fieldtype that can be used for entry editing in the Control Panel as well as frontend Channel Forms. It is offering [CKEditor 5](https://ckeditor.com/ckeditor-5/) and [RedactorX](https://imperavi.com/redactorx/) as editing engine.
15
+
16
+
Additionally, [Redactor 3](https://imperavi.com/redactor/) is available as a legacy option, but it is not recommended for new projects.
15
17
16
18
NOTE: **Note:** If you're looking for how to use RTE fields in your channel entries loops, you should look at [the RTE field variable usage documentation](fieldtypes/rte.md) in the channel fields documentation.
17
19
@@ -24,14 +26,14 @@ Tool Sets are essentially pre-created configurations that can be used by particu
24
26
Initially RTE installs 4 tool sets:
25
27
-**CKEditor Basic:** is based on CKEditor and has buttons for bold, italic, underline, link, and ordered/unordered lists
26
28
-**CKEditor Full:** offers full set of CKEditor features
27
-
-**Redactor Basic:** is based on Redactor and has buttons for bold, italic, underline, link, and ordered/unordered lists
28
-
-**Redactor Full:** offers full set of Redactor features
29
+
-**RedactorX Basic:** is based on RedactorX and has buttons for bold, italic, underline, link, and ordered/unordered lists
30
+
-**RedactorX Full:** offers full set of RedactorX features
29
31
30
32
### Creating a Tool Set
31
33
32
34
- Click the **Create New** button and the tool set creation form will appear.
33
35
- Enter a tool set name.
34
-
- Select tool set type (CKEditor or Redactor)
36
+
- Select tool set type (CKEditor, RedactorX or Redactor)
35
37
- Select the toolbar buttons and plugins you wish to have in your new tool set (or use the [Advanced Configuration option](#advanced-configuration)).
Rich Text Editor comes with [CKEditor](https://ckeditor.com/) v5 and [Redactor](https://imperavi.com/redactor/) v3 support. Both are great, pick the one that fits your needs best.
54
+
Rich Text Editor comes with [CKEditor](https://ckeditor.com/) v5 and [RedactorX](https://imperavi.com/redactorx/). Both are great, pick the one that fits your needs best. [Redactor 3](https://imperavi.com/redactor/) has been deprecated, but is also available.
53
55
54
56
#### Upload Directory
55
57
@@ -59,43 +61,15 @@ The file management features in RTE field can be allowed to access all upload di
59
61
60
62
Choose between "Left to right" and "Right to left"
61
63
62
-
#### Tool Set Buttons
63
-
64
-
The following are the buttons that can be enabled in tool set to manipulate the data within an RTE field.
65
-
66
-
<ulstyle="columns: 4;">
67
-
<li>HTML (Redactor only)</li>
68
-
<li>Bold</li>
69
-
<li>Italic</li>
70
-
<li>Strikethrough / Deleted</li>
71
-
<li>Underline</li>
72
-
<li>Subscript</li>
73
-
<li>Superscript</li>
74
-
<li>Block quote</li>
75
-
<li>Code</li>
76
-
<li>Heading / Format</li>
77
-
<li>Remove formatting (CKEditor only)</li>
78
-
<li>Style (Redactor only)</li>
79
-
<li>Properties (Redactor only)</li>
80
-
<li>Undo</li>
81
-
<li>Redo</li>
82
-
<li>Numbered list</li>
83
-
<li>Bulleted list</li>
84
-
<li>Decrease indent</li>
85
-
<li>Increase indent</li>
86
-
<li>Link</li>
87
-
<li>Image / File Browser</li>
88
-
<li>Table</li>
89
-
<li>Media / Video</li>
90
-
<li>Embed HTML / Widget</li>
91
-
<li>Align (left / right / center)</li>
92
-
<li>Justify</li>
93
-
<li>Horizontal line</li>
94
-
<li>Special characters</li>
95
-
<li>"Read More" separator</li>
96
-
<li>Font color / background</li>
97
-
<li>Fullscreen (Redactor only)</li>
98
-
</ul>
64
+
#### Customize the Toolbar
65
+
66
+

67
+
68
+
The exact set of buttons that are available is specific to the editor type selected. CKEditor and Redactor have a single toolbar, while RedactorX has multiple toolbars, each configured separately.
69
+
70
+
The buttons / plugins that are enabled are displayed in the order they will appear in the toolbar. You can drag and drop the buttons to change their order.
71
+
72
+
The disabled buttons / plugins are displayed in grey.
99
73
100
74
#### Custom Stylesheet
101
75
CSS template with styles to be applied to fields using this tool set. All styles will be automatically prefixed with toolset class, which means that the template should hold rather generic styles for the elements.
@@ -106,7 +80,7 @@ The minimal height for the field in pixels
106
80
107
81
#### Maximal height
108
82
109
-
The maximum height for the field in pixels (Redactor only).
83
+
The maximum height for the field in pixels (RedactorX / Redactor only).
110
84
111
85
#### Limit characters
112
86
@@ -126,7 +100,7 @@ WARN: **Advanced users only.** Please be careful with using this feature and che
126
100
127
101
Initially the field is loaded with the saved configuration of tool set being edited.
128
102
129
-
Consult [Redactor Docs](https://imperavi.com/redactor/docs/settings/) or [CKEDitor Docs](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/configuration.html) for the list of properties. Note that not all features are supported by the ExpressionEngine implementation.
103
+
Consult [RedactorX Docs](https://imperavi.com/redactorx/docs/settings/), [Redactor Docs](https://imperavi.com/redactor/docs/settings/) or [CKEDitor Docs](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/configuration.html) for the list of properties. Note that not all features are supported by the ExpressionEngine implementation.
130
104
131
105
#### Extra JavaScript
132
106
JavaScript template to be included with fields using this tool set. Typically used to include extra plugins when using advanced configuration with Redactor.
@@ -153,9 +127,9 @@ NOTE: **Note:** If using the [Multiple Site Manager](msm/overview.md), this pref
153
127
154
128
## Custom plugins
155
129
156
-
### Redactor
130
+
### RedactorX
157
131
158
-
When using Redactor, the javascript for the plugin can be placed in the template, which then needs to be selected in "Extra JavaScript" field for the tool set.
132
+
When using RedactorX or Redactor, the javascript for the plugin can be placed in the template, which then needs to be selected in "Extra JavaScript" field for the tool set.
159
133
Then enable extended configuration, add the plugin name to list of plugins and provide plugin config if necessary.
160
134
If the plugin needs extra styling, it can be placed in CSS Templates selected in "Custom Stylesheet" field for the tool set. If the CSS is targeting buttons, the selectors need to be prefixed with `.redactor-toolbar`.
| Rich text editor |`toolset_id`| integer | see Rich Text Editor addon for details, for a standard installation: 1 CKEditor Basic, 2 CKEditor Full, 3 Redactor Basic, 4 Redactor Full |
89
+
| Rich text editor |`toolset_id`| integer | see Rich Text Editor addon for details, for a standard installation: 1 CKEditor Basic, 2 CKEditor Full, 3 RedactorX Basic, 4 RedactorX Full |
90
90
| Rich text editor |`defer`| enum[y,n]| Defer Editor initialization |
91
91
| Rich text editor, Textarea |`db_column_type`| enum[text,mediumtext]| Column type in database: TEXT(64Kb) MEDIUMTEXT(16Mb) |
92
92
| Rich text editor |`field_wide`| bool | default true, full width |
0 commit comments