Rename all menu_* configuration options show_*. Part of MKWS-41

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

diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index 38b2a94..b349bf5 100644 (file)
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -22,13 +22,8 @@ The following files are hosted on `mkws.indexdata.com`:
 * `mkwsStyle.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
@@ -66,10 +61,9 @@ 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 */
+               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
                                                     languages, [] for all */
                facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
@@ -83,6 +77,7 @@ possible options:
                pazpar2_url: "/pazpar2/search.pz2",        /* URL */
                service_proxy_url: "/service-proxy/",      /* URL */
                service_proxy_auth: "/service-proxy-auth", /* URL */
+               // TODO: language_*, perpage, responsive_design_width, sort
            };
        </script>
 ~~~
@@ -139,6 +134,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?
 ----------