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

add a page for local editable attachment #79

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
55 changes: 55 additions & 0 deletions docs/eln/locally_editable_attachment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
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.
This feature has already been tested with applications like Microsoft Office, ChemDraw and MestreNova(Mnova).

:::danger Caution:
We suggest to use .mnova file extension to work with Mnova instead of .jdx or .dx.
In case you are using Mnova application to edit .jdx or .dx file, when you are saving the changes, you will see the
file extension was change from .jdx or .dx to .mnova . Please correct it, ortherwise your changes will not updated in ELN server.
![Mnova](/img/locally_editable_attachment/Mnova.PNG)
:::

## Set up Chemotion URL Handler

- Download the Chemotion URL Handler via the link on chemotion navigation bar or using this [link](https://github.com/Allenskywalker92/ChemotionURIHandler/tree/main/urlhandler.app.setup/Debug).![Code Scanner Button](/img/locally_editable_attachment/url_handler_download.png).

- Unzip the file to a folder.

- Run Setup.exe and install the url handler.

## 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)

- An application will open. Click start to start the editing process.
![Start](/img/locally_editable_attachment/Start.PNG)

- This application will download the attachment and opend the application to edit it based on the file extension.
<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 click close button 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)
3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ module.exports = {
"eln/import",
"eln/analysis",
"eln/hyperlinks",
"eln/problems"
"eln/problems",
'eln/local_editable_attachment'
]
},
{
Expand Down
Binary file added static/img/locally_editable_attachment/Mnova.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/locally_editable_attachment/start.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.