Skip to content

Commit db1ff4e

Browse files
committed
redactorx update
1 parent b8b7005 commit db1ff4e

File tree

3 files changed

+21
-47
lines changed

3 files changed

+21
-47
lines changed

docs/_images/rte-buttons.png

8.37 KB
Loading

docs/add-ons/rte.md

Lines changed: 20 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
[TOC]
1313

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.
1517

1618
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.
1719

@@ -24,14 +26,14 @@ Tool Sets are essentially pre-created configurations that can be used by particu
2426
Initially RTE installs 4 tool sets:
2527
- **CKEditor Basic:** is based on CKEditor and has buttons for bold, italic, underline, link, and ordered/unordered lists
2628
- **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
2931

3032
### Creating a Tool Set
3133

3234
- Click the **Create New** button and the tool set creation form will appear.
3335
- Enter a tool set name.
34-
- Select tool set type (CKEditor or Redactor)
36+
- Select tool set type (CKEditor, RedactorX or Redactor)
3537
- Select the toolbar buttons and plugins you wish to have in your new tool set (or use the [Advanced Configuration option](#advanced-configuration)).
3638
- Click **Save Tool Set** to save your changes.
3739

@@ -49,7 +51,7 @@ Initially RTE installs 4 tool sets:
4951

5052
#### Editor Type
5153

52-
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.
5355

5456
#### Upload Directory
5557

@@ -59,43 +61,15 @@ The file management features in RTE field can be allowed to access all upload di
5961

6062
Choose between "Left to right" and "Right to left"
6163

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-
<ul style="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+
![RTE buttons](_images/rte-buttons.png)
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.
9973

10074
#### Custom Stylesheet
10175
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
10680

10781
#### Maximal height
10882

109-
The maximum height for the field in pixels (Redactor only).
83+
The maximum height for the field in pixels (RedactorX / Redactor only).
11084

11185
#### Limit characters
11286

@@ -126,7 +100,7 @@ WARN: **Advanced users only.** Please be careful with using this feature and che
126100

127101
Initially the field is loaded with the saved configuration of tool set being edited.
128102

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.
130104

131105
#### Extra JavaScript
132106
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
153127

154128
## Custom plugins
155129

156-
### Redactor
130+
### RedactorX
157131

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.
159133
Then enable extended configuration, add the plugin name to list of plugins and provide plugin config if necessary.
160134
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`.
161135

docs/development/models/channel-field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The property `field_settings` consists in an array of settings that depend on th
8686
| relationship | `order_field`, `order_dir` | enum[title,entry_date] , enum[asc,desc] | Default ordering of entries |
8787
| relationship | `display_entry_id` | enum[y,n] | |
8888
| relationship | `allow_multiple` | enum[y,n] | |
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 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 |
9090
| Rich text editor | `defer` | enum[y,n] | Defer Editor initialization |
9191
| Rich text editor, Textarea | `db_column_type` | enum[text,mediumtext]| Column type in database: TEXT(64Kb) MEDIUMTEXT(16Mb) |
9292
| Rich text editor | `field_wide` | bool | default true, full width |

0 commit comments

Comments
 (0)