feat: Ketcher2 Common Templates, User Templates, Ketcher Settings (#360)

* Ketcher2 features: common templates, user templates, ketcher settings * typos * reorganized folder structure * ketcher 2 config details added to eln/configurations * fix configuration file - to remove reference to developer script - also capitalized name of Ketcher --------- Co-authored-by: Shashank S. Harivyasi <[email protected]>
ComPlat · Oct 23, 2024 · 8ad12d8 · 8ad12d8
1 parent 95dfd9e
commit 8ad12d8
Show file tree

Hide file tree

Showing 10 changed files with 98 additions and 0 deletions.
diff --git a/docs/eln/install_configure/configuration.mdx b/docs/eln/install_configure/configuration.mdx
@@ -235,6 +235,13 @@ production:
       :extSrc: "external file" # file of MarvinJS
 ```
 
+The compatibility table for recommended versions of Ketcher 2 to be used with the ELN is as follows:
+
+| ELN version | Ketcher 2 release |
+| :---------: | :---------------: |
+|   1.10.2    |      2.21.0       |
+|    1.9.3    |      2.18.0       |
+
 4. Restart the ELN.
 
 ### Enable

diff --git a/docs/services/ketcher2/index.mdx b/docs/services/ketcher2/index.mdx
@@ -0,0 +1,28 @@
+---
+title: Ketcher2
+sidebar_position: 4
+---
+
+:::info[Info]
+
+This page is still being edited and reviewed.
+
+:::
+
+## Overview
+
+Ketcher is an open-source web-based chemical structure editor. Ketcher is designed for chemists, laboratory scientists and technicians who draw structures and reactions. Ketcher is completely free and open-source, while also available on a commercial basis. Ketcher Official Documentation is available [here](https://lifescience.opensource.epam.com/ketcher/).
+
+## Features
+
+### Common Templates
+
+Chemotion has made common templates feature available with Ketcher Editor. For more details please checkout [Link](./ketcher2/templates/common).
+
+### User Templates
+
+Chemotion has made user templates feature available with Ketcher Editor. Now, user can make new templates and save them for later use. For more details please checkout [Link](./ketcher2/templates/user).
+
+### Ketcher Editor Settings
+
+Chemotion has now linked Ketcher editor Setting to your chemotion user account. Settings are not limited to a specific machine anymore. For more details please checkout [Link](./ketcher2/settings).
diff --git a/docs/services/ketcher2/settings.mdx b/docs/services/ketcher2/settings.mdx
@@ -0,0 +1,20 @@
+---
+title: Ketcher Editor Settings
+sidebar_position: 3
+---
+
+:::info[Info]
+
+This page is still being edited and reviewed.
+
+:::
+
+# Overview of the Ketcher Editor Settings
+
+Working with your preferred environment has become more easy with Ketcher Editor. Editor settings are now linked with the user account. User can save their setting and it will be available globally on any machine they are working on.
+
+## Demo
+
+![Demo](/img/ketcher/ketcher-settings.gif)
+
+Feel free to change any settings (as show in demo) and see effect on the editor.
diff --git a/docs/services/ketcher2/templates/_category_.yml b/docs/services/ketcher2/templates/_category_.yml
@@ -0,0 +1,5 @@
+position: 5
+label: Templates
+collapsible: true # make the category collapsible
+collapsed: true # keep the category closed by default
+
diff --git a/docs/services/ketcher2/templates/common.mdx b/docs/services/ketcher2/templates/common.mdx
@@ -0,0 +1,22 @@
+---
+title: Common Templates
+sidebar_position: 2
+---
+
+:::info[Info]
+
+This page is still being edited and reviewed.
+
+:::
+
+# Overview of Common Templates
+
+Global/Common templates are available to use with Ketcher2. Common templates is a list of templates made available for all the users to use by System Admin.
+
+![Demo](/img/ketcher/common-templates.gif)
+
+#### To enable Common Templates for specific users:
+
+Login as admin > User Management > Enable Common Templates option for the User (Shown in the image below).
+
+![Demo](/img/ketcher/enable-templates.png)
diff --git a/docs/services/ketcher2/templates/user.mdx b/docs/services/ketcher2/templates/user.mdx
@@ -0,0 +1,16 @@
+---
+title: User Templates
+sidebar_position: 1
+---
+
+:::info[Info]
+
+This page is still being edited and reviewed.
+
+:::
+
+# Overview of User Templates
+
+Ketcher Editor is modified to make user template global. Now, user can make new templates and use them on any machine they login to.
+
+![Demo](/img/ketcher/user-templates.gif)
diff --git a/static/img/ketcher/common-templates.gif b/static/img/ketcher/common-templates.gif
diff --git a/static/img/ketcher/enable-templates.png b/static/img/ketcher/enable-templates.png
diff --git a/static/img/ketcher/ketcher-settings.gif b/static/img/ketcher/ketcher-settings.gif
diff --git a/static/img/ketcher/user-templates.gif b/static/img/ketcher/user-templates.gif