From: Bill Erickson <berickxx@gmail.com>
Date: Fri, 3 Mar 2017 22:40:25 +0000 (-0500)
Subject: eg 2017 hatch review doc
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=38ec85567f226cf6c0d923bcfb58841222e37380;p=working%2Frandom.git

eg 2017 hatch review doc

Signed-off-by: Bill Erickson <berickxx@gmail.com>
---

diff --git a/hatch-review.adoc b/hatch-review.adoc
index f335dca28..f8671ebe5 100644
--- a/hatch-review.adoc
+++ b/hatch-review.adoc
@@ -6,7 +6,31 @@
 :backend: slidy
 :max-width: 45em
 
-== Topics
+== Hatch In a Nutshell
+
+"Hatch is the bionic arm of the Evergreen browser client" --Anonymous.
+
+== Hatch Install Recap
+
+ * Install Java runtime 8 or higher.
+ * Install Java code
+ * Install the Chrome extension
+
+== chrome://extensions/
+
+image:images/hatch_chrome_ext.png[Hatch Extension]
+
+== Installed Extension
+
+image:images/hatch_icon.png[Hatch Diagram]
+
+== Hatch Config UI
+
+image:images/hatch_config.png[Hatch Config]
+
+== Hatch Printing UI
+
+image:images/hatch_print_config.png[Hatch Print Config]
 
 == A Quick Word on Rendering Print Templates
 
@@ -25,24 +49,7 @@
 
 https://developer.chrome.com/extensions/nativeMessaging
 
-TODO: screen shot of hatch Icon.
-
-chrome://extensions/
-Background Page
-Reload option
-
-== Native Messaging API
-
-TODO: Make this an image -- see google drawing
-
-One instance of Hatch per browser (not per tab).
-
-Application JavaScript
-    <=> Content Script JavaScript
-        <=> Extension JavaScript
-            <=> STDIO [JSON]
-                <=> Hatch Java 
-                    <=> Printer / FileSystem
+TODO: Extensions running in developer mode can harm your computer...
 
 == Hatch Message Flow
 
@@ -52,7 +59,7 @@ image:images/Hatch_Flow_Diagram.png[Hatch Diagram]
 
 Sample print message JSON.
 
-egCore.print.print({...}) is translated into:
+egPrint.print({...}) is translated into:
 
 [source,js]
 ---------------------------------------------------------------------------
@@ -69,20 +76,26 @@ egCore.print.print({...}) is translated into:
 }
 ---------------------------------------------------------------------------
 
-== Hatch Files
+== Hatch Configuration Files
+
+== Hatch Data Files
 
-Where they live
-How to configure
+[source,js]
+---------------------------------------------------------------------------
+---------------------------------------------------------------------------
+
+== Hatch Settings Files
+
+[source,js]
+---------------------------------------------------------------------------
+---------------------------------------------------------------------------
 
-1. Settings locations / properties
-2. hatch.log
 
 == Alternate Implementations
   Challenges 
   * headless HTML rendering + printing
   * printer api (simpler if targeting one OS)
 
-
 == Publish Browser Extension
 
 * Chrome store
diff --git a/images/Hatch_Flow_Diagram.png b/images/Hatch_Flow_Diagram.png
index 51d6ae265..fc0ff6ced 100644
Binary files a/images/Hatch_Flow_Diagram.png and b/images/Hatch_Flow_Diagram.png differ
diff --git a/images/hatch_chrome_ext.png b/images/hatch_chrome_ext.png
new file mode 100644
index 000000000..76e0cbaa4
Binary files /dev/null and b/images/hatch_chrome_ext.png differ
diff --git a/images/hatch_icon.png b/images/hatch_icon.png
new file mode 100644
index 000000000..3512f93ca
Binary files /dev/null and b/images/hatch_icon.png differ
diff --git a/images/hatch_print_config.png b/images/hatch_print_config.png
new file mode 100644
index 000000000..4bfe1a0f8
Binary files /dev/null and b/images/hatch_print_config.png differ
diff --git a/images/hatch_settings.png b/images/hatch_settings.png
new file mode 100644
index 000000000..bb202d58a
Binary files /dev/null and b/images/hatch_settings.png differ