experiments/spclient/README

   1 An embryonic MasterKey Widget Set
   2 =================================
   3
   4 This directory contains an embryonic MasterKey Widget Set, based
   5 initially on "jsdemo" though now far removed from those beginnnings.
   6
   7
   8 How this works
   9 --------------
  10
  11 The goal is to make it that as much of the searching functionality as
  12 possible is hosted on
  13         http://mkws.indexdata.com/
  14 so that very simple websites such as
  15         http://somesite.indexdata.com/
  16 can have MasterKey searching with minimal effort.
  17
  18 The following files must be hosted on mkws.indexdata.com:
  19         mkws.js
  20         mkwsStyle.css
  21         /libjs-pz2/pz2api.1.js (*)
  22
  23 The following files make up the application:
  24         index.html
  25         favicon.ico [optional]
  26         robots.txt [optional]
  27
  28 (At present, the client application's configuruation also needs an
  29 Alias for /service-proxy/, to avoid cross-site scripting issues. We
  30 will fix this.)
  31
  32 (*) if you don't have already installed libjs-pz2 on the machine, you can
  33 do it by installing a debian package or check it out from GIT:
  34 $ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2
  35
  36 Configuring a client
  37 --------------------
  38
  39 The application's HTML must contains the following elements as well as
  40 whatever makes up the application itself:
  41
  42 Prerequisites:
  43     <link rel="stylesheet" href="mkwsStyle.css" />
  44     <script type="text/javascript">
  45         var mkws_config = { };
  46     </script>
  47     <script type="text/javascript" src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
  48     <script type="text/javascript" src="/libjs-pz2/pz2api.1.js"></script>
  49     <script type="text/javascript" src="mkws.js"></script>
  50 (Yes, we're using JQuery. We use it only in the most trivial ways, and
  51 could probably get rid of it without too much pain. I'd like to have
  52 mkws.js automatically pull in pz2api.1.js, too, so you don't need to
  53 do so many things, but that's not quite trivial.)
  54
  55 Then the following special <div>s can be added (with no content), and
  56 will be filled in by MKWS:
  57     <div id="mkwsSwitch"></div> -- switch between record and target views
  58     <div id="mkwsSearch"></div> -- search box and button
  59     <div id="mkwsRecords"></div> -- result list, including pager/sorting
  60     <div id="mkwsTargets"></div> -- target list, including status
  61     <div id="mkwsStat"></div> -- summary statistics
  62
  63 At present, MKWS will not work correctly if any of these is
  64 missing. One of the TODOs is to fix it so that it doesn't try to use
  65 whatever is not there, and just uses what is.
  66
  67
  68 You can configure and control the client with the JavaScript mkws_config object.
  69
  70 Here is an example of all possible options
  71     <script type="text/javascript">
  72         var mkws_config = {
  73                 use_service_proxy: false,   /* true, flase */
  74                 switch: true,               /* true, false */
  75                 sort_default: "relevance",  /* "relevance", "title:1", "date:0", "date:1" */
  76                 query_width: 50,            /* 5..50 */
  77                 perpage_default: 20,        /* 10, 20, 30, 50 */
  78
  79                 pazpar2_url: "/pazpar2/search.pz2",        /* URL */
  80                 service_proxy_url: "/service-proxy/",      /* URL */
  81                 service_proxy_auth: "/service-proxy-auth", /* URL */
  82          };
  83     </script>
  84
  85 What next?
  86 ----------
  87
  88 Main areas of work:
  89 * Fix cross-site issues proper
  90 * Make MKWS robust to missing widgets
  91 * Make CSS more tightly targeted at MKWS elements only
  92 * Make CSS prettier
  93 * Embed in a real, existing, site
  94 * Clean up the code