Caption and messages

When a user handles an entity, Neos may display to said user messages related to the entity. For example, this can be a message to make the user confirm a deletion. However, default messages can be obscure for the user as generic terms like item are used (Are you sure you want to permanently remove 1 item?).

In order to make messages clearer for the user, a caption can be set on an entity. This caption is then used when a message related to this entity is displayed.

In a similar way, a deletion confirmation message can also be set on an entity. This message is used to replace the standard deletion confirmation message displayed to the user when deleting an item.

Note

The caption and deletion confirmation message set on an entity are inherited on their child entity views and their child UI views. However, they can be overridden on entity views and UI views.
At the end of the day, it is the caption and deletion confirmation message that are set or inherited on the displayed UI view that are used.

The deletion confirmation message can contain tag {ItemsCount} that is replaced at runtime by values number of items being deleted.

Examples

Here are some example showing the confirmation message displayed to the user when deleting one or several Order entities with different captions or deletion confirmation messages.

By default
Caption : undefined
Deletion confirmation message : undefined

Message displayed when deleting one order :
```
Are you sure you want to permanently remove 1 item?
```
Message displayed when deleting three orders :
```
Are you sure you want to permanently remove 3 items?
```
Example 1
Caption : Direct order(s)
Deletion confirmation message : undefined

Message displayed when deleting one order :
```
Are you sure you want to permanently remove 1 direct order(s)?
```
Message displayed when deleting three orders :
```
Are you sure you want to permanently remove 3 direct order(s)?
```
Example 2
Deletion confirmation message : Do you want to delete {ItemsCount} direct order(s)?

Message displayed when deleting one order :
```
Do you want to delete 1 direct order(s)?
```
Message displayed when deleting three orders :
```
Do you want to delete 3 direct order(s)?
```

Table of Contents

Caption and messages

Note

Examples