Skip to content

Commit 85f3691

Browse files
committed
Redactor docs update
1 parent e612ba7 commit 85f3691

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed
Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
1-
Redactor can be used within MIGX.
1+
Looking to use a rich text editor in your MIGX TV? Look no further than Redactor 3.
22

3-
## Standard Configuration
3+
## Standard configuration set
44

55
[By following the MIGX Backend-Usage tutorial](https://docs.modx.com/current/en/extras/migx/migx.backend-usage), you'll get the default Redactor configuration set inside your form. This is because in the Form Tabs, you've defined `"inputTVtype": "richtext"` - which grabs the default editor in the default configuration.
66

7-
Do not use the "migxredactor" TV type provided by MIGX - that was for Redactor v2.
7+
The inputTVtype `migxredactor` (from v2, shipped with MIGX) also works.
88

9-
## MIGX-specific configuration
9+
## MIGX-specific configuration set
1010

11-
We're investigating adding support for custom configuration sets inside MIGX.
11+
To use a configuration set specific to the MIGX instance, you can use the provided `migxredactor3` (note: the one with the 3 suffix!) input TV type. That accepts a `configs` option to provide the ID of the configuration set to use.
12+
13+
In your form tabs, add two things:
14+
15+
- `"inputTVtype": "migxredactor3"`
16+
- `"configs": id-of-configuration-set`
17+
18+
For example, to use configuration set #12 on a description field, your MIGX form tabs configuration would look something like this:
19+
20+
``` js
21+
[{
22+
"caption": "Info",
23+
"fields": [{
24+
"field": "title",
25+
"caption": "Title"
26+
},{
27+
"field": "description",
28+
"caption": "Description",
29+
"inputTVtype": "migxredactor3",
30+
"configs": 14
31+
}]
32+
}]
33+
```

en/04_Redactor/01_v3.x/Upgrades/From_2.x.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ During the first upgrade to Redactor 3, your v2 system settings will automatical
1010

1111
This imported set will be as close as a match to your old configuration as possible, but keep in mind not every old setting has a new option.
1212

13-
**Your imported set is not automatically enabled.** Navigate to Extras > Redactor Configuration to find it. Open it and make sure it was properly imported and works the way you expect it to.
13+
**Your imported set will be automatically enabled.** Please test it to make sure it was properly imported and works the way you expect it to.
1414

15-
When all looks good, you can enable it from either the configuration sets grid (right click it in the list) or [the system settings](../Usage/Content).
15+
To help ease with upgrading when using custom CSS, the v2 "redactor-editor" class is added to your imported configuration set (in Appearance > Content style class); this will not be present on the standard configuration sets. [Learn more about custom styling in v3](../Features/Custom_CSS)
1616

17-
**Important:** downgrading from 3 to 2 is **not supported**. If you're not sure yet if you want to start using Redactor 3 right away, start by upgrading on a development site and only upgrade production when you're happy.
17+
The JSON structure for custom formatting has changed in v3 and will need to be manually updated.
18+
19+
**Important:** downgrading from 3 to 2 is **not supported**. If you're not sure yet if you want to start using Redactor 3 right away, test the upgrade on a development site and only upgrade production when you're happy.
1820

1921
Old system settings from v2, with a few exceptions, are removed on the first upgrade to v3.
2022

@@ -29,7 +31,7 @@ While the automatic import is useful, we do recommend configuring Redactor 3 fro
2931
Please note this list may be incomplete
3032

3133
- Allowed/denied tags and cleanup in general works differently now. See the Cleanup tab for details of what you can configure in v3.
32-
- The image float margin from v2 has changed. Previously you would set a margin for left and right floats separately, in v3 you set a single margin (in the Media tab) which will automatically be applied to the right side of the image.
34+
- The image float margin from v2 has changed. Previously you would set a margin for left and right floats separately, in v3 you set a single margin (in the Media tab) which will automatically be applied to the proper side of the image.
3335
- Source code highlighting with Ace is no longer supported. Only Codemirror is now available (enabled by default).
3436
- The syntax for some plugins (like Clips) has changed. In most cases these will be automatically converted by the configurator. See the configurator for details.
3537
- Changing the available colors for the fontcolor plugin is no longer supported.

0 commit comments

Comments
 (0)