doc: link to the TypeDoc documentation

cheminfo · Dec 9, 2018 · 14e36f6 · 14e36f6
1 parent 4c90d7f
commit 14e36f6
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 67 deletions.
diff --git a/Documentation.md b/Documentation.md
@@ -2,73 +2,24 @@
 
 ## Table of contents
 
-### Classes present in minimal, core and full builds
+### Modules present in minimal, core and full builds
 
-- [Molecule](#molecule)
-- [MolecularFormula](#molecularformula)
-- [Reaction](#reaction)
-- [SDFileParser](#sdfileparser)
-- [SSSearcher](#sssearcher)
-- [SSSearcherWithIndex](#sssearcherwithindex)
-- [Util](#util)
+- [Molecule](/docs/classes/_types_d_.molecule.html)
+- [Reaction](/docs/classes/_types_d_.reaction.html)
+- [SDFileParser](/docs/classes/_types_d_.sdfileparser.html)
+- [SSSearcher](/docs/classes/_types_d_.sssearcher.html)
+- [SSSearcherWithIndex](/docs/classes/_types_d_.sssearcherwithindex.html)
+- [Util](/docs/modules/_types_d_.util.html)
 
-### Classes present in core and full builds
+### Modules present only in core and full builds
 
-- [Molecule Properties](#moleculeproperties)
-- [ToxicityPredictor](#toxicitypredictor)
-- [DruglikenessPredictor](#druglikenesspredictor)
-- [DrugScoreCalculator](#drugscorecalculator)
+- [DruglikenessPredictor](/docs/classes/_types_d_.druglikenesspredictor.html)
+- [DrugScoreCalculator](/docs/modules/_types_d_.drugscorecalculator.html)
+- [Molecule Properties](/docs/classes/_types_d_.moleculeproperties.html)
+- [ToxicityPredictor](/docs/classes/_types_d_.toxicitypredictor.html)
 
-### Classes present in full build
+### Modules present only in full build
 
-- [StructureView](#structureview)
-- [StructureEditor](#structureeditor)
-
----
-
-## StructureEditor
-
-You can test it on line:
-
-- <a href="https://cheminfo.github.io/openchemlib-js/examples/Editor.html" target="_blank">Editor</a>
-- <a href="https://cheminfo.github.io/openchemlib-js/examples/ShowStructures.html" target="_blank">showStructures</a>
-- <a href="https://cheminfo.github.io/openchemlib-js/examples/SVG.html" target="_blank">SVG</a>
-
-### Usage in your page
-
-load this script:
-
-     src="openchemlib-full.js"
-
-create a div with the following attributes:
-
-     id="editor"
-     style="width:100%;height:400px;border:solid;border-width:2px"
-     view-only="false"
-     show-idcode="true"
-     data-idcode="fhvacFGXhDFICDPx@fCHW@@UDhdmdCVZ``J@@@ !BLsicOgDjrHKHwW{@rHJW`lbBrMu~pG{@rHI[E\}bup}"
-
-execute the following JS:
-
-        editorCtrl = window.OCL.StructureEditor.createEditor("editor");
-
-### Attributes (defaults are in UPPERCASE):
-
-     view-only="FALSE" | "true"     = Shows the toolbar
-
-     show-idcode="FALSE" | "true"   = Shows the input control containing the current IDCode
-
-     data-idcode=""                 = This allows you to specify the molecule IDCode in the editor
-
-     is-fragment="FALSE" | "true"   = Sets the editor into fragment (query) mode.
-                                      Please note that the data-icode attribute overrules this behavior:
-                                      If specified, the mode depends on the passed molecule
-
-     show-fragment-indicator= "FALSE" | "true"
-                                    = Shows a "Q" on the right lower if the Molecule is in fragment (query) mode
-
-     ignore-stereo-errors= "FALSE" | "true"
-                                    = If true, then shows no magenta-colored atom/bonds on stereo errors
-
-     no-stereo-text= "FALSE" | "true"
-                                    = If true, does not show stereo information text
+- [StructureEditor](/docs/classes/_types_d_.structureeditor.html)
+- [StructureView](/docs/modules/_types_d_.structureview.html)
+- [SVGRenderer](/docs/modules/_types_d_.svgrenderer.html)
diff --git a/LegacyStructureEditor.md b/LegacyStructureEditor.md
@@ -0,0 +1,46 @@
+# Legacy Structure Editor API
+
+You can test it on line:
+
+- <a href="https://cheminfo.github.io/openchemlib-js/examples/Editor.html" target="_blank">Editor</a>
+- <a href="https://cheminfo.github.io/openchemlib-js/examples/ShowStructures.html" target="_blank">showStructures</a>
+- <a href="https://cheminfo.github.io/openchemlib-js/examples/SVG.html" target="_blank">SVG</a>
+
+## Usage in your page
+
+load this script:
+
+     src="openchemlib-full.js"
+
+create a div with the following attributes:
+
+     id="editor"
+     style="width:100%;height:400px;border:solid;border-width:2px"
+     view-only="false"
+     show-idcode="true"
+     data-idcode="fhvacFGXhDFICDPx@fCHW@@UDhdmdCVZ``J@@@ !BLsicOgDjrHKHwW{@rHJW`lbBrMu~pG{@rHI[E\}bup}"
+
+execute the following JS:
+
+        editorCtrl = window.OCL.StructureEditor.createEditor("editor");
+
+## Attributes (defaults are in UPPERCASE):
+
+     view-only="FALSE" | "true"     = Shows the toolbar
+
+     show-idcode="FALSE" | "true"   = Shows the input control containing the current IDCode
+
+     data-idcode=""                 = This allows you to specify the molecule IDCode in the editor
+
+     is-fragment="FALSE" | "true"   = Sets the editor into fragment (query) mode.
+                                      Please note that the data-icode attribute overrules this behavior:
+                                      If specified, the mode depends on the passed molecule
+
+     show-fragment-indicator= "FALSE" | "true"
+                                    = Shows a "Q" on the right lower if the Molecule is in fragment (query) mode
+
+     ignore-stereo-errors= "FALSE" | "true"
+                                    = If true, then shows no magenta-colored atom/bonds on stereo errors
+
+     no-stereo-text= "FALSE" | "true"
+                                    = If true, does not show stereo information text
diff --git a/full.d.ts b/full.d.ts
@@ -3,7 +3,7 @@ export {
   StructureView,
   StructureEditor,
   SVGRenderer,
-  AtomHightlightCallback,
-  BondHightlightCallback,
+  AtomHighlightCallback,
+  BondHighlightCallback,
   ChangeListenerCallback
 } from './types';