Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/eln/ui/collections/tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ The main idea behind this is for users to be able to define tabs per collection,
- On the Collection Tabs page, a list of all collections of the current user will appear.
![tabs](/img/collection_tabs/tab2.png)

- On clicking edit button of collection, a new modal will open displaying the collection name in the header.
This modal shows all element types in the collection on the left side. For each selected element, you can define which properties are visible or hidden by organizing them into "Visible" and "Hidden" sections on the right side.
![tabs](/img/collection_tabs/edit-collection-modal.png)

- Through drag and drop, the tab segments can be dragged to the visibility list or the hidden view list. Simultaneously the order of tabs for all elements of that collection can be changed in this one window and clicking on the save button ensures the data to be saved for all elements.

<div>
Expand Down Expand Up @@ -59,3 +55,15 @@ The main idea behind this is for users to be able to define tabs per collection,
<source src="/img/collection_tabs/tab-selection.webm" type="video/webm" />
</video>
</div>

### Edit Collection Modal (Version 3.0 and later)
:::info
Feature available in ELN version 3.0 or later
:::

On clicking the edit button of a collection, a new modal will open displaying the collection name in the header.
This modal shows all element types in the collection on the left side. For each selected element, you can define which properties are visible or hidden by organizing them into "Visible" and "Hidden" sections on the right side with help of eye icon.

You can reorder the properties by long pressing on a selected item and dragging it up or down within the "Visible" or "Hidden" sections to rearrange the order according to your preferences.

![tabs](/img/collection_tabs/edit-collection-modal.png)
57 changes: 56 additions & 1 deletion docs/labimotion/user/elements/details.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ sidebar_position: 1
---

import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faArrowUpRightFromSquare } from "@fortawesome/free-solid-svg-icons";
import { faArrowUpRightFromSquare, faCheck, faEdit, faComment, faUpload,faPlus } from "@fortawesome/free-solid-svg-icons";
import {
FigCaption,
YouTubeFrame,
SubTitle,
Reader,
} from "@site/src/js/layout";
import { Btn } from "@site/src/js/btn.js";

<SubTitle text="The detail modal displays the primary content of the element." />
<Reader text="User" />
Expand Down Expand Up @@ -59,6 +60,60 @@ By default, the first layer is expanded. An **Expand/Collapse** button is availa

The Analyses tab enables users to add analyses containing analytical data. In the **Content** field, users can input experimental results and upload experimental datasets. Users can then select the appropriate **Type (Chemical Methods Ontology)** from the provided list. For more details, please refer [Ontology](/docs/eln/ui/ontology). The uploaded files can be converted to spectra format files according to the converter profile.

#### Add Analyses

You can create a new analysis by clicking the <Btn mixed={["+ Add analysis"]} color={"success"}/> button. This opens a new analysis entry where you can:

- Enter experimental results in the **Content** field
- Upload associated data files as datasets using the <Btn mixed={[faPlus]} color={"success"}/> button
- Select the measurement type from the **Type** dropdown menu using the Chemical Methods Ontology
- Add additional information and notes about the analysis

Each analysis can contain multiple datasets (files), allowing you to organize all related data for a particular measurement together.

#### Add to Report

:::info
Feature available in Chemotion ELN version 4.0 or later
:::

The **Add to Report** feature allows you to selectively include analyses in generated reports. Each analysis has a checkbox button <Btn mixed={[faCheck]} color={"primary"}/> in its header that lets you toggle whether that specific analysis should be included when exporting or generating a report. This provides fine-grained control over which analytical results are included in your final documentation.

To add an analysis to a report, simply click the checkbox button in the analysis header. Selected analyses will be marked with a visual indicator and will be included when you generate or export your report.

#### Edit/Order Mode

:::info

Feature available in Chemotion ELN version 4.0 or later

:::

At the top of the analyses tab, you will find two mode buttons: <Btn mixed={[faEdit, "Edit mode"]} color={"primary"}/> and <Btn mixed={["Order mode"]} color={"secondary"}/>. These buttons allow you to switch between two different interaction modes:

- **Edit Mode** (default): Enables editing of analysis properties, adding datasets, and other modifications. Click the <Btn mixed={[faEdit, "Edit mode"]} color={"primary"}/> button to activate this mode.
- **Order Mode**: Activates drag-and-drop functionality for reordering analyses. Click the <Btn mixed={["Order mode"]} color={"secondary"}/> button to enter this mode. In this mode, you can easily rearrange the sequence of analyses by dragging them up or down.

#### Comments on Analyses

:::info

Feature available in Chemotion ELN version 4.0 or later

:::

