doc/README.markdown

   1 % The MasterKey Widget Set
   2 % Mike Taylor; Wolfram Schneider
   3 % 28 July 2014
   4
   5
   6 Introduction
   7 ------------
   8
   9 As much of the searching functionality as possible is hosted on
  10         <http://mkws.indexdata.com/>
  11 so that very simple applications such as
  12         <http://example.indexdata.com/simple.html>
  13 can have MasterKey searching with minimal effort.
  14
  15 The following files are hosted on `mkws.indexdata.com`:
  16
  17
  18 Supported Browsers
  19 ------------------
  20
  21 Any modern browser will work fine. JavaScript must be enabled.
  22
  23 * IE8 or later
  24 * Firefox 17 or later
  25 * Google Chrome 27 or later
  26 * Safari 6 or later
  27 * Opera  12 or later
  28 * iOS 6.x (iPhone, iPad)
  29 * Android 4.x
  30
  31 Not supported: IE6, IE7
  32
  33
  34 Configuring a client (short version)
  35 ------------------------------------
  36
  37 The application's HTML must contains the following elements as well as
  38 whatever makes up the application itself:
  39
  40 Prerequisites:
  41
  42 ~~~
  43         <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
  44         <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
  45 ~~~
  46
  47 Then the following special `<div>`s can be added (with no content), and
  48 will be filled in by MKWS:
  49
  50 * `<div id="mkwsSwitch"></div>` -- switch between record and target views
  51 * `<div id="mkwsLang"></div>  ` -- switch between English, Danish and German
  52 * `<div id="mkwsSearch"></div>` -- search box and button
  53 * `<div id="mkwsResults"></div>` -- result list, including pager/sorting
  54 * `<div id="mkwsTargets"></div>` -- target list, including status
  55 * `<div id="mkwsStat"></div>` -- summary statistics
  56
  57 You can configure and control the client by creating an `mkws_config`
  58 object before loading the widget-set. Here is an example showing how
  59 to use options to offer a choice between English and German UI
  60 languages, and to default to sorting by title ascending:
  61
  62 ~~~
  63     <script type="text/javascript">
  64       var mkws_config = {
  65         lang_options: ["en", "de" ],
  66         sort_default: "title:1"
  67       };
  68     </script>
  69 ~~~
  70
  71 For much more detail, see:
  72 [Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
  73
  74
  75 - - -
  76
  77 Copyright 2014 Index Data ApS. <http://indexdata.com>