HTML fields configuration properties - BloomReach Experience - Open Source CMS

HTML fields configuration properties

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

Formatted text:

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

Rich text:

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

Common configuration properties

These configuration properties are available for both formatted text and rich text fields:

  • ckeditor.config.appended.json (String)

    JSON configuration object for CKEditor whose values will be appended to existing values (see algorithm below).
    Default: <empty string>

  • ckeditor.config.overlayed.json (String)

    JSON configuration object for CKEditor whose values will replace existing values (see algorithm below).
    Default: <empty string>

  • htmlprocessor.id (String)

    ID of the HTML processor service to use, which takes care of HTML cleaning and managing internal links and images. To use no HTML processor, set this property to an empty string or remove it altogether.
    Default: "formatted" for Formatted Text Fields, "richtext" for Rich Text Fields.

    Using no HTML processor at all will disable the management of internal links and images in Rich Text Fields entirely, which may be undesirable. To only disable HTML cleaning for RIch Text fields, use the htmlprocessor.id "no-filter".

Rich text configuration properties

These configuration properties are only available for rich text fields:

  • imagepicker.base.uuid (String)

    UUID of the node to open in the picker by default if no 'last visited' node is available. Use an empty string to disable this feature.
    Default: <empty string>

  • imagepicker.cluster.name (String)

    Path of the picker cluster to use, relative to /hippo:configuration/hippo:frontend/cms.
    Default: cms-pickers/images

  • imagepicker.last.visited.enabled (Boolean)

    Wether to store the last visited node.
    Default: true

  • imagepicker.last.visited.key (String)

    Key to store the last visited node in the image picker dialog under. Use a unique value to remember the last visited node separately from other CKEditor image picker dialogs.
    Default: ckeditor-imagepicker

  • imagepicker.last.visited.nodetypes (multiple String)

    The JCR node type(s) allowed to be stored as last visited node.
    Default: hippostd:gallery

  • imagepicker.preferred.image.variant (String)

    The image variant to select by default in the variant combo box of the image picker.
    Default: hippogallery:original

  • linkpicker.base.uuid (String)

    UUID of the node to open in the picker by default if no 'last visited' node is available. Use an empty string to disable this feature.
    Default: <empty string>

  • linkpicker.cluster.name (String)

    Path of the picker cluster to use, relative to /hippo:configuration/hippo:frontend/cms.
    Default: cms-pickers/documents

  • linkpicker.last.visited.enabled (Boolean)

    Wether to store the last visited node.
    Default: true

  • linkpicker.last.visited.key (String)

    Key to store the last visited node in the link picker dialog under. Use a unique value to remember the last visited node separately from other CKEditor link picker dialogs.
    Default: ckeditor-documentpicker

  • linkpicker.last.visited.nodetypes (multiple String)

    The JCR node type(s) allowed to be stored as last visited node.
    Default: hippostd:folder

  • linkpicker.language.context.aware ( boolean)

    Whether the starting folder of the documentpicker is the folder of the language of the document.
    Default: true

  • linkpicker.open.in.new.window.enabled (Boolean)

    Whether to show to 'open in new window' checkbox in the link picker dialog.
    Default: true

  • included.image.variants (String)

    The (comma separated) JCR node type(s) of image variants to be included in the 'Size' dropdown of the image picker dialog. If empty all image variants will be included.
    Default: empty

  • excluded.image.variants ( String)

    The (comma separated) JCR node type(s) to be excluded from the 'Size' dropdown of the image picker dialog.
    Default: empty

Global and field-specific configuration

Each of the configuration properties described above can be configured globally or for a specific field in a document type only.

Global configuration properties are located in the configuration location of the HTML field type. Changes here will affect all fields of that HTML field type (i.e. all formatted text fields, or all rich text fields).

Field-specific configuration properties can be entered in the field properties UI in the lower-right corner of the document type editor in the CMS. All field-specific properties will be saved in a child node 'cluster.options' of the 'editor:templates' definition of that document type field.

A field-specific property value overrides a global property value

Field-specific configuration properties only affect the HTML field instances for that particular document type field. For example, a field-specific property 'ckeditor.config.overlayed.json' could be used to configure a different toolbar for only the 'myproject:description' field of an 'event' document type.