You can add general comments to your analyses using the comment feature. A comment box can be accessed and toggled by clicking the <Btn mixed={["Add comment"]} color={"primary"}/> button in the analyses section. This allows you to record observations, notes, or additional information about the overall analytical work without needing to add it to individual datasets. Comments are stored and displayed with the analyses group.

#### File Upload for Analyses

:::info

Feature available in Chemotion ELN version 4.0 or later

:::

The **Analyses from upload** feature enables direct uploading of analysis files. You can upload associated data files (such as raw instrumental data, spectra, or other analytical results) by clicking the <Btn mixed={["Analyses from upload"]} color={"success"}/> button. Multiple files can be attached to each analysis, and they are organized as datasets.

### Attachment tab

The Attachment tab allows users to attach additional files/images to this element. If a user uploads images in the Attachment tab, the first image will be shown in the list.
Expand Down
20 changes: 19 additions & 1 deletion docs/services/smartadd/tips-best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,11 @@ Before you click "Download as ZIP", run through this:

**Analyses:**
- [ ] Analysis types categorized correctly
- [ ] Ontology terms selected
- [ ] Ontology terms selected (use recently selected for faster access)
- [ ] All files attached
- [ ] Instrument parameters noted
- [ ] Status updated
- [ ] Analyses reordered to your preferred sequence (drag-and-drop)

### Common Mistakes

Expand All @@ -221,6 +222,23 @@ Watch out for these - they're easy to make:

## Advanced Tips

### Speed Up Ontology Selection with Recently Selected

The **Type (Ontology)** dropdown for analyses (CHMO) and reactions (RXNO) keeps a history of your recent picks:
- Open the dropdown — your last used terms appear at the top under **"-- Recently selected --"**
- Click one to reuse it instantly, without searching the full tree
- Up to 10 terms are remembered per ontology type
- The list persists after page refresh

### Reorder Analyses with Drag-and-Drop

Analyses within a sample can be reordered:
1. Hover over an analysis node, select an analysis
2. Drag it up or down within the same **Analyses** group
3. The order is saved automatically and survives page refresh

Put your primary analyses (e.g. 1H NMR) first so reviewers see the most important data at the top.

### Using the Ketcher Molecular Editor

**Drawing Structures:**
Expand Down
20 changes: 18 additions & 2 deletions docs/services/smartadd/workflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,11 @@ There are multiple ways to build and organize your collection:

#### Method 2: Using Quick Add Buttons
- **Plus Button Next to Reaction**: Click the `+` button next to any reaction node to quickly add samples to that reaction
- **Plus Button Next to Analyses**: Click the `+` button next to any **Analyses** node to quickly add a new analysis. Click it multiple times to add several analyses in a row without reopening a menu.

#### Method 3: Using Context Menu (Right-Click)
Right-click on any node in the tree to open a context menu with options:
- **Edit Name**: Right click and rename the selected item
- **Edit Name**: Right click and rename the selected item (note: the **Analyses** header itself cannot be renamed)
- **Add Sample**: Add a sample (when right-clicking on reaction)
- **Add Analysis**: Add analysis to a sample
- **Add Dataset**: Add dataset to an analysis
Expand Down Expand Up @@ -215,12 +216,27 @@ SmartAdd supports adding multiple samples to a single reaction with:
| Field | Description | Example |
|-------|-------------|---------|
| **Type** | Analysis technique | "NMR" / "IR" / "MS" |
| **Type Ontology** | Standardized classification | Select from dropdown |
| **Type Ontology** | Standardized classification | Select from CHMO or RXNO dropdown |
| **File Attachments** | Associated data files | Spectra, logs, images |
| **Status** | Processing status | "Complete" / "Pending" |
| **Dataset Inclusion** | Include/exclude from export | Control export contents |
| **Description** | Rich text analysis notes | Use Quill editor for formatted notes |

:::tip[Reordering Analyses]
Analyses within a sample can be **reordered by drag-and-drop**:
- Drag any analysis node up or down within the same Analyses group
- The new order is saved automatically and persists after page refresh
- Useful for putting the most relevant analyses at the top
:::

:::tip[Recently Selected Ontology Terms]
The **Type (Ontology)** dropdown (CHMO for analysis type, RXNO for reaction type) remembers your recent selections:
- Previously selected terms appear under **"-- Recently selected --"** at the top of the dropdown
- Saves time when repeatedly using the same analysis types (e.g. 1H NMR, 13C NMR)
- Up to 10 recent terms are stored per ontology type
- Persists across page refreshes
:::

:::tip[Dataset Management & Rich Text]
Advanced features for analysis documentation:
- **Dataset Control**: Use inclusion/exclusion to control what gets exported to Chemotion
Expand Down