From a079201f1fa77f218bbbb930902b866bbf9ae971 Mon Sep 17 00:00:00 2001 From: Regina Hinzmann Date: Wed, 8 Jul 2026 11:16:45 +0200 Subject: [PATCH 1/3] introduce Dataset tabs section, add relationship tab description --- docs/frontendconfig/index.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/frontendconfig/index.md b/docs/frontendconfig/index.md index e646284..9f8e2b5 100644 --- a/docs/frontendconfig/index.md +++ b/docs/frontendconfig/index.md @@ -2,24 +2,24 @@ SciCat's frontend configuration is managed in two configuration file, both served through the backend configuration: -1. Frontend Config: [frontend.config.json](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.config.json) defines the setup of the UI componets. For more information on the Frontedend Config definitions see [here](https://www.scicatproject.org/backend/main/frontend-config-guide/frontend-config/) +1. Frontend Config: [frontend.config.json](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.config.json) defines the setup of the UI componets. For latest version of it, see [here](https://www.scicatproject.org/backend/main/frontend-config-guide/frontend-config/) 2. Frontend Theme Config: [frontend.theme.json](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.theme.json) defines the theming (color, font color etc) of the UI components. -The two frontend configs are served through the backend API so that it can be updated with ease. Adding these configs to the frontend would require a build step everytime the configuration file changed. To find out how to add the frontend configuration files to the backend please see [here](../backendconfig/index.md/#central-configuration-of-backend-env) +The two frontend configs are served through the backend API. Adding these configs to the frontend would require a build step everytime the configuration file changed. To find out how to add the frontend configuration files to the backend please see [here](../backendconfig/index.md/#central-configuration-of-backend-env). -# Default List & Filter Configuration Pattern - Frontend Configuration Guide +## Default List & Filter Configuration Pattern - Frontend Configuration Guide -## Overview +### Overview This guide explains how to configure the List & Side-Panel Configuration Pattern used on the frontend. It allows customizing how list-based components (e.g., datasets, proposals) display table columns, side-panel filters, and optional query conditions. The configuration should be defined or mounted at the location specified by the environment variable `FRONTEND_CONFIG_FILE` (default: `src/config/frontend.config.json`). -## Configuration Details +### Configuration Details -### **Columns** +#### **Dataset Columns** Defines how each field is displayed in the list table. @@ -35,7 +35,7 @@ Defines how each field is displayed in the list table. --- -### **Filters** +#### **Filters** Defines which filters appear in the side panel and how they behave. @@ -49,7 +49,7 @@ Defines which filters appear in the side panel and how they behave. --- -### **Conditions** +#### **Conditions** Defines predefined condition filter in the side panel (currently supported only for the dataset table) @@ -62,6 +62,15 @@ Defines predefined condition filter in the side panel (currently supported only | `unit` | `string` | **Optional** unit for the value | `"mbar l/s/cm^2"` | | `unitsOptions`| `string[]`| **Optional** A list of allowed units for this condition. When provided, the unit dropdown will be restricted to only these options | `["mbar l/s/cm^2", "Pa m^3/s/m^2"]` -# Dynamic Dataset Detail Component -The Dynamic Dataset Detail component can be customized to display dataset information in various templates and layouts based on your needs. It is an extra configuration file used in the Frontend Config. For more information on how to set this up please see [here](https://www.scicatproject.org/backend/main/frontend-config-guide/dynamic-dataset-detail-component/) \ No newline at end of file +## Dataset tabs + +Several tabs are possible. + +### Relationships +The extended relationship tab can be handled by this flag [`datasetRelationshipsEnabled`](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.config.json#L14). It now enables also external references, see also [here](../datasets/relationships.md) . + +## Dynamic Dataset Detail Component + +The Dynamic Dataset Detail component can be customized to display dataset information in various templates and layouts based on your needs. It is an extra configuration file used in the Frontend Config. For more information on how to set this up please see [here](https://www.scicatproject.org/backend/main/frontend-config-guide/dynamic-dataset-detail-component/). + From 60bd1fef1227d59eb3c54f3e301632b7aeed3982 Mon Sep 17 00:00:00 2001 From: Regina Hinzmann Date: Wed, 8 Jul 2026 11:17:17 +0200 Subject: [PATCH 2/3] make config flag more prominent --- docs/datasets/relationships.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/datasets/relationships.md b/docs/datasets/relationships.md index 5080e6c..a4fde36 100644 --- a/docs/datasets/relationships.md +++ b/docs/datasets/relationships.md @@ -28,6 +28,7 @@ If enabled, the dataset detail page shows a **Relationships** tab listing all re ![Relationships tab](img/dataset_relationships_tab.png) +## Enabling in the frontend The tab's visibility is controlled by the `datasetRelationshipsEnabled` frontend config key, see the [frontend configuration guide](../frontendconfig/index.md). ## Example usage From 3c260c4ab4db8b6de34e58604a818997d498b896 Mon Sep 17 00:00:00 2001 From: Regina Hinzmann Date: Wed, 8 Jul 2026 11:25:36 +0200 Subject: [PATCH 3/3] fix scilog link, specify link to Dataset tabs --- docs/datasets/relationships.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/datasets/relationships.md b/docs/datasets/relationships.md index a4fde36..2684768 100644 --- a/docs/datasets/relationships.md +++ b/docs/datasets/relationships.md @@ -1,6 +1,6 @@ # Relationships -Datasets can store **relationships** to other entities, either other datasets in the same SciCat catalog or entities outside of it, e.g. a [SciLog](https://scilog.readthedocs.io) logbook entry, a journal article (via DOI) or an arXiv preprint. Previously, relationships could only point to other SciCat datasets; the schema was generalized to support external entities too, see [backend PR](https://github.com/SciCatProject/backend/pull/2661). +Datasets can store **relationships** to other entities, either other datasets in the same SciCat catalog or entities outside of it, e.g. a [SciLog](https://github.com/paulscherrerinstitute/scilog/blob/main/README.md) logbook entry, a journal article (via DOI) or an arXiv preprint. Previously, relationships could only point to other SciCat datasets; the schema was generalized to support external entities too, see [backend PR](https://github.com/SciCatProject/backend/pull/2661). Relationships are displayed on the dataset detail page in a dedicated **Relationships** tab, see [frontend PR](https://github.com/SciCatProject/frontend/pull/2416). @@ -29,7 +29,7 @@ If enabled, the dataset detail page shows a **Relationships** tab listing all re ![Relationships tab](img/dataset_relationships_tab.png) ## Enabling in the frontend -The tab's visibility is controlled by the `datasetRelationshipsEnabled` frontend config key, see the [frontend configuration guide](../frontendconfig/index.md). +The tab's visibility is controlled by the `datasetRelationshipsEnabled` frontend config key, see the [frontend configuration guide](../frontendconfig/index.md#dataset-tabs). ## Example usage