Skip to content

Commit

Permalink
Grammar edits
Browse files Browse the repository at this point in the history
  • Loading branch information
sjkoke committed Dec 19, 2024
1 parent 3de5c58 commit 9ced4c6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
9 changes: 1 addition & 8 deletions doc/sysadmin-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -294,11 +294,4 @@ Before a major release, update the staging instance, optionally asking users if
Restoring deleted entries
=========================

eLabFTW uses a soft-delete mechanism for entries. When an experiment or a resource is deleted, it will still be accessible in the backend database as a deleted entity. To restore an entry, revert it by changing the State to 1.

case Normal = 1;
case Archived = 2;
case Deleted = 3;
case Pending = 4;
case Processing = 5;
case Error = 6;
eLabFTW uses a soft-delete mechanism for entries. When an experiment or a resource is deleted, it will still be accessible in the backend database as a deleted entity. To restore an entry, revert it by changing the State. For more information, see `<https://github.com/elabftw/elabftw/blob/master/src/Enums/State.php>`_
20 changes: 10 additions & 10 deletions doc/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ For both Experiment and Resource entries, the top part of the page displays a to

1. Go back
^^^^^^^^^^
Go back to the main page.
Go back to the index page.

2. Mode
^^^^^^^
Expand All @@ -92,11 +92,11 @@ Create a new entry with the same Title, Tags, text, and links, but with today's

4. Timestamp
^^^^^^^^^^^^
When you click this button, a timestamp archive is created. This is a signed, legally binding snapshot of the Experiment 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).
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 Experiment 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:
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:

.. image:: img/show-archived-uploads.png
:align: center
Expand All @@ -111,7 +111,7 @@ This timestamp archive is immutable and cannot be modified or deleted.

5. Blockchain timestamp
^^^^^^^^^^^^^^^^^^^^^^^
This button will perform the same action as a timestamp, except it will use blockchain technology and the service provided by the BloxBerg consortium. You can learn more about it here: `BloxBerg website <https://bloxberg.org/discover/mission/>`_.
This button will perform the same action as a timestamp, except it will use blockchain technology and the service provided by the Bloxberg consortium. You can learn more about it here: `Bloxberg website <https://bloxberg.org/discover/mission/>`_.

6. Export button
^^^^^^^^^^^^^^^^
Expand All @@ -120,14 +120,14 @@ This button will perform the same action as a timestamp, except it will use bloc
:align: center
:alt: view mode export dropdown

The Export menu allows you to save the entry in different formats.
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/>`_.


7. Pin entry
^^^^^^^^^^^^
Clicking this icon will make this entry appear on top of the list on the main page (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.

8. Lock/unlock entry
^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -247,13 +247,13 @@ Miscellaneous

You can use basic text editor shortcuts and code snippets in the text editor to add highlighting, special characters, horizontal lines, etc...

For a list of text shortcuts see this link: <https://www.tiny.cloud/docs/tinymce/latest/keyboard-shortcuts/>
For a list of text shortcuts see this link: `<https://www.tiny.cloud/docs/tinymce/latest/keyboard-shortcuts/>`_

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
^^^^^
Expand Down

0 comments on commit 9ced4c6

Please sign in to comment.