groups

Available from version	1.29
Necessity	Optional
Data type	`Object[]`
Default value	[]

Description

With this setting you can create your own groups based on the message tags and/or content types.

The following settings are available for each group:

caption

The value "caption" represents the group title. The text ID is defined as the value. If a custom text should be used, a new text must be added. How this is possible is explained under Localization.

Example

CODE

{
	"caption": "CustomGroupTitle",
	"tags": ...,
 	"contentTypes": ...,
  	"cssClass": ...
}

tags

The value "tags" contains all message tags to be displayed in this group.

If the property "tags" as well as "contentTypes" is specified, only the messages are displayed in the corresponding group that have at least one of the specified tags and one of the specified content types.

The following values are possible:

Value	Description
null / not specified	In this group all messages are displayed
["{%all%}"]	In this group all messages are displayed
["{%empty%}"]	In this group all messages without tags are displayed
["{%unused%}"]	In this group all messages that have a tag that does not fit into any other group are displayed
["{%notempty%}"]	In this group all messages that have at least one tag are displayed
[]	In this group all messages are displayed
["tag1"]	In this group all messages that have the tag tag1 are displayed
["tag1", "tag2"]	In this group all messages that have the tag tag1 or tag2 are displayed

Examples

CODE

{
	"caption": ...,
	"tags": null,
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"tags": [],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"tags": ["tag1"],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"tags": ["tag1", "tag2"],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"tags": ["{%all%}"],
	"cssClass": ...
}

contentTypes

The value "contentTypes" contains all message content types to be displayed in this group.

If the property "tags" as well as "contentTypes" is specified, only the messages are displayed in the corresponding group that have at least one of the specified tags and one of the specified content types.

The following values are possible:

Value	Description
null / not specified	In this group all messages are displayed
["{%all%}"]	In this group all messages are displayed
["{%unused%}"]	In this group all messages that have a content type that does not fit into any other group are displayed
[]	In this group all messages are displayed
["default"]	In this group all messages that have the content type Default are displayed
["information"]	In this group all messages that have the content type Information are displayed
["incident"]	In this group all messages that have the content type Incident are displayed
["change"]	In this group all messages that have the content type Change are displayed
["alarm"]	In this group all messages that have the content type Alarm are displayed
["alarm", "incident"]	In this group all messages that have the content type Alarm or Incident are displayed

Examples

CODE

{
	"caption": ...,
	"contentTypes": null,
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"contentTypes": [],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"contentTypes": ["alarm"],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"contentTypes": ["alarm", "incident"],
	"cssClass": ...
}

CODE

{
	"caption": ...,
	"contentTypes": ["{%all%}"],
	"cssClass": ...
}

cssClass

This value is optional.

The "cssClass" value specifies a custom CSS class that can be used to identify a group's entries for changes in the custom-style.css file. Please note that the prefix "remark-tag-" is added to the specified classes for use in CSS.

Example

CODE

{
	"caption": ...,
	"tags": ...,
	"cssClass": "custom-css-class"
}

Example

CODE

"groups": [
	{
		"caption": "GroupTitleMalfunction",
		"tags": ["malfunction"],
		"cssClass": "malfunctions"
	},
	{
		"caption": "GroupTitleApplications",
		"tags": ["application-a", "application-b", "application-c"],
		"cssClass": "application"
	},
	{
		"caption": "GroupTitleAllMessagesWithoutTags",
		"tags": ["{%empty%}"],
		"cssClass": "all-messages-without-tags"
	},
	{
		"caption": "GroupTitleAllOthers",
		"tags": ["{%unused%}"],
		"cssClass": "all-others"
	}
]