doc/README.markdown

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