X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2FREADME.markdown;h=6701ab7cc216b08564de3b69ea292600c03bfbb2;hb=63cac7f34c479f1891dbe399e3cff977f3d76cff;hp=b349bf5b54f39c9067a1539ac434974a7ad40a72;hpb=1e449acba57c1146e146225f7f47e5cd412e07e2;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index b349bf5..6701ab7 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.
@@ -19,11 +22,11 @@ can have MasterKey searching with minimal effort.
The following files are hosted on `mkws.indexdata.com`:
-* `mkwsStyle.css`
+* `mkws.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`
Configuring a client
@@ -35,7 +38,7 @@ whatever makes up the application itself:
Prerequisites:
~~~
-
+
~~~
@@ -64,20 +67,19 @@ possible options:
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_display: ["en", "de", "da"], /* display languages links for given
+ 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, responsive_design_width, sort
+ // TODO: language_*, perpage_options, sort_options
};
~~~
@@ -125,10 +127,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
@@ -160,5 +158,5 @@ Main areas of work:
* Clean up the code
- - -
-\(c) 2013 by IndexData ApS,
+Copyright © 2013 IndexData ApS.