
Quick start
Step 1. Install
- Install Ace via Extras → Installer (overview)
- Clear the MODX cache
- Ensure plugin Ace is active
Step 2. Editor for elements
which_element_editor must be Ace.
Open a snippet, chunk, template, or plugin: the code field becomes Ace with highlighting.
Step 3. Code in resources
Context values of use_editor and which_editor are respected:
| Goal | Settings |
|---|---|
| Ace in content on every resource | use_editor = No. A textarea with class modx-richtext is replaced too |
| Ace only on resources without richtext | use_editor = Yes, which_editor empty or Ace, richtext off |
| TinyMCE / other RTE | use_editor = Yes, which_editor is not Ace, richtext on |
| Plain textarea without Ace | use_editor = Yes, which_editor is not Ace, richtext off |
which_editor = Ace with use_editor on and richtext on does not put Ace on #ta by itself. Details: Integration.
Step 4. Verify
- Open a snippet: PHP highlighting is on
- Press Ctrl+Alt+H: shortcut table
- Type
getrand Tab: getResources template expands (iface.snippetsis set)
Checklist
Next steps
- System settings
- Integration: Tab snippets, Fenom/Twig mime, Ace TV
- Keyboard shortcuts
