X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=c2533f72ffa8a278771dcd32351ec98e03d38839;hb=4ec099efd0efc4c74a940028342013fc4dfdf2a4;hp=49d415ddb77d088673371e41e3989ce5b0715587;hpb=697da818a4a182e4ae50c13b6937226fa3ba921f;p=mkws-moved-to-github.git diff --git a/doc/README.markdown b/doc/README.markdown index 49d415d..c2533f7 100644 --- a/doc/README.markdown +++ b/doc/README.markdown @@ -1,102 +1,9 @@ % The MasterKey Widget Set % Mike Taylor; Wolfram Schneider -% 10 July 2013 +% 28 July 2014 -Introduction ------------- - -This is the MasterKey Widget Set. The initial version was based on the -"jsdemo" application distributed with pazpar2, but it is now far -removed from those beginnnings. - -As much of the searching functionality as possible is hosted on - -so that very simple websites such as - -can have MasterKey searching with minimal effort. - -The following files are hosted on `mkws.indexdata.com`: - -* `mkws.js` -* `/pazpar2/js/pz2.js` -* `mkws-complete.js` -- a single file consisting of `mkws.js`, - jQuery (which it uses), Handlebars (ditto) and `pz2.js` -* `mkws.css` - - -Supported Browsers ------------------- - -Any modern browser will work fine. JavaScript must be enabled. - -* IE8 or later -* Firefox 17 or later -* Google Chrome 27 or later -* Safari 6 or later -* Opera 12 or later -* iOS 6.x (iPhone, iPad) -* Android 4.x - -Not supported: IE6, IE7 - - -Configuring a client (short version) ------------------------------------- - -The application's HTML must contains the following elements as well as -whatever makes up the application itself: - -Prerequisites: - -~~~ - - -~~~ - -Then the following special `
`s can be added (with no content), and -will be filled in by MKWS: - -* `
` -- switch between record and target views -* `
` -- switch between English, Danish and German -* `
` -- search box and button -* `
` -- result list, including pager/sorting -* `
` -- target list, including status -* `
` -- summary statistics - -You can configure and control the client by creating an `mkws_config` -object _before_ loading the widget-set. Here is an example of all -possible options: - -~~~ - -~~~ - -For much more detail, see -[the MKWS whitepaper](whitepaper.html). - - - - -Copyright 2013 IndexData ApS. +Copyright 2014 Index Data ApS.