eg2017 hatch review
authorBill Erickson <berickxx@gmail.com>
Thu, 30 Mar 2017 20:38:33 +0000 (16:38 -0400)
committerBill Erickson <berickxx@gmail.com>
Thu, 30 Mar 2017 20:38:33 +0000 (16:38 -0400)
Signed-off-by: Bill Erickson <berickxx@gmail.com>
hatch-review.adoc

index f7637ea..963cbbf 100644 (file)
 
 image:images/Hatch_Flow_Diagram.png[Hatch Diagram]
 
-== Native Messaging API
-
-Sample print message JSON.
-
-egPrint.print({...}) is translated into:
+== JS Objects and JSON All The Way Down
 
 [source,js]
 ---------------------------------------------------------------------------
@@ -60,18 +56,23 @@ egPrint.print({...}) is translated into:
 == Hatch Install Recap
 
  * Install Java runtime 8 or higher.
- * Install Java code (HatchInstaller.exe)
+ * Install Java & Extension code (HatchInstaller.exe)
  * Register the Chrome extension
 
+https://evergreen-ils.org/documentation/install/INSTALL_Hatch.html[Install Instructions at evergreen-ils.org]
+
 == Installed Hatch Files
 
- * Windows
-  ** C:\Program Files (x86)\Hatch\
-  ** Registry keys point the browser at the 'hatch.bat' executable
+ * Windows Installer:
+  ** Puts Hatch files in C:\Program Files (x86)\Hatch
+  ** Add registry keys telling the browser where the Native Messaging 
+     manifest file can be found.
+  ** Native Messaging manifest tells the browser how to find 'hatch.bat'
  * Linux/Mac
-  ** Hatch Files may live anywhere
-  ** Specially placed org.evergreen_ils.hatch.json links the browser to 
-     the 'hatch.sh' executable
+  ** Hatch files can live anywhere (e.g. Git checkout).
+  ** Native Messaging manifest is placed in a well-known directory.
+  ** Native Messaging manifest tells the browser how to find 'hatch.sh'
+ * hatch.bat & hatch.sh are wrapper scripts that launch Hatch.
 
 == Hatch Settings Files
 
@@ -86,7 +87,6 @@ home directory.
 
 image:images/hatch_data_dir.png[Hatch Data Dir]
 
-
 == chrome://extensions/
 
 image:images/hatch_chrome_ext_install.png[Hatch Extension]