diff --git a/docs/usage/user-guide/experiments.md b/docs/usage/user-guide/experiments.md index 626228d..4e924dc 100644 --- a/docs/usage/user-guide/experiments.md +++ b/docs/usage/user-guide/experiments.md @@ -10,26 +10,26 @@ title: Experiments Experiment entries are the core of the eLabFTW lab notebook. Select "Experiments" from the menu bar at the top of the page to access the Experiments index.
- eLabFTW experiments menu + eLabFTW experiments menu
eLabFTW experiments menu.
This menu contains several entries for listing Experiments with different Scopes, by Category or accessing Templates, Experiments Categories or Experiments Status.
- eLabFTW experiments menu opened + eLabFTW experiments menu opened
eLabFTW experiments menu opened.
- eLabFTW experiments listing + eLabFTW experiments listing
eLabFTW experiments listing.
You can change the page layout by clicking the **Layout** button on the top right of the experiments list:
- switch layout + switch layout
Change layout button.
@@ -46,7 +46,7 @@ To make the entries appear like this: You can create an Experiment by clicking the `Create` button on the top right of the screen:
- create experiment button + create experiment button
Create an Experiment.
@@ -61,6 +61,13 @@ A modal window appears, allowing you to enter a title and optionally select an e This modal window will select the type of entry (Experiment/Resource and their Templates) depending on which page it was clicked from. You can still change it manually afterwards. ::: +This is the view mode of an experiment with filled-in information. + +
+ view experiment +
View mode of an Experiment.
+
+ ## Editing your first experiment You will then be presented with a new Experiment entry. Experiment entries have two different modes: 'edit' and 'view'. By default, when an Experiment is created it will appear in 'edit' mode (you can see 'mode=edit' in the URL). @@ -81,124 +88,63 @@ An Experiment entry can include many different types of information, such as: The only required information is the title. -All fields are automatically saved upon change. Only the main text needs to be manually saved by clicking the Save button below the Main Text editor. An autosave is triggered 7 seconds after you stopped typing. - -## Archival - -### Archiving an experiment - -Experiments can be archived to keep your workspace organized. To archive an experiment, open the entry and click on the "More options" button on the top-right corner of the toolbar and click "Archive": +All fields are automatically saved upon change. Only the main text needs to be manually saved by clicking the `Save` button below the Main Text editor. An autosave is triggered 7 seconds after you stop typing.
- experiment archive -
Archive an experiment.
+ edit experiment +
Edit mode of an Experiment.
-Once archived, an experiment will no longer appear in the default search results or be included in exported data. - -### Viewing Archived Experiments - -To display archived experiments: - -1. Navigate to the Experiments list. +## Toolbar -2. Click on the Show more filters button: +For both Experiment and Resource entries, the top part of the page displays a toolbar with several available actions, as described below.
- experiments show more filters -
Show more filters.
+ user toolbar +
Main toolbar.
-3. Use the Select state filter and choose Archived. - -Archived experiments will now appear in the list, indicated by a small archive icon. - -### Working with Archived Experiments - -While archived experiments remain viewable, they are read-only. To edit it again, you must first unarchive the experiment. - -You can multiselect experiments to unarchive them in bulk: - -
- experiments multiselect -
Show multiple experiments to perform bulk actions.
-
+1. **Go back**: Get back to the index page. -Alternatively, you can open an individual archived experiment to review its content. If you decide to restore it, click on the "More options" button located at the top-right corner of the toolbar. +2. **Mode**: Switch between "edit" mode and "view" mode. +3. **Duplicate entry**: Create a new entry with the same Title, Tags, text, and links, but with today's date and the Status set as "Running". A pop-up message will ask if you would like to copy the attached files to the duplicated entry. An «I» character is added to the title to indicate that it is a duplicate.
- experiment more options -
More options > unarchive.
+ duplicate modal +
Duplicate modal
-Once unarchived, the experiment will return to the active list and be fully editable again. +4. **Signature**: Add a signature to prove that this entry has been approved by a referenced human. See [Signatures documentation](./misc.md#signatures). -## Deleting an experiment +5. **RFC3161 Timestamping**: See [RFC 3161 Timestamping section](#rfc-3161-timestamping) -Experiments can be deleted when they are no longer relevant. Once deleted, an experiment is removed from the active list and placed in the trash. Deleted experiments are not included in searches or exports. The soft-delete mechanism prevents actual removal of data. - -## Viewing Deleted Experiments - -To list deleted experiments, select Deleted state, similarly to what is described above for Archived entries. - -Deleted experiments will now appear in the list, indicated by a trash bin icon. - -## Working with Deleted Experiments - -Deleted experiments can still be accessed and restored, but they remain read-only until restored. - -You can multiselect deleted experiments to restore them in bulk: +6. **Blockchain timestamping**: See [Blockchain Timestamping section](#blockchain-timestamping) +7. **Export**: Export your entry into different file formats, or to external repositories.
- deleted experiments multiselect -
Select multiple deleted experiments.
+ export dropdown options +
Options for the export of an entry.
-Alternatively, open an individual deleted experiment to review its content. To restore it, click on the "Restore entry" button. +The ELN format is a new file format based on RO-Crate specification. It contains a special file (in JSON-LD) describing the contents of the dataset (one or several Experiments). It is designed and promoted by The ELN Consortium, an association of several ELN vendors that agreed on an interchange format for export/import of datasets. Learn more about it here: [TheELNConsortium on GitHub](https://github.com/TheELNConsortium/). +8. **Pin entry**: Clicking this icon will make this entry appear on top of the list on the main page (pin entry). Use this to easily access frequently used entries.
- experiment restore -
Restore a deleted experiment.
+ example of a pinned experiment +
Example of a pinned experiment in the index page.
-Once restored, the experiment will return to the active list and become editable and exportable again. - -## Toolbar - -For both Experiment and Resource entries, the top part of the page displays a toolbar with several available actions, as described below. - +9. **Lock/unlock entry**: Use this to lock the entry and prevent further editing. Only the user who locked an experiment or an Admin can unlock it.
- user toolbar -
Main toolbar.
+ example of a locked experiment +
Example of a locked experiment.
-1. Go back -Go back to the index page. - -2. Mode -Switch between "edit" mode and "view" mode. - -3. Duplicate entry -Create a new entry with the same Title, Tags, text, and links, but with today's date and the Status set as "Running". A pop-up message will ask if you would like to copy the attached files to the duplicated entry. An «I» character is added to the title to indicate that it is a duplicate. - -4. Add signature -Add a signature to prove that this entry has been approved by a referenced human. See :ref:`Signatures documentation `. - -5. RFC3161 Timestamping - -6. Blockchain timestamping - -7. Export options - -8. Pin entry: -Clicking this icon will make this entry appear on top of the list on the main page (pin entry). Use this to easily access frequently used entries. - -9. Lock/unlock entry: -Use this to lock the entry and prevent further editing. Only an Admin or the user who locked an experiment can unlock it. - -10. Request action: -Request another user to perform an action on a given entry. - +10. **Request action**: Request another user to perform an action on a given entry. +
+ request an action +
Request an action modal.
+
- Archive - Lock - Review @@ -207,121 +153,22 @@ Request another user to perform an action on a given entry. - Unarchive 11. Ellipsis menu - +
+ ellipsis menu options +
Ellipsis menu on the side.
+
- Transfer ownership: For entries you created, you can transfer ownership to a different user - See revisions: View revisions to the main text of the entry - See changelog: View the changelog for the entry +- Hide main text: You can hide the main text section of the entry - Archive/Unarchive: Archiving removes the entry from the default list and adds it to the list of archived entries - Delete entry: Perform a soft-delete of the entry - -## Timestamps - -### RFC 3161 timesstamping - -This is the protocol defined by RFC 3161, here is how it works: - -1. we first generate a JSON export of the entity, containing all the data relevant to that entry -2. we pass it through a cryptographic hash function to get its fingerprint -3. we request a timestamp token from the Time Stamping Authority (TSA) -4. we store the JSON file along with the token in an immutable ZIP archive (visible if you display archived attachments of a timestamped entry) - -A TSA is a trusted timestamping service that will be used to request a token. Several TSA are already configured in eLabFTW: - -- DFN.de (free academic service, default TSA) -- Universign (eIDAS qualified, paid service) -- Digicert (free) -- Sectigo (free) -- GlobalSign (free) -- Custom: you can define your own service if necessary - -When you click this button, a timestamp archive is created. This is a signed, legally binding snapshot of the entry that is stored alongside the attached files in an immutable archive. Timestamping an entry involves generating a full JSON export of the entry and creating a cryptographic hash of that data. This hash is then sent to a trusted third party: the TimeStamping Authority (TSA). - -The TSA acknowledges the existence of the data and sends back a signed token, which serves as proof that the data existed at that specific time. This process follows the RFC 3161 standard for Trusted Timestamping. - -The timestamped data and corresponding token are then saved in the "Attached Files" section of the entry as a zip file. This file is initially in an "Archived" state, meaning it is hidden from view by default. To view archived files, click the "Show Archived" button on the right side of the "Uploaded Files" section in edit mode: - -
- show archived uploads -
Show archived attachments.
-
- -This timestamp archive is immutable and cannot be modified or deleted. - -
- timestamp archive -
The archived ZIP file.
-
- -#### Verifying the timestamp - -To verify locally the validity of the timestamp, you can use `openssl` with a command similar to: - -~~~bash -openssl ts -verify -CAfile /etc/ssl/cert.pem -data /path/to/X-timestamped.json -in /path/to/X-timestamped.asn1 -text -~~~ - -If it was signed with a certificate trusted on your system, it should output "Verification: OK". You can also check the token content directly with: - -~~~bash -openssl ts -reply -in /path/to/X-timestamped.asn1 -text -~~~ - -The output should look like: - -~~~console -Using configuration from /etc/ssl/openssl.cnf -Status info: -Status: Granted. -Status description: Operation Okay -Failure info: unspecified - -TST info: -Version: 1 -Policy OID: 1.3.6.1.4.1.22177.300.22.1 -Hash Algorithm: sha256 -Message data: - 0000 - 5a 58 7b 86 c3 a6 79 27-35 b8 4d 57 bc 5a 7e 80 ZX{...y'5.MW.Z~. - 0010 - 52 89 92 60 0b 8d 03 d4-f2 9e 4a 4c 6d ec 91 a4 R..`......JLm... -Serial number: 0xCDAB07382DF7B1BBE0CC970E93A7625B63F4DB7A -Time stamp: Jul 16 23:07:34 2025 GMT -Accuracy: unspecified -Ordering: no -Nonce: unspecified -TSA: unspecified -Extensions: -~~~ - -The "Time stamp" line gives you the timestamp time. The "Hash Algorithm" and "Message data" should correspond to the digest of the data file (the .json). Compare it with: `openssl dgst -sha256 /path/to/X-timestamped.json` - - -### Blockchain timestamp - -This timestamping method uses the [Bloxberg consortium](https://bloxberg.org) blockchain to timestamp your data. Here is how it works: - -1. we first generate a JSON export of the entity, containing all the data relevant to that entry -2. we pass it through a cryptographic hash function to get its fingerprint -3. we add it to the Ethereum based blockchain -4. we store the JSON file along with a PDF certifying our data in an immutable ZIP archive (visible if you display archived attachments of a timestamped entry) - -7. Export button - -
- export options -
List of available exports.
-
- -The Export menu allows you to save the entry in different file formats. - -The ELN format is a new file format based on RO-Crate specification. It contains a special file (in JSON-LD) describing the contents of the dataset (one or several Experiments). It is designed and promoted by The ELN Consortium, an association of several ELN vendors that agreed on an interchange format for export/import of datasets. Learn more about it here: [TheELNConsortium on GitHub](https://github.com/TheELNConsortium/). - - - ## Date (started on) The date is set to today's date by default. You can edit it as you wish. The effective creation timestamp is stored in the backend database in another (read-only) attribute. ## Custom ID -This attribute (`null` by default) can be set as a number after a Category is selected. Custom ID numbers will then be automatically assigned in an incremental fashion when new Experiments with that Category are created. One can also click the "Get next" button to fetch the next available Custom ID for entries of that Category. The Custom ID is displayed before the title. +This attribute (`null` by default) can be set as a number after a Category is selected. Custom ID numbers will then be automatically assigned in an incremental fashion when new Experiments with that Category are created. One can also click the `Get next` button to fetch the next available Custom ID for entries of that Category. The Custom ID is displayed before the title. ## Title This is the title of the Experiment. A duplicated Experiment will have a «I» character appended to the title upon creation. @@ -341,8 +188,12 @@ These Status options can be modified by an admin via the admin panel. ## Tags Tags allow users to easily group and sort Experiment entries. You can think of them as folders, but they are more powerful because each Experiment can have many different Tags. The Tag system thus enables efficient cross-searching. -You can list all Experiments with a given Tag by clicking on the Tag or searching for it in the Tag search bar. To add a Tag to an Experiment entry, type the name of the tag in the Tag input field and press Enter or click anywhere outside the input field. You can add an unlimited number of Tags. Click on an existing Tag to launch a prompt that will allow you to remove it (in edit mode). Tags are common to each team. Autocompletion favors the reuse of existing Tags. +You can list all Experiments with a given Tag by clicking on the Tag or searching for it in the Tag search bar. To add a Tag to an Experiment entry, type the name of the tag in the Tag input field and press `Enter` or click anywhere outside the input field. You can add an unlimited number of Tags. Click on an existing Tag to launch a prompt that will allow you to remove it (in edit mode). Tags are common to each team. Autocompletion favors the reuse of existing Tags. +
+ tags +
Adding Tags to an experiment.
+
## Permissions The "Visibility" and "Can write" menus allow you to control who can access and change a given entry. @@ -355,7 +206,7 @@ The "Visibility" and "Can write" menus allow you to control who can access and c Click the `Plus` icon to view, add, or remove permissions. A modal window will open:
- permissions edit + permissions edit modal
Permissions edition modal window.
@@ -378,7 +229,17 @@ After clicking the "eye" icon for preview: ### Inserting an image -To insert an image into the main text, simply drag and drop it into the text editor. You can also insert an uploaded image by clicking on the ellipsis menu on the file icon in the "Attached Files" section (three vertical dots on top right) and selecting "Insert in the text at cursor position". +To insert an image into the main text, simply drag and drop it into the text editor. There is also an icon in the toolbar to open the file browser and select your file. +
+ tinymce add an image +
Image icon in the text editor toolbar.
+
+ +You can also insert an uploaded image by clicking on the ellipsis menu on the file icon in the "Attached Files" section (three vertical dots on top right) and selecting `Insert in the text at cursor position`. +
+ uploads section insert image +
Insert Image at cursor position in the text editor.
+
### Inserting templates @@ -387,8 +248,13 @@ From the Insert menu in the text editor, you can select "Insert template" to imp ### Using Markdown
- markdown editor -
Markdown editor.
+ how to switch editor +
Switch to the markdown editor.
+
+ +
+ markdown editor preview +
Preview mode of Markdown editor.
You can also use Markdown to create the main text. You can switch to Markdown by clicking the "Switch editor" button at the bottom right of the main text box. If you'd like Markdown to be the default option, go to Settings and select "Disable the rich text editor and write Markdown directly". @@ -428,32 +294,38 @@ For a list of text shortcuts see this link: https://www.tiny.cloud/docs/tinymce/ Examples: -- ctrl+shift+d : add date/time at cursor -- ctrl+= : subscript -- ctrl+shift+= : superscript +- `ctrl`+`shift`+`d` : add date/time at cursor +- `ctrl`+`=` : subscript +- `ctrl`+`shift`+`=` : superscript ### Steps You can use steps to list actions that need to be taken in connection with a given Experiment or Resource. When a task has been completed, you can click on the corresponding checkbox to indicate that that step is done. The "Next step" for each Experiment or Resource will be shown on the main Experiments or Resources page (index list) under the title for that entry. This lets you easily view the next step for each entry. You can also view the next steps for your Experiments and Resources by clicking on the "To-Do List" icon at the top left side of the main page.
- steps on experiment + steps on experiment
Steps on an experiment.
-You can also add steps when creating a template, and choose to lock them. When a new Experiment or Resource is created from that template, the locked steps will appear as read-only and cannot be modified or deleted. +You can also add steps when creating a template, and choose to lock them.
- steps on template + steps on template
Steps on a template with lock toggle.
+When a new Experiment or Resource is created from that template, the locked steps will appear as read-only and cannot be modified or deleted. +
+ steps locked down in an experiment +
Locked-down steps when an experiment is created from a template.
+
+ ## Spreadsheet Editor With version 5.3 comes a new spreadsheet editor, present in the edit page of an entry. It lets users display and manipulate tabular data directly inside eLabFTW, with support for common spreadsheet operations and formula calculations (e.g. CSV / XLSX import-export, cell arithmetic, SUM, ROW, etc.).
- spreadsheet editor + spreadsheet editor
Editing tabular data within eLabFTW.
@@ -502,29 +374,32 @@ The number of links is unlimited. In the Main text, type `#` and begin typing the title of the entry you want to link. After three characters, an autocompletion list will appear. Select the desired entry and press Enter. This entry will automatically be added to the Linked Experiments/Resources section and inserted in the text editor as a hyperlink to the linked entry. In the Linked Experiments/Resources section, type the title of the entry you wish to link in the appropriate section. Like in the text editor, an autocompletion list will appear. Select the desired entry and press Enter. This entry will automatically be added to the Linked Experiments/Resources section. +
+ link to experiment in text editor +
Adding a link to an experiment from the text editor.
+
The linked Experiments/Resources section can be used to view the Resources or Experiments that are linked to a given entry. For example, you can view all the Experiments that use a particular Resource by looking at the Linked Experiments section in the entry for that Resource. You can also use this feature to organize entries by project, sort of like a folder. For example, you can create a Resource entry for a given project and link all the Experiments and Resources that are associated with that project. -Next to the possibility to preview the content of a linked entry (1) and to delete a link (4), in edit mode, there are two actions to import content from a linked entry: +In Edit mode, besides **previewing linked-entry content (1)** and **deleting a link (4)**, you can use two actions to import content from a linked entry:
- link actions -
Import links.
+ link actions +
Import links different actions.
-Import Links (2) - Links to entries that are present inside a linked entry are copied into the current entry. - For example, let's say there is an experiment (Time travel) that requires certain reagents (banana peel and beer) and devices (flux capacitor and Mr. Fusion) which are explained in more detail in the corresponding resource entries. The resources are linked to the experiment. Unfortunately, the experiment does not work the first time, so there is need for a second iteration (Time travel II). Time travel II gets a link to Time travel and now all the required reagents and devices can be imported easily by clicking the "Import Links" button. +**Import Links (2)**: Copy links from a linked entry into the current entry. + +For example, let's say there is an experiment "Time travel" that requires certain reagents (banana peel and beer) and devices (flux capacitor and Mr. Fusion) which are explained in more detail in the corresponding resource entries. The resources are linked to the experiment. Unfortunately, the experiment does not work the first time, so there is need for a second iteration "Time travel II". Time travel II gets a link to Time travel and now all the required reagents and devices can be imported easily by clicking the "Import Links" button. -Import Body (3) - The text body of a linked entry is copied into the current entry at the cursor position. +**Import Body (3)**: The text body of a linked entry is copied into the current entry at the cursor position. ## Attach a file
- user file uploader + user file uploader
File uploader.
@@ -532,11 +407,10 @@ Click this region to open the file browser, or drag and drop a file to this regi Various file types are recognized by eLabFTW: -* molecule files such as cif, pdb, sdf, and mol files: The resulting icon will display the molecule in 2D or 3D -* DNA files such as FASTA, gb, ape, dna, and gff: These will be displayed via a fully featured viewer -* image files such as png, jpg, gif, and tiff: These will show as a thumbnail icon -* pdf files: These are shown as thumbnail icons and can optionally be included in pdf exports - +* molecule files such as `cif`, `pdb`, `sdf`, and `mol` files: The resulting icon will display the molecule in 2D or 3D +* DNA files such as `FASTA`, `gb`, `ape`, `dna`, and `gff`: These will be displayed via a fully featured viewer +* image files such as `png`, `jpg`, `gif`, and `tiff`: These will show as a thumbnail icon +* `pdf` files: These are shown as thumbnail icons and can optionally be included in pdf exports ## Saving your changes @@ -546,6 +420,178 @@ Changes made to any other field are saved automatically, or saved when you click ## elabid In the bottom right part of the Experiment, you can see something like: «Unique elabid: 20150526-e72646c3ecf59b4f72147a52707629150bca0f91». This number is unique to each Experiment, and immutable (won't ever change). You can use it to reference an Experiment with an external database. +
+ elabid +
eLab ID.
+
## Comments People can leave comments on Experiments or Resources. Not everyone can edit your Experiment, but they can leave a comment if they have read access. The owner of the entry along with any other user part of the discussion will receive a notification if someone leaves a comment. + +## Timestamps + +### RFC 3161 Timestamping + +This is the protocol defined by RFC 3161, here is how it works: + +1. we first generate a JSON export of the entity, containing all the data relevant to that entry +2. we pass it through a cryptographic hash function to get its fingerprint +3. we request a timestamp token from the Time Stamping Authority (TSA) +4. we store the JSON file along with the token in an immutable ZIP archive (visible if you display archived attachments of a timestamped entry) + +A TSA is a trusted timestamping service that will be used to request a token. Several TSAs are already configured in eLabFTW: + +- DFN.de (free academic service, default TSA) +- Universign (eIDAS qualified, paid service) +- Digicert (free) +- Sectigo (free) +- GlobalSign (free) +- Custom: you can define your own service if necessary + +When you click this button, a timestamp archive is created. This is a signed, legally binding snapshot of the entry that is stored alongside the attached files in an immutable archive. Timestamping an entry involves generating a full JSON export of the entry and creating a cryptographic hash of that data. This hash is then sent to a trusted third party: the TimeStamping Authority (TSA). + +The TSA acknowledges the existence of the data and sends back a signed token, which serves as proof that the data existed at that specific time. This process follows the RFC 3161 standard for Trusted Timestamping. + +The timestamped data and corresponding token are then saved in the "Attached Files" section of the entry as a zip file. This file is initially in an "Archived" state, meaning it is hidden from view by default. To view archived files, click the `Show Archived` button on the right side of the "Uploaded Files" section in edit mode: + +
+ show archived uploads +
Show archived attachments.
+
+ +This timestamp archive is immutable and cannot be modified or deleted. + +
+ timestamp archive +
The archived ZIP file.
+
+ +#### Verifying the timestamp + +To verify locally the validity of the timestamp, you can use `openssl` with a command similar to: + +~~~bash +openssl ts -verify -CAfile /etc/ssl/cert.pem -data /path/to/X-timestamped.json -in /path/to/X-timestamped.asn1 -text +~~~ + +If it was signed with a certificate trusted on your system, it should output "Verification: OK". You can also check the token content directly with: + +~~~bash +openssl ts -reply -in /path/to/X-timestamped.asn1 -text +~~~ + +The output should look like: + +~~~console +Using configuration from /etc/ssl/openssl.cnf +Status info: +Status: Granted. +Status description: Operation Okay +Failure info: unspecified + +TST info: +Version: 1 +Policy OID: 1.3.6.1.4.1.22177.300.22.1 +Hash Algorithm: sha256 +Message data: + 0000 - 5a 58 7b 86 c3 a6 79 27-35 b8 4d 57 bc 5a 7e 80 ZX{...y'5.MW.Z~. + 0010 - 52 89 92 60 0b 8d 03 d4-f2 9e 4a 4c 6d ec 91 a4 R..`......JLm... +Serial number: 0xCDAB07382DF7B1BBE0CC970E93A7625B63F4DB7A +Time stamp: Jul 16 23:07:34 2025 GMT +Accuracy: unspecified +Ordering: no +Nonce: unspecified +TSA: unspecified +Extensions: +~~~ + +The "Time stamp" line gives you the timestamp time. The "Hash Algorithm" and "Message data" should correspond to the digest of the data file (the .json). Compare it with: `openssl dgst -sha256 /path/to/X-timestamped.json` + + +### Blockchain Timestamping + +This timestamping method uses the [Bloxberg consortium](https://bloxberg.org) blockchain to timestamp your data. Here is how it works: + +1. we first generate a JSON export of the entity, containing all the data relevant to that entry +2. we pass it through a cryptographic hash function to get its fingerprint +3. we add it to the Ethereum-based blockchain +4. we store the JSON file along with a PDF certifying our data in an immutable ZIP archive (visible if you display archived attachments of a timestamped entry) + +## Archival + +### Archiving an experiment + +Experiments can be archived to keep your workspace organized. To archive an experiment, open the entry, click the `More options` button in the top-right corner of the toolbar, then click `Archive`: +
+ experiment archive +
Archive an experiment.
+
+ +Once archived, an experiment will no longer appear in the default search results or be included in exported data. + +### Viewing Archived Experiments + +To display archived experiments: + +1. Navigate to the Experiments list. + +2. Click on the Show more filters button: + +
+ experiments show more filters +
Show more filters.
+
+ +3. Use the Select state filter and choose Archived. + +Archived experiments will now appear in the list, indicated by a small archive icon. + +### Working with Archived Experiments + +While archived experiments remain viewable, they are read-only. To edit it again, you must first unarchive the experiment. + +You can multiselect experiments to unarchive them in bulk: + +
+ experiments multiselect +
Show multiple experiments to perform bulk actions.
+
+ +Alternatively, you can open an individual archived experiment to review its content. If you decide to restore it, click on the "More options" button located at the top-right corner of the toolbar. + +
+ experiment more options +
More options > unarchive.
+
+ +Once unarchived, the experiment will return to the active list and be fully editable again. + +## Deleting an experiment + +Experiments can be deleted when they are no longer relevant. Once deleted, an experiment is removed from the active list and placed in the trash. Deleted experiments are not included in searches or exports. The soft-delete mechanism prevents actual removal of data. + +## Viewing Deleted Experiments + +To list deleted experiments, select Deleted state, similarly to what is described above for Archived entries. + +Deleted experiments will now appear in the list, indicated by a trash bin icon. + +## Working with Deleted Experiments + +Deleted experiments can still be accessed and restored, but they remain read-only until restored. + +You can multiselect deleted experiments to restore them in bulk: + +
+ deleted experiments multiselect +
Select multiple deleted experiments.
+
+ +Alternatively, open an individual deleted experiment to review its content. To restore it, click on the "Restore entry" button. + +
+ experiment restore +
Restore a deleted experiment.
+
+ +Once restored, the experiment will return to the active list and become editable and exportable again. diff --git a/docs/usage/user-guide/intro.md b/docs/usage/user-guide/intro.md index 818d70a..0cc6710 100644 --- a/docs/usage/user-guide/intro.md +++ b/docs/usage/user-guide/intro.md @@ -23,7 +23,7 @@ Both Resources and Experiments can have Templates, Tags and links, along with a An important aspect of the software, is that entries can be shared between users, user groups and teams. If many entries are visible to you, it might get overwhelming. You can select what is listed by using the **Scope button** or selecting the corresponding entry from the menu.
- scope button + scope button
Use this button to change scope.
diff --git a/static/img/archived-experiment-more-options.png b/static/img/archived-experiment-more-options.png deleted file mode 100644 index d9d687c..0000000 Binary files a/static/img/archived-experiment-more-options.png and /dev/null differ diff --git a/static/img/archived-experiment-more-options.webp b/static/img/archived-experiment-more-options.webp new file mode 100644 index 0000000..a3aaff2 Binary files /dev/null and b/static/img/archived-experiment-more-options.webp differ diff --git a/static/img/archived-experiments-multiselect.png b/static/img/archived-experiments-multiselect.png deleted file mode 100644 index 940d47c..0000000 Binary files a/static/img/archived-experiments-multiselect.png and /dev/null differ diff --git a/static/img/archived-experiments-multiselect.webp b/static/img/archived-experiments-multiselect.webp new file mode 100644 index 0000000..db9d2b1 Binary files /dev/null and b/static/img/archived-experiments-multiselect.webp differ diff --git a/static/img/deleted-experiment-multiselect.png b/static/img/deleted-experiment-multiselect.png deleted file mode 100644 index d891ffa..0000000 Binary files a/static/img/deleted-experiment-multiselect.png and /dev/null differ diff --git a/static/img/deleted-experiment-multiselect.webp b/static/img/deleted-experiment-multiselect.webp new file mode 100644 index 0000000..bae42bf Binary files /dev/null and b/static/img/deleted-experiment-multiselect.webp differ diff --git a/static/img/deleted-experiment-restore-entry.png b/static/img/deleted-experiment-restore-entry.png deleted file mode 100644 index dcfa6f6..0000000 Binary files a/static/img/deleted-experiment-restore-entry.png and /dev/null differ diff --git a/static/img/deleted-experiment-restore-entry.webp b/static/img/deleted-experiment-restore-entry.webp new file mode 100644 index 0000000..00996fb Binary files /dev/null and b/static/img/deleted-experiment-restore-entry.webp differ diff --git a/static/img/experiment-duplicate-modal.webp b/static/img/experiment-duplicate-modal.webp new file mode 100644 index 0000000..6baaf92 Binary files /dev/null and b/static/img/experiment-duplicate-modal.webp differ diff --git a/static/img/experiment-edit.webp b/static/img/experiment-edit.webp new file mode 100644 index 0000000..3779d75 Binary files /dev/null and b/static/img/experiment-edit.webp differ diff --git a/static/img/experiment-elabid.webp b/static/img/experiment-elabid.webp new file mode 100644 index 0000000..c7a4864 Binary files /dev/null and b/static/img/experiment-elabid.webp differ diff --git a/static/img/experiment-ellipsis.webp b/static/img/experiment-ellipsis.webp new file mode 100644 index 0000000..1ac1948 Binary files /dev/null and b/static/img/experiment-ellipsis.webp differ diff --git a/static/img/experiment-insert-image.webp b/static/img/experiment-insert-image.webp new file mode 100644 index 0000000..fbfc0d1 Binary files /dev/null and b/static/img/experiment-insert-image.webp differ diff --git a/static/img/experiment-link.gif b/static/img/experiment-link.gif new file mode 100644 index 0000000..1c10e91 Binary files /dev/null and b/static/img/experiment-link.gif differ diff --git a/static/img/experiment-locked.webp b/static/img/experiment-locked.webp new file mode 100644 index 0000000..194fc44 Binary files /dev/null and b/static/img/experiment-locked.webp differ diff --git a/static/img/experiment-pinned.webp b/static/img/experiment-pinned.webp new file mode 100644 index 0000000..42b2fe7 Binary files /dev/null and b/static/img/experiment-pinned.webp differ diff --git a/static/img/experiment-request-action.webp b/static/img/experiment-request-action.webp new file mode 100644 index 0000000..d49832c Binary files /dev/null and b/static/img/experiment-request-action.webp differ diff --git a/static/img/experiment-tags.webp b/static/img/experiment-tags.webp new file mode 100644 index 0000000..92b06a6 Binary files /dev/null and b/static/img/experiment-tags.webp differ diff --git a/static/img/experiment-tinymce-add-image.webp b/static/img/experiment-tinymce-add-image.webp new file mode 100644 index 0000000..3016ded Binary files /dev/null and b/static/img/experiment-tinymce-add-image.webp differ diff --git a/static/img/experiment-view-toolbar.webp b/static/img/experiment-view-toolbar.webp new file mode 100644 index 0000000..fe7adcb Binary files /dev/null and b/static/img/experiment-view-toolbar.webp differ diff --git a/static/img/experiment-view.webp b/static/img/experiment-view.webp new file mode 100644 index 0000000..dd8aa1d Binary files /dev/null and b/static/img/experiment-view.webp differ diff --git a/static/img/experiments-archive.png b/static/img/experiments-archive.png deleted file mode 100644 index 88bb637..0000000 Binary files a/static/img/experiments-archive.png and /dev/null differ diff --git a/static/img/experiments-archive.webp b/static/img/experiments-archive.webp new file mode 100644 index 0000000..2f3e13e Binary files /dev/null and b/static/img/experiments-archive.webp differ diff --git a/static/img/export-button.webp b/static/img/export-button.webp new file mode 100644 index 0000000..0ee25e8 Binary files /dev/null and b/static/img/export-button.webp differ diff --git a/static/img/markdown-editor.webp b/static/img/markdown-editor.webp new file mode 100644 index 0000000..4c9ea28 Binary files /dev/null and b/static/img/markdown-editor.webp differ diff --git a/static/img/markdown-switch-editor.webp b/static/img/markdown-switch-editor.webp new file mode 100644 index 0000000..173c970 Binary files /dev/null and b/static/img/markdown-switch-editor.webp differ diff --git a/static/img/show-archived-uploads.png b/static/img/show-archived-uploads.png deleted file mode 100644 index 42f66cd..0000000 Binary files a/static/img/show-archived-uploads.png and /dev/null differ diff --git a/static/img/show-archived-uploads.webp b/static/img/show-archived-uploads.webp new file mode 100644 index 0000000..66dcebf Binary files /dev/null and b/static/img/show-archived-uploads.webp differ diff --git a/static/img/spreadsheet-editor.png b/static/img/spreadsheet-editor.png deleted file mode 100644 index 3777c58..0000000 Binary files a/static/img/spreadsheet-editor.png and /dev/null differ diff --git a/static/img/steps-locked-down.webp b/static/img/steps-locked-down.webp new file mode 100644 index 0000000..6932063 Binary files /dev/null and b/static/img/steps-locked-down.webp differ diff --git a/static/img/steps-on-experiment.png b/static/img/steps-on-experiment.png deleted file mode 100644 index 7659498..0000000 Binary files a/static/img/steps-on-experiment.png and /dev/null differ diff --git a/static/img/steps-on-experiment.webp b/static/img/steps-on-experiment.webp index eabf499..ff1ce35 100644 Binary files a/static/img/steps-on-experiment.webp and b/static/img/steps-on-experiment.webp differ diff --git a/static/img/steps-on-template-locked.webp b/static/img/steps-on-template-locked.webp new file mode 100644 index 0000000..bde9420 Binary files /dev/null and b/static/img/steps-on-template-locked.webp differ diff --git a/static/img/steps-on-template.png b/static/img/steps-on-template.png deleted file mode 100644 index b36967e..0000000 Binary files a/static/img/steps-on-template.png and /dev/null differ diff --git a/static/img/steps-on-template.webp b/static/img/steps-on-template.webp deleted file mode 100644 index cc4f3e5..0000000 Binary files a/static/img/steps-on-template.webp and /dev/null differ diff --git a/static/img/user-create-experiment.png b/static/img/user-create-experiment.png deleted file mode 100644 index 6479e22..0000000 Binary files a/static/img/user-create-experiment.png and /dev/null differ diff --git a/static/img/user-create-experiment.webp b/static/img/user-create-experiment.webp new file mode 100644 index 0000000..661c2eb Binary files /dev/null and b/static/img/user-create-experiment.webp differ diff --git a/static/img/user-experiments-menu-opened.png b/static/img/user-experiments-menu-opened.png deleted file mode 100644 index b114034..0000000 Binary files a/static/img/user-experiments-menu-opened.png and /dev/null differ diff --git a/static/img/user-experiments-menu-opened.webp b/static/img/user-experiments-menu-opened.webp new file mode 100644 index 0000000..0f7e702 Binary files /dev/null and b/static/img/user-experiments-menu-opened.webp differ diff --git a/static/img/user-experiments-menu.png b/static/img/user-experiments-menu.png deleted file mode 100644 index 07b09e1..0000000 Binary files a/static/img/user-experiments-menu.png and /dev/null differ diff --git a/static/img/user-experiments-menu.webp b/static/img/user-experiments-menu.webp new file mode 100644 index 0000000..dbe33dc Binary files /dev/null and b/static/img/user-experiments-menu.webp differ diff --git a/static/img/user-file-uploader.png b/static/img/user-file-uploader.png deleted file mode 100644 index 4a7cea6..0000000 Binary files a/static/img/user-file-uploader.png and /dev/null differ diff --git a/static/img/user-file-uploader.webp b/static/img/user-file-uploader.webp new file mode 100644 index 0000000..d9e1946 Binary files /dev/null and b/static/img/user-file-uploader.webp differ diff --git a/static/img/user-linked-entries-actions.webp b/static/img/user-linked-entries-actions.webp new file mode 100644 index 0000000..b5cc3dd Binary files /dev/null and b/static/img/user-linked-entries-actions.webp differ diff --git a/static/img/user-linked-entries-tools.png b/static/img/user-linked-entries-tools.png deleted file mode 100644 index 24c3f3d..0000000 Binary files a/static/img/user-linked-entries-tools.png and /dev/null differ diff --git a/static/img/user-permissions-edit.webp b/static/img/user-permissions-edit.webp deleted file mode 100644 index 8e27d71..0000000 Binary files a/static/img/user-permissions-edit.webp and /dev/null differ diff --git a/static/img/user-permissions-modal.webp b/static/img/user-permissions-modal.webp new file mode 100644 index 0000000..85f33bb Binary files /dev/null and b/static/img/user-permissions-modal.webp differ diff --git a/static/img/user-scope-button.png b/static/img/user-scope-button.png deleted file mode 100644 index 8fe0829..0000000 Binary files a/static/img/user-scope-button.png and /dev/null differ diff --git a/static/img/user-scope-button.webp b/static/img/user-scope-button.webp new file mode 100644 index 0000000..2d06fe4 Binary files /dev/null and b/static/img/user-scope-button.webp differ diff --git a/static/img/user-show-mode.png b/static/img/user-show-mode.png deleted file mode 100644 index f161496..0000000 Binary files a/static/img/user-show-mode.png and /dev/null differ diff --git a/static/img/user-show-mode.webp b/static/img/user-show-mode.webp new file mode 100644 index 0000000..11df959 Binary files /dev/null and b/static/img/user-show-mode.webp differ diff --git a/static/img/user-switch-layout.png b/static/img/user-switch-layout.png deleted file mode 100644 index 7a37b2f..0000000 Binary files a/static/img/user-switch-layout.png and /dev/null differ diff --git a/static/img/user-switch-layout.webp b/static/img/user-switch-layout.webp new file mode 100644 index 0000000..82ab854 Binary files /dev/null and b/static/img/user-switch-layout.webp differ diff --git a/static/img/user-tinymce.webp b/static/img/user-tinymce.webp index 398eaf5..6425cc7 100644 Binary files a/static/img/user-tinymce.webp and b/static/img/user-tinymce.webp differ