Use HTML entity © since the crappy old pandoc version on caliban
[mkws-moved-to-github.git] / tools / htdocs / README.markdown
index 6e685e0..6701ab7 100644 (file)
@@ -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:
 
 ~~~
-       <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>
 ~~~
 
@@ -71,7 +74,7 @@ possible options:
                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_wodth: 600,    /* page reflows for devices < 600 pixels wide */
                pazpar2_url: "/service-proxy/",            /* URL */
@@ -124,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
@@ -159,5 +158,5 @@ Main areas of work:
 * Clean up the code
 
 - - -
-\(c) 2013 by IndexData ApS, <http://www.indexdata.com>
 
+Copyright &copy; 2013 IndexData ApS. <http://www.indexdata.com>