Rich Text Editor (RTE) Setup

RTEs are more effective/productive for athors when they are configured properly for the specific type of content the author is managing. A properly effectively configured RTE has the right styles, menu options and so on. Every RTE in the system can have a differnt look and feel, differnt editing/menu options, available styles, components and other configurations. You can also SHARE setups between similar RTEs in your project. This document will help you understand how to configure RTE’s in Crafter Studio

Common Configurations for Effective RTEs

  1. The rich text editor’s width should be set to the same width as the region it is intendd to edit
  2. Site style sheet is imported
  3. Site stles are being applied appropriately to the markup in the RTE. Not that sometimes styles in CSS are so aggressively specified that the RTE cannot pick them up.
  4. Formats and styles are configure to match the part of the site being edited
  5. Toolbar is configured with only what is required for th specific use case (reducing options makes it easier for editors)
  6. If plugins like insert component, insert smart table and so on are enabled the should be fully configured.

What Out-of-the-Box Functionality Does Crafter Studio’s RTE Support?

Our RTE is based on TinyMCE (https://www.tinymce.com/) and can leverage all configurations and plugins designed for the TinyMCE editor. You can find the documentation for these configurations and settings here: https://www.tinymce.com/docs/configure

Crafter Studio Specific Extensions

Attribute Name Description Configure
HTML Code Editor
Adds syntax highligted HTML code editing
to Crafter Studio.
(Replaces out of the box code plugin)
TODO LINK
Channel Selector
Give the user a dropdown of channels.
Changes the RTE size and Style Sheets to
match the given channel.
TODO LINK
Insert Image
Enable the user to insert and image from
1 or more datasources.
(Replaces out of the box image plugin)
TODO LINK
Edit Image
todo

TODO LINK

Insert Linked

CMS Object

Enable user to browse for and insert a
link for an object in
the CMS.
TODO LINK
Insert Component
Enable user to insert full fledged
Crafter component in to RTE.
TODO LINK

Insert HTML

Stub

Enable the user to insert canned markup
in to the RTE. This is useful when a
component is too heavy weight.
TODO LINK
Insert Layout
Allows user to insert markup designed to
act as a layout in to the RTE.
TODO LINK
Insert Smart Table
Allows user to insert table markup that
holds its styles as rows and columns are
added.
TODO LINK

RTE Specific Configurations vs RTE Setups (Shared Configurations)

Todo

EXPLAIN control properties vs leveraging shared configuration

Attaching a RTE in a Form to an RTE Setup

Todo

EXPLAIN

Creating an RTE Setup

Todo

EXPLAIN EXPLAIN XML FILE

Todo

EXPLAIN EXAMPLES!