X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=3710885afad1d4c79c05aae4cf337a75807ceb37;hb=049fa40f6cc7f7cf5f6b1617098c803b2f4c5bdc;hp=6e685e0a9ad8213bbf4465911c8814396679b533;hpb=287904816476333f1b699d3ce612418059cf51d3;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 6e685e0..3710885 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -1,15 +1,14 @@
-% An embryonic MasterKey Widget Set
+% The MasterKey Widget Set
% Mike Taylor; Wolfram Schneider
% 10 July 2013
-This directory contains an embryonic MasterKey Widget Set. The initial
-version was based on the "jsdemo" application distributed with
-pazpar2, but it is now far removed from those beginnnings.
+Introduction
+------------
-
-How this works
---------------
+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
@@ -19,11 +18,11 @@ can have MasterKey searching with minimal effort.
The following files are hosted on `mkws.indexdata.com`:
-* `mkwsStyle.css`
* `mkws.js`
-* `/libjs-pz2/pz2api.1.js`
+* `/pazpar2/js/pz2.js`
* `mkws-complete.js` -- a single file consisting of `mkws.js`,
- jQuery (which it uses) and `pz2api.1.js`
+ jQuery (which it uses), Handlebars (ditto) and `pz2.js`
+* `mkws.css`
Configuring a client
@@ -35,7 +34,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -49,36 +48,33 @@ will be filled in by MKWS:
* `
` -- target list, including status
* `` -- summary statistics
-At present, MKWS may not work correctly if some of these are
-missing. One of the TODOs is to fix it so that it doesn't try to use
-whatever is not there, and just uses what is.
-
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:
~~~
-
+
~~~
jQuery plugin
@@ -124,10 +120,6 @@ Not supported: IE6, IE7
New Features since jsdemo
--------------------------
-- Multilinguality: English (default), Danish, German
-- Depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js
- which will make the development of pazpar2 plugins faster and
- easier to share code between projects
- Supports basic pazpar2 and service-proxy requests
- Simplified HTML
- The search page is fully configurable by a JSON object
@@ -159,5 +151,5 @@ Main areas of work:
* Clean up the code
- - -
-\(c) 2013 by IndexData ApS,
+Copyright 2013 IndexData ApS.