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.

Sign up for GitHub

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

Update collections.mdx #51

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update collections.mdx #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions docs/eln/collections.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,25 @@ The collection bar is used to organize the Chemotion ELN. Some symbols are defin
| <Btn mixed={[faShareAlt]} color={"secondary"}/> | Your own collections are listed in the collection bar. Collections that you have shared with other researchers (<b>My shared collections</b>) or that have been shared with you (<b>Shared with me</b>) are also listed. Collections can also be created that are permanently accessible by several users (<b>Synchronized collections</b>). |

### Standard Collections All and chemotion-repository.net
Users find the two pre-installed collections <b>All</b> and <b>chemotion.net</b> in their ELN. These are not meant to be removed as they represent an important functionality.
Users find the two pre-installed collections <b>All</b> and <b>chemotion.net</b> in their ELN. They should not be removed as they represent important functionalities.

#### `All`: The All collection
In the <b>All</b> collection, all elements from the other collections and subcollections are gathered. The <b>All</b> collection provides access to all other collections. It is very important if the assignment of an element is accidentally deleted (e.g. <b>remove</b>). The collection <b>All</b> has been created as a security collection so that an element would still be available and able to be re-assigned if it is no longer associated with a certain collection (this should not actually happen).
In the <b>All</b> collection, all elements from the other collections and subcollections are gathered. The <b>All</b> collection also provides access to all other collections. It becomes important if the assignment of an element is accidentally deleted (e.g. <b>remove</b>). The collection <b>All</b> has been created as a security collection so that an accidentally deleted element would still be available and able to be re-assigned if it is no longer associated with a certain collection (this should not actually happen).

:::danger Caution
No action can be performed within the All collection because it is a kind of backup. Please change to your work collections to edit your samples or experiments.
No action can be performed within the All collection because it is a backup. Please change to your work collections to edit your samples or experiments.
:::

:::info
The <b>ALL</b> collection might help with the search for certain information in the ELN as it is the only collection that gathers information from other collections automatically. Hint: use the search function in <b>ALL</b> if you are not sure to which collection your desired entry belongs to.
The <b>ALL</b> collection might help with the search for certain information in the ELN as it is the only collection that gathers information from all other collections automatically. Hint: use the search function in <b>ALL</b> if you are not sure to which collection your desired entry belongs to.
:::

#### `chemotion-repository.net`: The public collection
The <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> collection enables sorting elements for publishing within Chemotion repository.

The collection is pre-installed to make every user aware of the possibility of easily providing their data. The repository can be used to store the data at any time, and these data can be useful to other scientists later on.

The <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> collection should be used when the ELN user wants to make data on samples, reactions or results available to other researchers. Initially, the collection is just a folder that is used for structuring within one's own journal. There is no access to these data from outside. If the journal user is ready to provide their information, then they can share the data from within the <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> collection by re-selecting and confirming their release to the repository. If this release is made within the term of a competition (periods are regularly announced on [chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)), the entries will be registered for the competition.
The <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> collection should be used when the ELN user wants to make data on samples, reactions or results available to other researchers. However, there is no access to these data from outside until the folder is actively shared. Up to that point, the <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> is just a folder that can be used for structuring within one's journal. If the journal user is ready to provide their information, he or she can share the data from within the <b>[chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)</b> collection by re-selecting and confirming their release to the repository. If this release is made within the term of a competition (periods are regularly announced on [chemotion-repository.net](https://www.chemotion-repository.net/home/welcome)), the entries will be registered for the competition.

### Sorting and Organizing
![First](/img/collection_organisation.gif)
Expand All @@ -51,7 +51,7 @@ Creating, sorting, and organizing collections are carried out in collection mana
Without the creation of collections, the use of the Chemotion ELN is not possible! Remember to <Btn mixed={["Update"]} color={"warning"}/>! Without this confirmation, no collection will be generated
:::

