Get rid of the responsive_design boolean configuration item, and always use responsiv...

[mkws-moved-to-github.git] / tools / htdocs / README.markdown

diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 844fb12..6e685e0 100644 (file)
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -11,24 +11,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
        <http://mkws.indexdata.com/>
 so that very simple websites such as
        <http://example.indexdata.com/>
 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`
+* `mkws.js`
 * `/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
@@ -66,11 +61,10 @@ possible options:
        <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" */
@@ -79,10 +73,10 @@ possible options:
                lang: "en",                 /* "en", "de", "da" */
                debug: 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>
 ~~~
@@ -104,7 +98,7 @@ 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 */
+           "id_popup": "#mkwsPopup",        /* internal id of popup window */
            "width": 880,                    /* popup width, should be at least 800 */ 
            "height": 760                    /* popup height, should be at least 600 */
        });
@@ -139,6 +133,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?
 ----------
 
@@ -147,4 +158,6 @@ Main areas of work:
 * Make MKWS robust to missing widgets
 * Clean up the code
 
+- - -
+\(c) 2013 by IndexData ApS, <http://www.indexdata.com>