From: Bill Erickson Date: Fri, 10 Mar 2017 21:57:19 +0000 (-0500) Subject: eg 2017 hatch review doc X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=1619acf213aa871d018e66e8c8a051a70e83006f;p=working%2Frandom.git eg 2017 hatch review doc Signed-off-by: Bill Erickson --- diff --git a/hatch-review.adoc b/hatch-review.adoc index f8671ebe5..2bd28b1c3 100644 --- a/hatch-review.adoc +++ b/hatch-review.adoc @@ -8,7 +8,10 @@ == Hatch In a Nutshell -"Hatch is the bionic arm of the Evergreen browser client" --Anonymous. +* Unmediated printing across multiple printers +* File storage free of browser restrictions or garbage collection + +[small]_"Hatch is the bionic arm of the Evergreen browser client." --Anonymous._ == Hatch Install Recap @@ -16,6 +19,28 @@ * Install Java code * Install the Chrome extension +== Testing the Java Install + +[source,sh] +--------------------------------------------------------------------------- +# Linux +% ./hatch.sh test + +# Windows +> C:\Users\berick> hatch.bat test + +2017-03-10 16:42:04 FINEST MessageWriter sending: {"clientid":1,... +2017-03-10 16:42:04 INFO Using data directory: /home/berick/.evergreen +2017-03-10 16:42:04 FINEST MessageReader read: {"clientid":1,... +2017-03-10 16:42:04 INFO Received message id=1 action=keys +2017-03-10 16:42:04 FINEST MessageWriter sending: {"clientid":1,... +2017-03-10 16:42:04 FINEST MessageReader read: {"clientid":1,... +2017-03-10 16:42:04 INFO TestJSON:doReceive(): {"clientid":1,... +2017-03-10 16:42:05 FINEST MessageWriter sending: {"clientid":1,... +... +--------------------------------------------------------------------------- + + == chrome://extensions/ image:images/hatch_chrome_ext.png[Hatch Extension] @@ -24,14 +49,22 @@ image:images/hatch_chrome_ext.png[Hatch Extension] image:images/hatch_icon.png[Hatch Diagram] +== Developer Mode Beware! + +image:images/hatch_ext_warning.png[Hatch Extension Warning] + == Hatch Config UI -image:images/hatch_config.png[Hatch Config] +image:images/hatch_settings.png[Hatch Config] == Hatch Printing UI image:images/hatch_print_config.png[Hatch Print Config] +== Hatch Message Flow + +image:images/Hatch_Flow_Diagram.png[Hatch Diagram] + == A Quick Word on Rendering Print Templates * Browser inserts template HTML into the page DOM. @@ -45,16 +78,6 @@ image:images/hatch_print_config.png[Hatch Print Config] ** Hatch does not inject any JS or CSS (but it can load remote content, i.e. scripts, css, images, etc.). -== Browser Extension Loading / Debugging - -https://developer.chrome.com/extensions/nativeMessaging - -TODO: Extensions running in developer mode can harm your computer... - -== Hatch Message Flow - -image:images/Hatch_Flow_Diagram.png[Hatch Diagram] - == Native Messaging API Sample print message JSON. @@ -80,9 +103,11 @@ egPrint.print({...}) is translated into: == Hatch Data Files -[source,js] ---------------------------------------------------------------------------- ---------------------------------------------------------------------------- +Data is stored by default in the ".evergreen" directory in the user's +home directory. + +image:images/hatch_data_dir.png[Hatch Data Dir] + == Hatch Settings Files diff --git a/images/hatch_data_dir.png b/images/hatch_data_dir.png new file mode 100644 index 000000000..9b1130d38 Binary files /dev/null and b/images/hatch_data_dir.png differ diff --git a/images/hatch_ext_warning.png b/images/hatch_ext_warning.png new file mode 100644 index 000000000..2543fdccf Binary files /dev/null and b/images/hatch_ext_warning.png differ