Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cllde8 patch 8 #283

Merged
merged 5 commits into from
Nov 6, 2023
Merged
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
4 changes: 2 additions & 2 deletions docs/labimotion/guides/designer/components/fields/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The attributes are listed below in the order presented within the user interface
:::


## Attributes
## Field Attributes

### Field Name

Expand All @@ -29,7 +29,7 @@ A message is shown when hovering over the field.

The **Type** of a field refers to the category or format of data that a particular field can store or represent. It defines the nature of the information that can be input or stored within that field.

[Supported types](fields/types/)
:dart: **[Supported types](fields/types/)**

### Has Its Own Line 

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@ title: Types
author: Claire Lin
sidebar_position: 2
---
import DocCardList from '@theme/DocCardList';

The **Type** of a field refers to the category or format of data that a particular field can store or represent. It defines the nature of the information that can be input or stored within that field.

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A **Layer** in LabIMotion denotes a distinct level or stratum within a template.
![Layer properties](/img/labimotion/designer-layers.png)


## Attributes
## Layer Attributes

:::info
The attributes are listed below in the order presented within the user interface.
Expand Down
9 changes: 7 additions & 2 deletions docs/labimotion/guides/designer/datasets/activate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ author: Claire Lin
sidebar_position: 1
---

## Activate and Control.
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faCheck, faBan } from "@fortawesome/free-solid-svg-icons";
import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout';

Once activated, the Datasets function grants end users visibility over the designed dataset, provided they select the corresponding Chemical Methods Ontology. Activation facilitates access to the dataset's content, enabling end users to seamlessly view and interact with it, contingent upon their choice of the relevant ontology.
<SubTitle text="Activate and Control." />
<Reader text="Designer" />

Once activated (<FontAwesomeIcon icon={faCheck} size="lg" style={{ color: 'green' }}/>), the Datasets function grants end users visibility over the designed dataset, provided they select the corresponding Chemical Methods Ontology. Activation facilitates access to the dataset's content, enabling end users to seamlessly view and interact with it, contingent upon their choice of the relevant ontology.
6 changes: 4 additions & 2 deletions docs/labimotion/guides/designer/datasets/template-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ author: Claire Lin
sidebar_position: 4
---

import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout';

## Synchronize the collective contributions templates from the LabIMotion Hub.
<SubTitle text="Synchronize the collective contributions templates from the LabIMotion Hub." />
<Reader text="Designer" />

Mirroring the Element Template Sync. Approach. Refer to [Template Sync](../elements/template-sync).
Just like the Element Template Sync approach, which is highly recommended, please refer to [Elements > Template Sync](../elements/template-sync).
8 changes: 5 additions & 3 deletions docs/labimotion/guides/designer/datasets/template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ author: Claire Lin
sidebar_position: 3
---

import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout';

## Shape Your Interface: Customize, Layer by Layer.
<SubTitle text="Shape Your Interface: Customize, Layer by Layer." />
<Reader text="Designer" />

Mirroring the Element Template Approach. Refer to [Template](../elements/template).
Mirroring the Element Template Approach. Refer to [Elements > Template](../elements/template).

:::caution
Workflow is not currently supported in the latest version of the Segments template.
Workflow is not currently supported in the latest version of the Datasets template.
:::
2 changes: 2 additions & 0 deletions docs/labimotion/guides/designer/elements/template-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout'
<SubTitle text="Synchronize the collective contributions templates from the LabIMotion Hub." />
<Reader text="Designer" />

Effortlessly synchronize templates suitable for your application from the Template Hub, enabling you to harness the collaborative contributions of scientists. This approach is highly recommended.

As a [Designer](../../../design-principles#designer-role), you can sync collective contributed templates from the Template Hub to your instance. This allows users to seamlessly work with the templates and publish their work step-by-step. See [Template Sync. & Publish](../../../template-sync-and-publish).
5 changes: 3 additions & 2 deletions docs/labimotion/guides/designer/segments/activate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ author: Claire Lin
sidebar_position: 2
---

import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faCheck, faBan } from "@fortawesome/free-solid-svg-icons";
import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout';

<SubTitle text="Activate and Control." />
<Reader text="Designer" />

Upon activation, the segment becomes accessible exclusively to the end user. Once the segment is deactivated, it is no longer accessible to the end user.

Similar to the "Activation" feature of Elements, when activated (<FontAwesomeIcon icon={faCheck} size="lg" style={{ color: 'green' }}/>), end users can access the segment. However, when the segment is deactivated (<FontAwesomeIcon icon={faBan} size="lg" style={{ color: 'red' }}/>), end users can no longer access it. Please refer to the [Elements > Activation](../elements/activate).
2 changes: 1 addition & 1 deletion docs/labimotion/guides/designer/segments/template-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout'
<SubTitle text="Synchronize the collective contributions templates from the LabIMotion Hub." />
<Reader text="Designer" />

Mirroring the Element Template Sync approach. Refer to [Template Sync](../elements/template-sync).
Similar to the Element Template Sync approach, which is highly recommended, see the [Elements > Template Sync](../elements/template-sync) section.
2 changes: 1 addition & 1 deletion docs/labimotion/guides/designer/segments/template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { FigCaption, SubTitle, YouTubeFrame, Reader } from '@site/src/js/layout'
<SubTitle text="Shape Your Interface: Customize, Layer by Layer." />
<Reader text="Designer" />

Mirroring the Element Template Approach. Refer to [Template](../elements/template).
Mirroring the Element Template Approach. Refer to [Elements > Template](../elements/template).

:::caution
Workflow is not currently supported in the latest version of the Segments template.
Expand Down
2 changes: 1 addition & 1 deletion docs/labimotion/template-sync-and-publish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Once Designers synchronize templates from the Template Hub, users gain the abili
<img src={require('@site/static/img/labimotion/process-overview.png').default} alt="process overview" />
<FigCaption text="process overview" />

:::caution
:::info
Template fetching is performed by the Designer.
:::

Expand Down