% 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.
The following files are hosted on `mkws.indexdata.com`:
-* `mkwsStyle.css`
+* `mkws.css`
* `mkws.js`
* `/libjs-pz2/pz2api.1.js`
-* `mkws-complete.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
Prerequisites:
~~~
- <link rel="stylesheet" href="http://mkws.indexdata.com/mkwsStyle.css" />
+ <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
<script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
~~~
<script type="text/javascript">
var mkws_config = {
use_service_proxy: true, /* true, flase: use service proxy instead pazpar2 */
- switch_menu: true, /* true, false: show/hide Records|Targets menu */
- lang_menu: true, /* true, false: show/hide language menu */
- sort_menu: true, /* true, false: show/hide sort menu */
- perpage_menu: true, /* true, false: show/hide perpage menu */
- lang_display: ["en", "de", "da"], /* display languages links for given
+ show_lang: true, /* true, false: show/hide language menu */
+ show_sort: true, /* true, false: show/hide sort menu */
+ show_perpage: true, /* true, false: show/hide perpage menu */
+ lang_options: ["en", "de", "da"], /* display languages links for given
languages, [] for all */
facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
sort_default: "relevance", /* "relevance", "title:1", "date:0", "date:1" */
query_width: 50, /* 5..50 */
perpage_default: 20, /* 10, 20, 30, 50 */
lang: "en", /* "en", "de", "da" */
- debug: 0, /* debug level for development: 0..2 */
+ debug_level: 0, /* debug level for development: 0..2 */
- responsive_design: false /* true, false: resize for smaller mobile devices */
- pazpar2_url: "/pazpar2/search.pz2", /* URL */
- service_proxy_url: "/service-proxy/", /* URL */
+ responsive_design_wodth: 600, /* page reflows for devices < 600 pixels wide */
+ pazpar2_url: "/service-proxy/", /* URL */
service_proxy_auth: "/service-proxy-auth", /* URL */
+ // TODO: language_*, perpage_options, sort_options
};
</script>
~~~
- 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?
----------