From 4cc91741528cd69f052d1d0eb003c57d828d335f Mon Sep 17 00:00:00 2001 From: Ekhorn Date: Wed, 22 Jul 2026 13:31:02 +0200 Subject: [PATCH 1/2] Change bold text in sections to headings --- .../020-manager-ui/30-appearance.md | 40 ++++++++++++++----- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/user-guide/020-manager-ui/30-appearance.md b/docs/user-guide/020-manager-ui/30-appearance.md index 3615f2b..0295a02 100644 --- a/docs/user-guide/020-manager-ui/30-appearance.md +++ b/docs/user-guide/020-manager-ui/30-appearance.md @@ -279,7 +279,10 @@ By default Superusers (e.g. the 'admin' user of the master realm) will see these ``` -**Realm configuration:** You can set the branding per realm. In the example below you can see how the page title, headers, colors, and logos are set as default (for any new realm created through the UI), as well as for the 'master' and 'clienta' realms. + +### Realm Configuration + +You can set the branding per realm. In the example below you can see how the page title, headers, colors, and logos are set as default (for any new realm created through the UI), as well as for the 'master' and 'clienta' realms. ```json { "realms": { @@ -316,7 +319,11 @@ By default Superusers (e.g. the 'admin' user of the master realm) will see these This is what the --or-app-colors look like in the demo deployment: ![Default colors in OpenRemote](img/or-app-colors.jpg) -**Assets - tree:** Exclude asset types from the 'Add asset' dialog. +### Assets + +#### Tree + +Exclude asset types from the 'Add asset' dialog. ```json { "pages": { @@ -347,7 +354,9 @@ This is what the --or-app-colors look like in the demo deployment: } } ``` -**Assets - viewer:** Configure which panels are shown on the assets page. You can include or exclude attributes to show per panel. These panels can be set for all asset types, or specified per type. This is an overwrite of the default config of the [asset-viewer](https://github.com/openremote/openremote/blob/master/ui/component/or-asset-viewer/src/index.ts). In `historyConfig` an example is given on how to specify the columns shown in a table for an attribute that is not a number or boolean; if no config is given, it will automatically create columns. +#### Viewer + +Configure which panels are shown on the assets page. You can include or exclude attributes to show per panel. These panels can be set for all asset types, or specified per type. This is an overwrite of the default config of the [asset-viewer](https://github.com/openremote/openremote/blob/master/ui/component/or-asset-viewer/src/index.ts). In `historyConfig` an example is given on how to specify the columns shown in a table for an attribute that is not a number or boolean; if no config is given, it will automatically create columns. ```json { "pages": { @@ -460,7 +469,10 @@ This is what the --or-app-colors look like in the demo deployment: } } ``` -**Rules - Controls:** +### Rules + +#### Controls + Set which types of rules are available (for users with the correct permissions), and which actions a rule can perform. ```json { @@ -485,7 +497,8 @@ Set which types of rules are available (for users with the correct permissions), } } ``` -**Rules - When-Then:** +#### When-Then + Set which asset types are excluded from the list of asset types that can be selected in the When-Then rule. Additionally you can set per asset (or all '*') which attributes should be excluded from the select list. ```json { @@ -513,7 +526,10 @@ Set which asset types are excluded from the list of asset types that can be sele } } ``` -**Map - Card:** +### Map + +#### Card + You can set the attributes to exclude (or include) on the top right card of the map when an asset is selected. This can be done for all asset types (by using default), or per asset type (as shown for WeatherAsset). ```json { @@ -540,7 +556,8 @@ You can set the attributes to exclude (or include) on the top right card of the } } ``` -**Map - Marker config:** +#### Marker Config + This configures how the markers behave. They can either change their colour based on an attribute value (number, boolean, or string), show a label with or without units, and/or show the direction an asset is facing. Note that this part of the config is not yet configured in the manager_config of the manager demo. ```json { @@ -574,7 +591,8 @@ This configures how the markers behave. They can either change their colour base } } ``` -**Map - Clustering config:** +#### Clustering Config + This configures how clustering behaves. Clustering ensures the map page can render assets smoothly even with 40-50 thousand assets. The clustering option can be disabled, or changed to cluster markers in a smaller radius showing more clusters and changed to start clustering at a certain zoom level. Note that reducing cluster radius or cluster max zoom can have performance impacts. The recommended cluster max zoom level is Maximum realm zoom level - 2. ```json { @@ -589,7 +607,8 @@ This configures how clustering behaves. Clustering ensures the map page can rend } } ``` -**Map - Legend config:** +#### Legend Config + This configures what asset types are shown as markers on the map. The legend is enabled by default and can be disabled by setting show to false. ```json { @@ -603,7 +622,8 @@ This configures what asset types are shown as markers on the map. The legend is } ``` -**Map - Preset filters:** +#### Preset Filters + This configures map preset filters, which add a dropdown on the map page to quickly filter the visible assets by type, attribute values, realm, and more using an `AssetQuery`. A live matching-asset count badge is shown per filter option. Options without a `label` will have an auto-derived label based on the type names and attribute values. Selected filters are persisted across page reloads (per user and realm) and reset on each new login session. You can also specify an optional `default` boolean or an array of `realms` to limit where the filter applies. Note that unsupported query fields like `orderBy`, `limit`, and `offset` will result in a warning. ```json { From 4a82e6c0a0253f2ca0fffc74ea14328334487f62 Mon Sep 17 00:00:00 2001 From: Ekhorn Date: Wed, 22 Jul 2026 13:38:53 +0200 Subject: [PATCH 2/2] Add 'configuration' to headings --- .../user-guide/020-manager-ui/30-appearance.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/user-guide/020-manager-ui/30-appearance.md b/docs/user-guide/020-manager-ui/30-appearance.md index 0295a02..7ef3901 100644 --- a/docs/user-guide/020-manager-ui/30-appearance.md +++ b/docs/user-guide/020-manager-ui/30-appearance.md @@ -321,7 +321,7 @@ This is what the --or-app-colors look like in the demo deployment: ### Assets -#### Tree +#### Tree Configuration Exclude asset types from the 'Add asset' dialog. ```json @@ -354,7 +354,7 @@ Exclude asset types from the 'Add asset' dialog. } } ``` -#### Viewer +#### Viewer Configuration Configure which panels are shown on the assets page. You can include or exclude attributes to show per panel. These panels can be set for all asset types, or specified per type. This is an overwrite of the default config of the [asset-viewer](https://github.com/openremote/openremote/blob/master/ui/component/or-asset-viewer/src/index.ts). In `historyConfig` an example is given on how to specify the columns shown in a table for an attribute that is not a number or boolean; if no config is given, it will automatically create columns. ```json @@ -471,7 +471,7 @@ Configure which panels are shown on the assets page. You can include or exclude ``` ### Rules -#### Controls +#### Controls Configuration Set which types of rules are available (for users with the correct permissions), and which actions a rule can perform. ```json @@ -497,7 +497,7 @@ Set which types of rules are available (for users with the correct permissions), } } ``` -#### When-Then +#### When-Then Configuration Set which asset types are excluded from the list of asset types that can be selected in the When-Then rule. Additionally you can set per asset (or all '*') which attributes should be excluded from the select list. ```json @@ -528,7 +528,7 @@ Set which asset types are excluded from the list of asset types that can be sele ``` ### Map -#### Card +#### Card Configuration You can set the attributes to exclude (or include) on the top right card of the map when an asset is selected. This can be done for all asset types (by using default), or per asset type (as shown for WeatherAsset). ```json @@ -556,7 +556,7 @@ You can set the attributes to exclude (or include) on the top right card of the } } ``` -#### Marker Config +#### Marker Configuration This configures how the markers behave. They can either change their colour based on an attribute value (number, boolean, or string), show a label with or without units, and/or show the direction an asset is facing. Note that this part of the config is not yet configured in the manager_config of the manager demo. ```json @@ -591,7 +591,7 @@ This configures how the markers behave. They can either change their colour base } } ``` -#### Clustering Config +#### Clustering Configuration This configures how clustering behaves. Clustering ensures the map page can render assets smoothly even with 40-50 thousand assets. The clustering option can be disabled, or changed to cluster markers in a smaller radius showing more clusters and changed to start clustering at a certain zoom level. Note that reducing cluster radius or cluster max zoom can have performance impacts. The recommended cluster max zoom level is Maximum realm zoom level - 2. ```json @@ -607,7 +607,7 @@ This configures how clustering behaves. Clustering ensures the map page can rend } } ``` -#### Legend Config +#### Legend Configuration This configures what asset types are shown as markers on the map. The legend is enabled by default and can be disabled by setting show to false. ```json @@ -622,7 +622,7 @@ This configures what asset types are shown as markers on the map. The legend is } ``` -#### Preset Filters +#### Preset Filters Configuration This configures map preset filters, which add a dropdown on the map page to quickly filter the visible assets by type, attribute values, realm, and more using an `AssetQuery`. A live matching-asset count badge is shown per filter option. Options without a `label` will have an auto-derived label based on the type names and attribute values. Selected filters are persisted across page reloads (per user and realm) and reset on each new login session. You can also specify an optional `default` boolean or an array of `realms` to limit where the filter applies. Note that unsupported query fields like `orderBy`, `limit`, and `offset` will result in a warning. ```json