X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=experiments%2Fspclient%2FREADME;h=c10fbb53d06d0b3ea4b19083692928357e6ffcdc;hb=a74c166733653fe3e5927405807382ab3d29383c;hp=0db2e2782218d92978f0cdc8d75a0f67e3123843;hpb=8bc7194c33988b85c5a8d970597978636a5fa01f;p=mkws-moved-to-github.git
diff --git a/experiments/spclient/README b/experiments/spclient/README
index 0db2e27..c10fbb5 100644
--- a/experiments/spclient/README
+++ b/experiments/spclient/README
@@ -18,7 +18,7 @@ can have MasterKey searching with minimal effort.
The following files must be hosted on mkws.indexdata.com:
mkws.js
mkwsStyle.css
- /libjs-pz2/pz2api.1.js
+ /libjs-pz2/pz2api.1.js (*)
The following files make up the application:
index.html
@@ -29,6 +29,9 @@ The following files make up the application:
Alias for /service-proxy/, to avoid cross-site scripting issues. We
will fix this.)
+(*) if you don't have already installed libjs-pz2 on the machine, you can
+do it by installing a debian package or check it out from GIT:
+$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2
Configuring a client
--------------------
@@ -38,6 +41,9 @@ whatever makes up the application itself:
Prerequisites:
+
@@ -49,6 +55,7 @@ do so many things, but that's not quite trivial.)
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
@@ -59,13 +66,64 @@ 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 with the JavaScript mkws_config object.
+
+Here is an example of all possible options
+
+
+
+Supported Browsers
+------------------
+
+Any modern HTML5 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
+
+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
+
+
What next?
----------
Main areas of work:
-* Fix cross-site issues properly
+* Fix cross-site issues proper
* Make MKWS robust to missing widgets
* Make CSS more tightly targeted at MKWS elements only
+* Make CSS prettier
* Embed in a real, existing, site
* Clean up the code
-