X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=1994dc88c2c0f0331a3cbfc37897f6bfe14fa698;hb=52262a5dbc558d26d731f7918389d6dd9993549c;hp=0b0e42a0d3e814e7b55e42f0e966367baffe6aac;hpb=cd107ace248482336676614fd0e1d85dac1696a7;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 0b0e42a..1994dc8 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -3,6 +3,9 @@
% 10 July 2013
+Introduction
+------------
+
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.
@@ -11,24 +14,19 @@ 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.css`
* `mkws.js`
-* `mkwsStyle.css`
* `/libjs-pz2/pz2api.1.js`
-
-The following files make up an application:
-
-* `index.html`
-* `favicon.ico` [_optional_]
-* `robots.txt` [_optional_]
+* `mkws-complete.js` -- a single file consisting of `mkws.js`,
+ jQuery (which it uses) and `pz2api.1.js`
Configuring a client
@@ -40,7 +38,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -66,23 +64,22 @@ possible options:
~~~
@@ -139,6 +136,23 @@ New Features since jsdemo
- 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?
----------