HTML Fields Configuration Properties

HTML field configuration is stored in the repository. The location depends on the type of HTML field.

• Formatted text fields:

  /hippo:namespaces/system/Html/editor:templates/_default_
  

• Rich text fields:

  /hippo:namespaces/hippostd/html/editor:templates/_default_
  

Common Configuration Properties

The following properties apply to both formatted text and rich text fields:

• ckeditor.config.appended.json (String)
  Appends the specified JSON configuration object to the existing CKEditor configuration.
  Default: empty string

• ckeditor.config.overlayed.json (String)
  Replaces values in the existing CKEditor configuration with those from the specified JSON object.
  Default: empty string

• htmlprocessor.id (String)
  Specifies the HTML processor service to use for HTML cleaning and management of internal links and images.

  • To disable the HTML processor, set this property to an empty string or remove it.
  • Default: "formatted" for formatted text fields, "richtext" for rich text fields.

  Note:
  Disabling the HTML processor removes internal link and image management in rich text fields. To disable only HTML cleaning (while keeping link and image management), set htmlprocessor.id to "no-filter" for rich text fields.

Rich Text Configuration Properties

These properties are available only for rich text fields:

• imagepicker.base.uuid (String)
  UUID of the node to open by default in the image picker if no "last visited" node is available. Use an empty string to disable this feature.
  Default: empty string

• imagepicker.cluster.name (String)
  Path to the picker cluster, relative to /hippo:configuration/hippo:frontend/cms.
  Default: cms-pickers/images

• imagepicker.last.visited.enabled (Boolean)
  Enables storing the last visited node in the image picker.
  Default: true

• imagepicker.last.visited.key (String)
  Key used to store the last visited node in the image picker dialog. Use a unique value to maintain separate histories for different CKEditor image picker dialogs.
  Default: ckeditor-imagepicker

• imagepicker.last.visited.nodetypes (multiple String)
  JCR node types allowed as the last visited node.
  Default: hippostd:gallery

• imagepicker.preferred.image.variant (String)
  Image variant selected by default in the image picker’s variant dropdown.
  Default: hippogallery:original

• linkpicker.base.uuid (String)
  UUID of the node to open by default in the link picker if no "last visited" node is available. Use an empty string to disable this feature.
  Default: empty string

• linkpicker.cluster.name (String)
  Path to the picker cluster, relative to /hippo:configuration/hippo:frontend/cms.
  Default: cms-pickers/documents

• linkpicker.last.visited.enabled (Boolean)
  Enables storing the last visited node in the link picker.
  Default: true

• linkpicker.last.visited.key (String)
  Key used to store the last visited node in the link picker dialog. Use a unique value to maintain separate histories for different CKEditor link picker dialogs.
  Default: ckeditor-documentpicker

• linkpicker.last.visited.nodetypes (multiple String)
  JCR node types allowed as the last visited node.
  Default: hippostd:folder

• linkpicker.language.context.aware (Boolean)
  If enabled, the document picker starts in the folder for the document’s language.
  Default: true

• linkpicker.open.in.new.window.enabled (Boolean)
  If enabled, displays the "open in new window" checkbox in the link picker dialog.
  Default: true

• included.image.variants (String)
  Comma-separated list of JCR node types for image variants to include in the image picker’s "Size" dropdown. If empty, all image variants are included.
  Default: empty

• excluded.image.variants (String)
  Comma-separated list of JCR node types for image variants to exclude from the image picker’s "Size" dropdown.
  Default: empty

Global and Field-Specific Configuration

You can configure each property globally or for a specific field.

• Global configuration:
  Set properties at the configuration location for the HTML field type. This affects all fields of that type (all formatted text fields or all rich text fields).

• Field-specific configuration:
  Set properties in the field properties panel (lower-right corner) in the document type editor in the CMS. These values are stored in a cluster.options child node under the editor:templates definition for that field.

Field-specific property values override global property values. Field-specific configuration only affects HTML field instances for that document type field.

Example:
To configure a custom toolbar for only the myproject:description field of the event document type, set the ckeditor.config.overlayed.json property specifically for that field.