add a page for local editable attachment

ComPlat · Feb 22, 2022 · d0efe92 · d0efe92
1 parent 0200b11
commit d0efe92
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 0 deletions.
diff --git a/docs/eln/locally_editable_attachment.mdx b/docs/eln/locally_editable_attachment.mdx
@@ -0,0 +1,40 @@
+---
+id: local_editable_attachment
+slug: local_editable_attachment
+title: Local editable attachment
+---
+
+This feature allows users to be able to edit attachments by using their local application without requiring them to download and upload the attachment.
+
+## Set up Chemotion URL Handler
+
+- Download the Chemotion URL Handler via the link on chemotion navigation bar.![Code Scanner Button](/img/locally_editable_attachment/url_handler_download.png). 
+
+- Unzip the file to a folder.
+
+- Open handle.reg to edit.
+
+- Replace the path D:\\ChemotionUrlHandler\\urlhandler.exe\\ with the actually path you extract the zip file. For example: D:\\urlhandler\\urlhandler.exe\\ ![Edt handler](/img/locally_editable_attachment/edit_registry.png)
+
+- Execute handle.reg. If it shows like the image below, you are successfully registered the url handler. ![Register handler successfully](/img/locally_editable_attachment/registrer_handler_successfully.PNG)
+
+## How to edit attachments locally
+
+- Open attachment dataset in chemotion ELN. ![Register handler successfully](/img/locally_editable_attachment/attachment.PNG)
+
+- Click on the local edit button![Locally edit button](/img/locally_editable_attachment/edit_button.PNG)
+
+- A console app will be open to download the file for you to edit. <b>DO NOT CLOSE</b> this application! ![Register handler successfully](/img/locally_editable_attachment/downloading_file.PNG)
+
+- When finish editing the attachment, save the file with exactly the same name and extension. The console application will automatically upload the attachment to the ELN server. Then you can press any key to exit the application.
+ ![finished](/img/locally_editable_attachment/finished.PNG)
+
+## View all attachment versions
+
+You can view all versions of an attachment.
+
+- Open attachment dataset in chemotion ELN. ![Register handler successfully](/img/locally_editable_attachment/attachment.PNG)
+
+- Click on view version![View version](/img/locally_editable_attachment/view_version.PNG)
+
+- The versioning modal will appear. You can view and download all the versions of the attachment![Versioning](/img/locally_editable_attachment/Versioning.PNG)
diff --git a/sidebars.js b/sidebars.js
@@ -80,6 +80,7 @@ module.exports = {
           'eln/ketcher',
           'eln/barcodes',
           'eln/inventory',
+          'eln/local_editable_attachment',
           'eln/analysis',
           'eln/generic_segment',
           'eln/generic_element',

diff --git a/static/img/locally_editable_attachment/Versioning.PNG b/static/img/locally_editable_attachment/Versioning.PNG
diff --git a/static/img/locally_editable_attachment/attachment.PNG b/static/img/locally_editable_attachment/attachment.PNG
diff --git a/static/img/locally_editable_attachment/downloading_file.PNG b/static/img/locally_editable_attachment/downloading_file.PNG
diff --git a/static/img/locally_editable_attachment/edit_button.PNG b/static/img/locally_editable_attachment/edit_button.PNG
diff --git a/static/img/locally_editable_attachment/edit_registry.PNG b/static/img/locally_editable_attachment/edit_registry.PNG
diff --git a/static/img/locally_editable_attachment/finished.PNG b/static/img/locally_editable_attachment/finished.PNG
diff --git a/static/img/locally_editable_attachment/registrer_handler_successfully.PNG b/static/img/locally_editable_attachment/registrer_handler_successfully.PNG
diff --git a/static/img/locally_editable_attachment/url_handler_download.png b/static/img/locally_editable_attachment/url_handler_download.png
diff --git a/static/img/locally_editable_attachment/view_version.PNG b/static/img/locally_editable_attachment/view_version.PNG