X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=c398d66f546691635570d591e7bf120242e7a913;hb=a9f7094799cb6393ea79dfcfec2d4a748bd744f3;hp=6dc22c24bc00b963fa8774f46056f7c3c557fd2e;hpb=5bfa1fb03995552651dc40e91a89697322c996df;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 6dc22c2..c398d66 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -1,34 +1,28 @@
-% 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
+------------
+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.
-How this works
---------------
-
-The goal is to make it that as much of the searching functionality as
-possible is hosted on
+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:
+The following files are hosted on `mkws.indexdata.com`:
* `mkws.js`
-* `mkwsStyle.css`
-* `/libjs-pz2/pz2api.1.js`
-
-The following files make up an application:
-
-* `index.html`
-* `favicon.ico` [_optional_]
-* `robots.txt` [_optional_]
+* `/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`
Configuring a client
@@ -40,7 +34,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -54,63 +48,35 @@ 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
-------------------
-
-The jQuery plugin version can be used by a single line of JavaScript code:
-
-~~~
-
+
~~~
-put the code in your page at the position where the metasearch should occur.
-
-Here is an example of all possible options
-
-~~~
- jQuery.pazpar2({
- "layout": "popup", /* "table" [default], "div", "popup" */
- "id_button": "input#mkwsButton", /* submit button id in search field */
- "id_popup": "#mkwsPopup", /* interal id of popup window */
- "width": 880, /* popup width, should be at least 800 */
- "height": 760 /* popup height, should be at least 600 */
- });
-~~~
-
-
Supported Browsers
------------------
@@ -130,20 +96,36 @@ 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
+Checklist before doing a release
+---------------------------------
+- open the site, e.g. http://mkws-dev.indexdata.com/index-mike.html
+- open the debug/error console in your browser (alt-cmd-J, shift-cmd-J)
+- check the language links ("de", "da", "en")
+- run a search with few, but not to few results, e.g.: freebsd
+- check "Targets" | "Records" links
+- check "Next" and "Prev" links
+- click on the first hit and display details, click on an "URL" to jump to
+ the local catalog or full text
+- limit search to a "Source"
+- limit search to an "Author"
+- sort results by "Title" and "newest"
+- what else?
+
+
+
What next?
----------
Main areas of work:
+
* Make MKWS robust to missing widgets
* Clean up the code
+- - -
+Copyright 2013 IndexData ApS.