Content Blocks Configuration
Configuration
The Content Blocks plugin can be added to your project and configured usingEssentials.
Prerequisites:
- Bloomreach Experience Manager project withEssentials.
- At least onedocument type (to add a content blocks field to).
- At least two compound type (to be used as content blocks).
Instructions:
- Using Essentials, add Content Blocks to your project.
- Rebuild and restart your project.
- In Essentials, find Content Blocks under Installed features and choose 'Configure'.
- Select the document type you want to add content block fields to.
- To add a new content blocks field, click theAdd button and enter the following configuration parameters.
- Field name: the name to be displayed above the field in the CMS Document Editor.
- Picker type (links or dropdown): show the UI element to add a content block as links or as dropdown.
- Max Blocks: the maximum number of blocks that can be added to the field (leave empty for no limit).
- Used Compounds: select two or more from the availablecompound types.
- Save changes.
Advanced configuration
Some additional options can be configured through JCR properties using theCMS Console.
These JCR properties are stored on the following node:
/hippo:namespaces/[project_name]/[document_type]/editor:templates/_default_/[content_blocks_field]/cluster.options
For example, for a projectmyproject and a document typecontentdocument with a content blocks fieldblocks the configuration properties are stored on the node:
/hippo:namespaces/myproject/contentdocument/editor:templates/_default_/blocks/cluster.options
Show the Names of the Block Types
Optionally an additional label can be rendered above each content block showing the name of that block's compound type.
To enable this, add a boolean propertyshowCompoundNames with valuetrue to thecluster.options node.
For example:
/hippo:namespaces/myproject/contentdocument/editor:templates/_default_/blocks/cluster.options: showCompoundNames: true
Additional Configuration for the Block Names
As of version 15.5.0, the block names have been made collapsible. Besides that, the following configuration properties have been introduced, applicablein theContent application only, and only ifshowCompoundNames is also set totrue:
/hippo:namespaces/myproject/contentdocument/editor:templates/_default_/blocks/cluster.options: showCompoundNames: true startCollapsed: true showTitles: true titleMapping: ['myproject:mycompound=myproject:title', 'myproject:myothercompound=myproject:summary'] compoundNamesMaxLength: 90
| Property name | Property type | Description |
|---|---|---|
| startCollapsed | Boolean | Specifies whether the blocks of the field start in collapsed mode when a document is opened. |
| showTitles | Boolean | Specifies whether to add a part of the block's content to the block name, for better identification when collapsed. It looks at thetitleMapping to determine what property should be taken as title. |
| titleMapping | multiple String | A mapping between compound type and property name, to determine per block what property should be taken as title if showTitles=true. |
| compoundNamesMaxLength | Long | Maximum length for a block name, with a default of 90. A block name that is too long for the UI can be constructed easily if showTitles=true so then it is truncated and an ellipsis is added. |