Think about a meaningful structuring and create your collections accordingly. You can create as many collections as you want, but the overview of your journal should be in the foreground. As a rule, it makes sense to initially have a collection as your electronic journal, and possibly a second collection e.g. to reproduce your chemical database. Another way to structure your Chemotion ELN is to create sub-collections. Each collection can be organized by creating subcollections which, in turn, can include subcollections. This allows you to create a folder system that is very similar to Windows folder system. Please note: Subcollections are suitable for structuring, but the contents of a subcollection are not available to the collection. This fact must be taken into account in particular when carrying out actions such as <b>Sharing</b>.
Think about a reasonable structure and create your collections accordingly. You can create as many collections as you want, but too many collections might become confusing. As a rule, it makes sense to have one collection as your electronic journal, and possibly a second collection e.g. to reproduce your chemical database. Another way to structure your Chemotion ELN is to create sub-collections. Each collection can be organized by creating subcollections which, in turn, can include subcollections. This allows you to create a folder system that is very similar to Windows folder system. Please note: Subcollections are suitable for structuring, but the contents of a subcollection are not available to the collection. This should be taken into account in particular when carrying out actions such as <b>Sharing</b>.

The creation of a subcollection is done in the same way as the creation of a collection. The collection obtains the function assignment as a subfolder within collection management by manually indenting the folder to the right. Drag & Drop can turn the collection into a subcollection. Again, this change will not take effect until the action is confirmed by <Btn mixed={["Update"]} color={"warning"}/>.

Expand All @@ -67,9 +67,9 @@ Shared collections are collections that can be created by users if they want to

The definition of this access and the associated functions is decided by the user of the ENL (the original owner of the data). A detailed explanation of the functions and possibilities of the <b>Sharing</b> action is given in the page Sharing. Collections shared by the user appear as <b>My shared Collections</b> in the collections bar and can be sorted through collection management. An ELN user who receives information in the form of a shared collection from another ELN user cannot sort that shared collection.

Collections that an Chemotion ELN user has obtained as shared collections from another user are subject to a rights system, which is always defined by the original owner. According to these definitions, the recipient of the shared collection can perform certain actions on it (such as reading and editing).
Collections, an Chemotion ELN user has obtained as shared collections from another user, are subject to a rights system, which is always defined by the original owner. According to these definitions, the recipient of the shared collection can perform certain actions on it (such as reading and editing).

An important feature of the shared collections that the user, whether a creator or a recipient of the shared collection, must be aware of Changes to the shared collection can only be made to existing elements. When new elements are added within the original collection, this is not reflected in the shared collection. Only changes within existing elements are transferred to the shared collection. This is a significant difference from the synchronized collections (see chapter [Synchronized Collections](#synchronized-collections)).
An important feature of the shared collections that the user, whether a creator or a recipient of the shared collection, must be aware of is that changes to the shared collection can only be made to existing elements. When new elements are added within the original collection, this is not reflected in the shared collection. Only changes within existing elements are transferred to the shared collection. This is a significant difference from the synchronized collections (see chapter [Synchronized Collections](#synchronized-collections)).

:::info
In a shared collection, only changes to existing elements are displayed to users. Elements added after sharing to the original collection will not be considered.
Expand All @@ -94,4 +94,4 @@ use the button <Btn mixed={[faPlus, faShareAlt]} color={"primary"}/>to initiate
The successful creation of a synchronized collection can be indicated by the assignment within the management. After the update, a reference is set within the collection bar so that the user can understand which of his collections (with corresponding rights assignment) are directly visible to others.

### Visibility
Own collections are always visible directly in the collection bar. The collections shared by a user are listed separately again in order to increase their visibility and thus transparency. Synchronized collections are directly marked by the icon <Btn mixed={[faShareAlt]} color={"secondary"}/> in the collection bar (see chapter [Synchronized Collections](#synchronized-collections)).
Own collections are always visible directly in the collection bar. The collections shared by a user are listed separately again in order to increase their visibility and thus transparency. Synchronized collections are directly marked by the icon <Btn mixed={[faShareAlt]} color={"secondary"}/> in the collection bar (see chapter [Synchronized Collections](#synchronized-collections)).