Move tools into their own area
authorMike Taylor <mike@indexdata.com>
Tue, 9 Jul 2013 11:14:50 +0000 (12:14 +0100)
committerMike Taylor <mike@indexdata.com>
Tue, 9 Jul 2013 11:14:50 +0000 (12:14 +0100)
experiments/spclient/Makefile [deleted file]
experiments/spclient/README [deleted file]
experiments/spclient/html-structure.txt [deleted file]
experiments/spclient/mkws.js [deleted file]
experiments/spclient/mkwsStyle.css [deleted file]
tools/htdocs/Makefile [new file with mode: 0644]
tools/htdocs/README [new file with mode: 0644]
tools/htdocs/html-structure.txt [new file with mode: 0644]
tools/htdocs/mkws.js [new file with mode: 0644]
tools/htdocs/mkwsStyle.css [new file with mode: 0644]

diff --git a/experiments/spclient/Makefile b/experiments/spclient/Makefile
deleted file mode 100644 (file)
index 38d83f4..0000000
+++ /dev/null
@@ -1,23 +0,0 @@
-######################################################################
-# Copyright (c) 2013 IndexData ApS. http://indexdata.com
-#
-
-MKWS_JS=       mkws-complete.js
-all: ${MKWS_JS}
-
-mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js
-       ( echo "/* created at: $$(date)"; \
-         echo "   mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \
-         curl -sSf http://code.jquery.com/jquery-1.10.0.min.js; \
-         cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new 
-       mv -f ${MKWS_JS}.new ${MKWS_JS}
-
-distclean: clean
-clean:
-       rm -f ${MKWS_JS}
-
-help:
-       @echo "make [ help | mkws-js | clean ]"
-       @echo ""
-       @echo "Please check ./README file too!"
-
diff --git a/experiments/spclient/README b/experiments/spclient/README
deleted file mode 100644 (file)
index bcd492c..0000000
+++ /dev/null
@@ -1,128 +0,0 @@
-An embryonic MasterKey Widget Set
-=================================
-
-This directory contains an embryonic MasterKey Widget Set, based
-initially on "jsdemo" though 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
-       http://mkws.indexdata.com/
-so that very simple websites such as
-       http://somesite.indexdata.com/
-can have MasterKey searching with minimal effort.
-
-The following files must be hosted on mkws.indexdata.com:
-       mkws.js
-       mkwsStyle.css
-       /libjs-pz2/pz2api.1.js (*)
-
-The following files make up the application:
-       index.html
-       favicon.ico [optional]
-       robots.txt [optional]
-
-(At present, the client application's configuruation also needs an
-Alias for /service-proxy/, to avoid cross-site scripting issues. We
-will fix this.)
-
-(*) if you don't have already installed libjs-pz2 on the machine, you can
-do it by installing a debian package or check it out from GIT:
-$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2
-
-Configuring a client
---------------------
-
-The application's HTML must contains the following elements as well as
-whatever makes up the application itself:
-
-Prerequisites:
-    <link rel="stylesheet" href="mkwsStyle.css" />
-    <script type="text/javascript">
-       var mkws_config = { };
-    </script>
-    <script type="text/javascript" src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
-    <script type="text/javascript" src="/libjs-pz2/pz2api.1.js"></script>
-    <script type="text/javascript" src="mkws.js"></script>
-(Yes, we're using JQuery. We use it only in the most trivial ways, and
-could probably get rid of it without too much pain. I'd like to have
-mkws.js automatically pull in pz2api.1.js, too, so you don't need to
-do so many things, but that's not quite trivial.)
-
-Then the following special <div>s can be added (with no content), and
-will be filled in by MKWS:
-    <div id="mkwsSwitch"></div> -- switch between record and target views
-    <div id="mkwsLang"></div>   -- switch between English, Danish and German
-    <div id="mkwsSearch"></div> -- search box and button
-    <div id="mkwsResults"></div> -- result list, including pager/sorting
-    <div id="mkwsTargets"></div> -- target list, including status
-    <div id="mkwsStat"></div> -- summary statistics
-
-At present, MKWS will not work correctly if any of these is
-missing. One of the TODOs is to fix it so that it doesn't try to use
-whatever is not there, and just uses what is.
-
-
-You can configure and control the client with the JavaScript mkws_config object.
-
-Here is an example of all 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
-                                                    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 */
-
-               responsive_design: false    /* true, false: resize for smaller mobile devices */
-               pazpar2_url: "/pazpar2/search.pz2",        /* URL */
-               service_proxy_url: "/service-proxy/",      /* URL */
-               service_proxy_auth: "/service-proxy-auth", /* URL */
-         };
-    </script>
-
-Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files.
-
-Supported Browsers
-------------------
-
-Any modern HTML5 browser will work fine. JavaScript must be enabled.
-
-* IE8 or later
-* Firefox 17 or later
-* Google Chrome 27 or later
-* Safari 6 or later
-* Opera  12 or later
-* iOS 6.x (iPhone, iPad)
-* Android 4.x
-
-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
-
-
-What next?
-----------
-
-Main areas of work:
-* Make MKWS robust to missing widgets
-* Clean up the code
diff --git a/experiments/spclient/html-structure.txt b/experiments/spclient/html-structure.txt
deleted file mode 100644 (file)
index c6d0da8..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-The HTML structure of the MKWS <div>s is as follows. This is useful to
-know when working on stylesheets. As in CSS, #ID indicates a unique
-identifier and .CLASS indicates an instance of a class.
-
-
-#mkwsSwitch
-  a*
-
-#mkwsLang
-  ( a | span )*
-
-#mkwsSearch
-  form
-    input#mkwsQuery type=text
-    input#mkwsButton type=submit
-
-#mkwsBlanket
-  (no contents -- used only for masking)
-
-#mkwsResults
-  table
-    tbody
-      tr
-        td
-          #mkwsTermlists
-            div.title
-            div.facet*
-              div.termtitle
-              ( a span br )*
-        td
-          div#mkwsRanking
-            form#mkwsSelect
-              select#mkwsSort
-              select#mkwsPerpage
-          #mkwsPager
-          #mkwsNavi
-          #mkwsRecords
-            div.record*
-              span (for sequence number)
-              a (for title)
-              span (for other information such as author)
-              div.details (sometimes)
-                table
-                  tbody
-                    tr*
-                      th
-                      td
-#mkwsTargets
-  #mkwsBytarget
-    table
-      thead
-        tr*
-          td*
-      tbody
-        tr*
-          td*
-
-#mkwsStat
-  span.head
-  span.clients
-  span.records
-
diff --git a/experiments/spclient/mkws.js b/experiments/spclient/mkws.js
deleted file mode 100644 (file)
index 98ac5ee..0000000
+++ /dev/null
@@ -1,873 +0,0 @@
-/* A very simple client that shows a basic usage of the pz2.js
-*/
-
-"use strict"; // HTML5: disable for debug >= 2
-
-/*
- * global config object: mkws_config
- *
- * needs to be defined in the HTML header before
- * including this JS file
- */
-
-if (!mkws_config)
-    var mkws_config = {}; // for the guys who forgot to define mkws_config...
-
-if (typeof mkws_config.use_service_proxy === 'undefined')
-    mkws_config.use_service_proxy = true;
-
-// global debug flag
-var mkws_debug;
-
-var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
-var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
-
-var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
-var usesessions = mkws_config.use_service_proxy ? false : true;
-
-
-var mkws_locale_lang = {
-    "de": {
-       "Authors": "Autoren",
-       "Subjects": "Schlagw&ouml;rter",
-       "Sources": "Daten und Quellen",
-       "Termlists": "Termlisten",
-       "Next": "Weiter",
-       "Prev": "Zur&uuml;ck",
-       "Search": "Suche",
-       "Sort by": "Sortieren nach",
-       "and show": "und zeige",
-       "per page": "pro Seite",
-       "Displaying": "Zeige",
-       "to": "von",
-       "of": "aus",
-       "found": "gefunden",
-       "Title": "Titel",
-       "Author": "Autor",
-       "Date": "Datum",
-       "Subject": "Schlagwort",
-       "Location": "Ort",
-
-       "dummy": "dummy"
-    },
-
-    "da": {
-       "Authors": "Forfattere",
-       "Subjects": "Emner",
-       "Sources": "Kilder",
-       "Termlists": "Termlists",
-       "Next": "N&aelig;ste",
-       "Prev": "Forrige",
-       "Search": "S&oslash;g",
-       "Sort by": "Sorter efter",
-       "and show": "og vis",
-       "per page": "per side",
-       "Displaying": "Viser",
-       "to": "til",
-       "of": "ud af",
-       "found": "fandt",
-       "Title": "Title",
-       "Author": "Forfatter",
-       "Date": "Dato",
-       "Subject": "Emneord",
-       "Location": "Lokation",
-
-       "dummy": "dummy"
-    }
-};
-
-
-for (var key in mkws_config) {
-    if (mkws_config.hasOwnProperty(key)) {
-       if (key.match(/^language_/)) {
-           var lang = key.replace(/^language_/, "");
-           // Copy custom languages into list
-           mkws_locale_lang[lang] = mkws_config[key];
-       }
-    }
-}
-
-
-// create a parameters array and pass it to the pz2's constructor
-// then register the form submit event with the pz2.search function
-// autoInit is set to true on default
-var my_paz = new pz2( { "onshow": my_onshow,
-                    "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
-                    "pazpar2path": pazpar2path,
-                    "oninit": my_oninit,
-                    "onstat": my_onstat,
-                    "onterm": my_onterm,
-                    "termlist": "xtargets,subject,author",
-                    "onbytarget": my_onbytarget,
-                   "usesessions" : usesessions,
-                    "showResponseType": '', // or "json" (for debugging?)
-                    "onrecord": my_onrecord } );
-// some state vars
-var curPage = 1;
-var recPerPage = 20;
-var totalRec = 0;
-var curDetRecId = '';
-var curDetRecData = null;
-var curSort = 'relevance';
-var curFilter = null;
-var submitted = false;
-var SourceMax = 16;
-var SubjectMax = 10;
-var AuthorMax = 10;
-
-//
-// pz2.js event handlers:
-//
-function my_oninit() {
-    my_paz.stat();
-    my_paz.bytarget();
-}
-
-function my_onshow(data) {
-    totalRec = data.merged;
-    // move it out
-    var pager = document.getElementById("mkwsPager");
-    pager.innerHTML = "";
-    pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
-                    + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
-                     ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
-                     + data.total + ')</div>';
-    drawPager(pager);
-    // navi
-    var results = document.getElementById("mkwsRecords");
-
-    var html = [];
-    for (var i = 0; i < data.hits.length; i++) {
-        var hit = data.hits[i];
-             html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
-            +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
-            +'<a href="#" id="mkwsRec_'+hit.recid
-            +'" onclick="showDetails(this.id);return false;"><b>'
-            + hit["md-title"] +' </b></a>');
-             if (hit["md-title-remainder"] !== undefined) {
-               html.push('<span>' + hit["md-title-remainder"] + ' </span>');
-             }
-             if (hit["md-title-responsibility"] !== undefined) {
-           html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
-       }
-        if (hit.recid == curDetRecId) {
-            html.push(renderDetails(curDetRecData));
-        }
-       html.push('</div>');
-    }
-    replaceHtml(results, html.join(''));
-}
-
-function my_onstat(data) {
-    var stat = document.getElementById("mkwsStat");
-    if (stat == null)
-       return;
-
-    stat.innerHTML = '<span class="head">Status info</span>' +
-       ' -- ' +
-       '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
-       ' -- ' +
-        '<span class="records">' + data.records + '/' + data.hits + '</span>';
-}
-
-function my_onterm(data) {
-    // no facets
-    if (!mkws_config.facets || mkws_config.facets.length == 0) {
-       $("#mkwsTermlists").hide();
-       return;
-    }
-
-    // display if we first got results
-    $("#mkwsTermlists").show();
-
-    var acc = [];
-    acc.push('<div class="title">' + M('Termlists') + '</div>');
-    var facets = mkws_config.facets;
-
-    for(var i = 0; i < facets.length; i++) {
-       if (facets[i] == "sources") {
-           add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
-       } else if (facets[i] == "subjects") {
-           add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "su");
-       } else if (facets[i] == "authors") {
-           add_single_facet(acc, "Authors",  data.author,   AuthorMax, "au");
-       } else {
-           alert("bad facet configuration: '" + facets[i] + "'");
-       }
-    }
-
-    var termlist = document.getElementById("mkwsTermlists");
-    replaceHtml(termlist, acc.join(''));
-
-    if (mkws_config.responsive_design)
-        mkws_mobile_resize();
-}
-
-function add_single_facet(acc, caption, data, max, cclIndex) {
-    acc.push('<div class="facet">');
-    acc.push('<div class="termtitle">' + M(caption) + '</div>');
-    for (var i = 0; i < data.length && i < max; i++ ) {
-        acc.push('<a href="#" ');
-       var action;
-       if (!cclIndex) {
-           // Special case: target selection
-           acc.push('target_id='+data[i].id+' ');
-           action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
-       } else {
-           action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
-       }
-       acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
-                + '<span> (' + data[i].freq + ')</span><br/>');
-    }
-    acc.push('</div>');
-}
-
-function my_onrecord(data) {
-    // FIXME: record is async!!
-    clearTimeout(my_paz.recordTimer);
-    // in case on_show was faster to redraw element
-    var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
-    if (detRecordDiv) return;
-    curDetRecData = data;
-    var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
-    var html = renderDetails(curDetRecData);
-    recordDiv.innerHTML += html;
-}
-
-function my_onbytarget(data) {
-    var targetDiv = document.getElementById("mkwsBytarget");
-    var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
-        +'<td>Records</td><td>State</td></tr></thead><tbody>';
-
-    for (var i = 0; i < data.length; i++ ) {
-        table += "<tr><td>" + data[i].id +
-            "</td><td>" + data[i].hits +
-            "</td><td>" + data[i].diagnostic +
-            "</td><td>" + data[i].records +
-            "</td><td>" + data[i].state + "</td></tr>";
-    }
-
-    table += '</tbody></table>';
-    targetDiv.innerHTML = table;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-////////////////////////////////////////////////////////////////////////////////
-
-// wait until the DOM is ready
-function domReady ()
-{
-    document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
-    document.mkwsSearchForm.mkwsQuery.value = '';
-    if (document.mkwsSelect) {
-       if (document.mkwsSelect.mkwsSort)
-           document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
-       if (document.mkwsSelect.mkwsPerpage)
-           document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
-    }
-}
-
-// when search button pressed
-function onFormSubmitEventHandler()
-{
-    resetPage();
-    loadSelect();
-    triggerSearch();
-    switchView('records'); // In case it's configured to start off as hidden
-    submitted = true;
-    return false;
-}
-
-function onSelectDdChange()
-{
-    if (!submitted) return false;
-    resetPage();
-    loadSelect();
-    my_paz.show(0, recPerPage, curSort);
-    return false;
-}
-
-function resetPage()
-{
-    curPage = 1;
-    totalRec = 0;
-}
-
-function triggerSearch ()
-{
-    my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter);
-}
-
-function loadSelect ()
-{
-    if (document.mkwsSelect) {
-       if (document.mkwsSelect.mkwsSort)
-           curSort = document.mkwsSelect.mkwsSort.value;
-       if (document.mkwsSelect.mkwsPerpage)
-           recPerPage = document.mkwsSelect.mkwsPerpage.value;
-    }
-}
-
-// limit the query after clicking the facet
-function limitQuery (field, value)
-{
-    document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
-    onFormSubmitEventHandler();
-}
-
-// limit by target functions
-function limitTarget (id, name)
-{
-    var navi = document.getElementById('mkwsNavi');
-    navi.innerHTML =
-        'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
-        + name + '</a>';
-    curFilter = 'pz:id=' + id;
-    resetPage();
-    loadSelect();
-    triggerSearch();
-    return false;
-}
-
-function delimitTarget ()
-{
-    var navi = document.getElementById('mkwsNavi');
-    navi.innerHTML = '';
-    curFilter = null;
-    resetPage();
-    loadSelect();
-    triggerSearch();
-    return false;
-}
-
-function drawPager (pagerDiv)
-{
-    //client indexes pages from 1 but pz2 from 0
-    var onsides = 6;
-    var pages = Math.ceil(totalRec / recPerPage);
-
-    var firstClkbl = ( curPage - onsides > 0 )
-        ? curPage - onsides
-        : 1;
-
-    var lastClkbl = firstClkbl + 2*onsides < pages
-        ? firstClkbl + 2*onsides
-        : pages;
-
-    var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
-    if (curPage > 1)
-        prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
-        +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
-
-    var middle = '';
-    for(var i = firstClkbl; i <= lastClkbl; i++) {
-        var numLabel = i;
-        if(i == curPage)
-            numLabel = '<b>' + i + '</b>';
-
-        middle += '<a href="#" onclick="showPage(' + i + ')"> '
-            + numLabel + ' </a>';
-    }
-
-    var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
-    if (pages - curPage > 0)
-        next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
-        + M('Next') + ' &#62;&#62;</a>';
-
-    var predots = '';
-    if (firstClkbl > 1)
-        predots = '...';
-
-    var postdots = '';
-    if (lastClkbl < pages)
-        postdots = '...';
-
-    pagerDiv.innerHTML += '<div style="float: clear">'
-        + prev + predots + middle + postdots + next + '</div>';
-}
-
-function showPage (pageNum)
-{
-    curPage = pageNum;
-    my_paz.showPage( curPage - 1 );
-}
-
-// simple paging functions
-
-function pagerNext() {
-    if ( totalRec - recPerPage*curPage > 0) {
-        my_paz.showNext();
-        curPage++;
-    }
-}
-
-function pagerPrev() {
-    if ( my_paz.showPrev() != false )
-        curPage--;
-}
-
-// switching view between targets and records
-
-function switchView(view) {
-    var targets = document.getElementById('mkwsTargets');
-    var results = document.getElementById('mkwsResults') ||
-                 document.getElementById('mkwsRecords');
-    var blanket = document.getElementById('mkwsBlanket');
-    var motd    = document.getElementById('mkwsEmbeddedMOTD');
-
-    switch(view) {
-        case 'targets':
-            if (targets) targets.style.display = "block";
-            if (results) results.style.display = "none";
-            if (blanket) blanket.style.display = "none";
-            if (motd) motd.style.display = "none";
-            break;
-        case 'records':
-            if (targets) targets.style.display = "none";
-            if (results) results.style.display = "block";
-            if (blanket) blanket.style.display = "block";
-            if (motd) motd.style.display = "none";
-            break;
-       case 'none':
-            if (targets) targets.style.display = "none";
-            if (results) results.style.display = "none";
-            if (blanket) blanket.style.display = "none";
-            if (motd) motd.style.display = "none";
-            break;
-        default:
-            alert("Unknown view '" + view + "'");
-    }
-}
-
-// detailed record drawing
-function showDetails (prefixRecId) {
-    var recId = prefixRecId.replace('mkwsRec_', '');
-    var oldRecId = curDetRecId;
-    curDetRecId = recId;
-
-    // remove current detailed view if any
-    var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
-    // lovin DOM!
-    if (detRecordDiv)
-      detRecordDiv.parentNode.removeChild(detRecordDiv);
-
-    // if the same clicked, just hide
-    if (recId == oldRecId) {
-        curDetRecId = '';
-        curDetRecData = null;
-        return;
-    }
-    // request the record
-    my_paz.record(recId);
-}
-
-function replaceHtml(el, html) {
-  var oldEl = typeof el === "string" ? document.getElementById(el) : el;
-  /*@cc_on // Pure innerHTML is slightly faster in IE
-    oldEl.innerHTML = html;
-    return oldEl;
-    @*/
-  var newEl = oldEl.cloneNode(false);
-  newEl.innerHTML = html;
-  oldEl.parentNode.replaceChild(newEl, oldEl);
-  /* Since we just removed the old element from the DOM, return a reference
-     to the new element, which can be used to restore variable references. */
-  return newEl;
-};
-
-function renderDetails(data, marker)
-{
-    var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
-    if (marker) details += '<tr><td>'+ marker + '</td></tr>';
-
-    details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
-    details += renderField("Date", data["md-date"]);
-    details += renderField("Author", data["md-author"]);
-    details += renderField("URL", data["md-electronic-url"]);
-    details += renderField("Subject", data["location"][0]["md-subject"]);
-    details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
-    details += '</table></div>';
-
-    return details;
-}
-
-function renderField(caption, data, data2, data3) {
-    if (data === undefined) {
-       return "";
-    }
-
-    if (caption == "URL") {
-       data = '<a href="' + data + '" target="_blank">' + data + '</a>';
-    }
-
-    if (data2 != undefined) {
-       data = data + " (" + data2 + ")";
-    }
-
-    if (data3 != undefined) {
-       data = data + " <i>" + data3 + "</i>";
-    }
-
-    return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
-}
-
-
-/*
- * All the HTML stuff to render the search forms and
- * result pages.
- */
-function mkws_html_all(config) {
-
-    /* default mkws config */
-    var mkws_config_default = {
-       sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
-       perpage: [10, 20, 30, 50],
-       sort_default: "relevance",
-       perpage_default: 20,
-       query_width: 50,
-       switch_menu: false,     /* show/hide Records|Targets menu */
-       lang_menu: true,        /* show/hide language menu */
-       sort_menu: true,        /* show/hide sort menu */
-       perpage_menu: true,     /* show/hide perpage menu */
-       lang_display: [],       /* display languages links for given languages, [] for all */
-       facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
-       responsive_design_width: 980, /* a page with less pixel width considered as mobile */
-       debug: 1,     /* debug level for development: 0..2 */
-
-       dummy: "dummy"
-    };
-
-    /* set global debug flag early */
-    if (typeof config.debug !== 'undefined') {
-       mkws_debug = config.debug;
-    } else if (typeof mkws_config_default.debug !== 'undefined') {
-       mkws_debug = mkws_config_default.debug;
-    }
-
-    /* override standard config values by function parameters */
-    for (var k in mkws_config_default) {
-       if (typeof config[k] === 'undefined')
-          mkws_config[k] = mkws_config_default[k];
-       debug("Set config: " + k + ' => ' + mkws_config[k]);
-    }
-
-    if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
-       debug("Reset query width: " + mkws_config.query_width);
-       mkws_config.query_width = 50;
-    }
-
-    mkws_set_lang(mkws_config);
-    if (mkws_config.lang_menu)
-       mkws_html_lang(mkws_config);
-
-    // For some reason, doing this programmatically results in
-    // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
-    debug("HTML search form");
-    $("#mkwsSearch").html('\
-    <form name="mkwsSearchForm" action="" >\
-      <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
-      <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
-    </form>');
-
-    debug("HTML records");
-    // If the application has an #mkwsResults, populate it in the
-    // usual way. If not, assume that it's a smarter application that
-    // defines its own subcomponents:
-    // #mkwsTermlists
-    // #mkwsRanking
-    // #mkwsPager
-    // #mkwsNavi
-    // #mkwsRecords
-    if ($("#mkwsResults").length) {
-       $("#mkwsResults").html('\
-      <table width="100%" border="0" cellpadding="6" cellspacing="0">\
-        <tr>\
-          <td width="250" valign="top">\
-            <div id="mkwsTermlists"></div>\
-          </td>\
-          <td valign="top">\
-            <div id="mkwsRanking"></div>\
-            <div id="mkwsPager"></div>\
-            <div id="mkwsNavi"></div>\
-            <div id="mkwsRecords"></div>\
-            <div id="mkwsEmbeddedMOTD"></div>\
-          </td>\
-        </tr>\
-      </table>');
-    }
-
-    if ($("#mkwsRanking").length) {
-       var ranking_data = '';
-       ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
-       if (config.sort_menu) {
-           ranking_data +=  M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
-       }
-       if (config.perpage_menu) {
-           ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
-       }
-        ranking_data += '</form>';
-
-       $("#mkwsRanking").html(ranking_data);
-    }
-
-    mkws_html_switch(config);
-
-    if (mkws_config.use_service_proxy)
-       mkws_service_proxy_auth(config.service_proxy_auth);
-
-    if (mkws_config.responsive_design)
-       mkws_responsive_design();
-
-    domReady();
-
-    // on first page, hide the termlist
-    $(document).ready(function() { $("#mkwsTermlists").hide(); } );
-    var elem = document.getElementById("mkwsMOTD");
-    if (elem) {
-       // Move the MOTD from the provided element down into the embedded one
-       document.getElementById("mkwsEmbeddedMOTD").innerHTML = elem.innerHTML;
-        elem.style.display = "none";
-    }
-}
-
-/* Responsive web design - change layout on the fly depending on
- * the current screen size width/height. Required for mobile devices.
- */
-function mkws_responsive_design () {
-    var timeout = null;
-
-    $(window).resize( function(e) {
-       if (timeout)
-           clearTimeout(timeout);
-       timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
-    });
-
-    // initial check after page load
-    $(document).ready(function() { mkws_mobile_resize() });
-}
-
-function mkws_set_lang(mkws_config)  {
-    var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
-    if (!lang || !mkws_locale_lang[lang]) {
-       mkws_config.lang = ""
-    } else {
-       mkws_config.lang = lang;
-    }
-
-    debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
-    return mkws_config.lang;
-}
-
-function mkws_html_switch(config) {
-    debug("HTML switch");
-
-    $("#mkwsSwitch").html($("<a/>", {
-       href: '#',
-       onclick: "switchView(\'records\')",
-       text: M("Records")
-    }));
-    $("#mkwsSwitch").append($("<span/>", { text: " | " }));
-    $("#mkwsSwitch").append($("<a/>", {
-       href: '#',
-       onclick: "switchView(\'targets\')",
-       text: M("Targets")
-    }));
-
-    debug("HTML targets");
-    $("#mkwsTargets").html('\
-      <div id="mkwsBytarget">\
-       No information available yet.\
-      </div>');
-    $("#mkwsTargets").css("display", "none");
-
-    if (!config.switch_menu) {
-       debug("disable switch menu");
-        $("#mkwsSwitch").css("display", "none");
-    }
-}
-
-function mkws_html_sort(config) {
-    debug("HTML sort");
-    var sort_html = '<select name="mkwsSort" id="mkwsSort">';
-
-    for(var i = 0; i < config.sort.length; i++) {
-       var key = config.sort[i][0];
-       var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
-
-       sort_html += '<option value="' + key + '"';
-       if (key == config.sort_default) {
-           sort_html += ' selected="selected"';
-       }
-       sort_html += '>' + val + '</option>';
-    }
-    sort_html += '</select>';
-
-    return sort_html;
-}
-
-function mkws_html_perpage(config) {
-    debug("HTML perpage");
-    var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
-
-    for(var i = 0; i < config.perpage.length; i++) {
-       var key = config.perpage[i];
-
-       perpage_html += '<option value="' + key + '"';
-       if (key == config.perpage_default) {
-           perpage_html += ' selected="selected"';
-       }
-       perpage_html += '>' + key + '</option>';
-    }
-    perpage_html += '</select>';
-
-    return perpage_html;
-}
-
-/*
- * Run service-proxy authentication in background (after page load).
- * The username/password is configured in the apache config file
- * for the site.
- */
-function mkws_service_proxy_auth(auth_url) {
-    if (!auth_url)
-       auth_url = "http://mkws.indexdata.com/service-proxy-auth";
-
-    debug("Run service proxy auth URL: " + auth_url);
-
-    var request = new pzHttpRequest(auth_url);
-    request.get(null, function(data) {
-       if (!jQuery.isXMLDoc(data)) {
-           alert("service proxy auth response document is not valid XML document, give up!");
-           return;
-       }
-       var status = $(data).find("status");
-       if (status.text() != "OK") {
-           alert("service proxy auth repsonse status: " + status.text() + ", give up!");
-           return;
-       }
-    });
-}
-
-/* create locale language menu */
-function mkws_html_lang(mkws_config) {
-    var lang_default = "en";
-    var lang = mkws_config.lang || lang_default;
-    var list = [];
-
-    /* display a list of configured languages, or all */
-    var lang_display = mkws_config.lang_display || [];
-    var hash = {};
-    for (var i = 0; i < lang_display.length; i++) {
-       hash[lang_display[i]] = 1;
-    }
-
-    for (var k in mkws_locale_lang) {
-       if (hash[k] == 1 || lang_display.length == 0)
-           list.push(k);
-    }
-
-    // add english link
-    if (lang_display.length == 0 || hash[lang_default] == 1)
-        list.push(lang_default);
-
-    debug("Language menu for: " + list.join(", "));
-
-    /* the HTML part */
-    var data = "";
-    for(var i = 0; i < list.length; i++) {
-       var l = list[i];
-
-       if (data)
-           data += ' | ';
-
-       if (lang == l) {
-           data += ' <span>' + l + '</span> ';
-       } else {
-           data += ' <a href="?lang=' + l + '">' + l + '</a> '
-       }
-    }
-
-    $("#mkwsLang").html(data);
-}
-
-function mkws_mobile_resize () {
-    debug("resize width: " + $(window).height() + ", width: " + $(window).width());
-    var list = ["mkwsSwitch"];
-    var obj;
-    // alert($(window).width());
-
-    var width = mkws_config.responsive_design_width || 980;
-
-    if ($(window).width() <= width) {
-       for(var i = 0; i < list.length; i++) {
-           $("#" + list[i]).hide();
-       }
-
-       $("#mkwsTermlists").hide();
-       obj = $("#mkwsTermlists").html();
-        $("#mkwsShiftedTermlists").html(obj);
-    } else {
-       for(var i = 0; i < list.length; i++) {
-           $("#" + list[i]).show();
-       }
-       $("#mkwsTermlists").show();
-       $("#mkwsShiftedTermlists").html("");
-    }
-};
-
-/* locale */
-function M(word) {
-    var lang = mkws_config.lang;
-
-    if (!lang || !mkws_locale_lang[lang])
-       return word;
-
-    return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
-}
-
-/* implement jQuery.parseQuerystring() for parsing URL parameters */
-jQuery.extend({
-  parseQuerystring: function() {
-    var nvpair = {};
-    var qs = window.location.search.replace('?', '');
-    var pairs = qs.split('&');
-    $.each(pairs, function(i, v){
-       var pair = v.split('=');
-       nvpair[pair[0]] = pair[1];
-    });
-    return nvpair;
-  },
-  pazpar2: function(data) {
-       document.write('<div id="mkwsSwitch"></div>\
-    <div id="mkwsLang"></div>\
-    <div id="mkwsSearch"></div>\
-    <div id="mkwsResults"></div>\
-    <div id="mkwsTargets"></div>\
-    <div id="mkwsFooter">\
-      <div id="mkwsStat"></div>\
-      <span>Powered by MKWS &copy; 2013 <a target="_new" href="http://www.indexdata.com">Index Data</a></span>\
-    </div>');
-
-    mkws_html_all(mkws_config);
-  }
-});
-
-function debug(string) {
-    if (!mkws_debug)
-       return;
-
-    if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
-       return;
-    }
-
-    // you need to disable use strict at the top of the file!!!
-    if (mkws_debug >= 3) {
-       console.log(arguments.callee.caller);
-    } else if (mkws_debug >= 2) {
-       console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
-    }
-    console.log(string);
-}
-
-/* magic */
-$(document).ready(function() { mkws_html_all(mkws_config) });
diff --git a/experiments/spclient/mkwsStyle.css b/experiments/spclient/mkwsStyle.css
deleted file mode 100644 (file)
index 08e2fbf..0000000
+++ /dev/null
@@ -1,196 +0,0 @@
-#mkwsLang,
-#mkwsSwitch,
-#mkwsSearch,
-#mkwsTermlists,
-#mkwsRanking,
-#mkwsPager,
-#mkwsNavi,
-#mkwsRecords,
-#mkwsTargets,
-#mkwsStat,
-#mkwsShiftedTermlists,
-#mkwsEmbeddedMOTD {
-    font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif;
-}
-
-#mkwsLang {
-    float: left;
-    padding-left: 1em;
-    padding-top: 0.4em;
-}
-
-#mkwsLang a {
-    background: #d0e0ff;
-    padding: 1px 4px;
-}
-
-#mkwsLang span {
-    border: solid 1px #d0e0ff;
-    padding: 0px 3px;
-}
-
-#mkwsSearch {
-    float: right;
-}
-
-#mkwsSwitch {
-    float: right;
-    padding-left: 1em;
-    padding-top: 0.4em;
-}
-
-#mkwsTargets {
-    background-color: #fafafa;
-}
-
-#mkwsStat {
-    margin-top: 10px;
-    border-top: 1px solid  #156a16;
-    padding-top: 5px;
-    font-size: small;
-}
-
-#mkwsStat span.head {
-    font-weight: bold;
-}
-
-#mkwsStat span.clients:before {
-    content: "Active clients: ";
-}
-
-#mkwsStat span.records:before {
-    content: "Retrieved records: ";
-}
-
-#mkwsSwitch a,
-#mkwsLang a,
-#mkwsTermlists a,
-#mkwsRanking a,
-#mkwsPager a,
-#mkwsNavi a,
-#mkwsRecords a,
-#mkwsShiftedTermlists a {
-    color: #005701;
-    text-decoration: none;
-}
-
-#mkwsSwitch a:hover,
-#mkwsLang a:hover,
-#mkwsTermlists a:hover,
-#mkwsPager a:hover,
-#mkwsRecords a:hover,
-#mkwsShiftedTermlists a:hover {
-    text-decoration: underline;
-}
-
-#mkwsNavi a.crossout:hover {
-    text-decoration: line-through;
-}
-
-#mkwsSearch input#mkwsButton {
-    border: 3px outset #132194;
-    background-color: #132194;
-    padding: 2px;
-    width: 6em;
-    color: #FFFFFF;
-    font-weight: bold;
-    text-transform: uppercase;
-    font-size: 10px;
-    margin-left: 8px;
-    cursor: pointer;
-}
-
-#mkwsSearch input#mkwsQuery {
-    border: 2px inset #e0f0ff;
-    padding: 3px;
-    font-size: 12px;
-    background: #f0f8ff;
-}
-
-#mkwsTermlists .title,
-#mkwsShiftedTermlists .title {
-    font-size: large;
-    font-weight: bold;
-    text-transform: uppercase;
-}
-
-#mkwsTermlists,
-#mkwsShiftedTermlists div#termlist  {
-    background: #d0e0ff;
-    padding: 0.7em;
-    font-size: small;
-
-    border-top-right-radius: 10px;
-    -moz-border-top-right-radius: 10px;
-    -webkit-border-top-right-radius: 10px;
-}
-
-#mkwsTermlists div.facet,
-#mkwsShiftedTermlists div.facet {
-    background: #e0f0ff;
-    padding: 0.7em;
-    margin-top: 0.7em;
-
-    border-top-right-radius: 10px;
-    -moz-border-top-right-radius: 10px;
-    -webkit-border-top-right-radius: 10px;
-}
-
-#mkwsTermlists div.termtitle,
-#mkwsShiftedTermlists div.termtitle {
-    font-weight: bold;
-}
-
-#mkwsRecords div.record,
-#mkwsShiftedTermlists div.record {
-    padding: 5px;
-}
-
-#mkwsRecords div.details {
-    border: 1px solid #404040;
-    background: #e8e8e8;
-    color: darkgray;
-    padding: 5px 10px;
-    margin: 10px 0px;
-    box-shadow: 10px 10px 5px #808080;
-
-    border-top-right-radius: 10px;
-    -moz-border-top-right-radius: 10px;
-    -webkit-border-top-right-radius: 10px;
-}
-
-#mkwsRecords div.details th,
-#mkwsShiftedTermlists div.details th {
-    text-align: right;
-    vertical-align: top;
-    padding-right: 0.6em;
-}
-
-#mkwsRecords div.details th:after,
-#mkwsShiftedTermlists div.details th:after {
-    content: ":";
-}
-
-#mkwsPager {
-    background: #e0e0e0;
-    padding: 0.3em;
-}
-
-#mkwsBytarget table thead tr td {
-    background-color: #132194;
-    color: white;
-    font-weight: bold;
-    padding: 0.2em 0.5em;
-}
-
-#mkwsBytarget table tbody tr:nth-child(odd) {
-    background-color: #e0f0ff;
-}
-
-#mkwsBytarget table tbody tr:nth-child(even) {
-    background-color: #d0e0ff;
-}
-
-#mkwsBytarget table tbody tr td {
-    padding: 0.2em 0.5em;
-}
diff --git a/tools/htdocs/Makefile b/tools/htdocs/Makefile
new file mode 100644 (file)
index 0000000..38d83f4
--- /dev/null
@@ -0,0 +1,23 @@
+######################################################################
+# Copyright (c) 2013 IndexData ApS. http://indexdata.com
+#
+
+MKWS_JS=       mkws-complete.js
+all: ${MKWS_JS}
+
+mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js
+       ( echo "/* created at: $$(date)"; \
+         echo "   mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \
+         curl -sSf http://code.jquery.com/jquery-1.10.0.min.js; \
+         cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new 
+       mv -f ${MKWS_JS}.new ${MKWS_JS}
+
+distclean: clean
+clean:
+       rm -f ${MKWS_JS}
+
+help:
+       @echo "make [ help | mkws-js | clean ]"
+       @echo ""
+       @echo "Please check ./README file too!"
+
diff --git a/tools/htdocs/README b/tools/htdocs/README
new file mode 100644 (file)
index 0000000..bcd492c
--- /dev/null
@@ -0,0 +1,128 @@
+An embryonic MasterKey Widget Set
+=================================
+
+This directory contains an embryonic MasterKey Widget Set, based
+initially on "jsdemo" though 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
+       http://mkws.indexdata.com/
+so that very simple websites such as
+       http://somesite.indexdata.com/
+can have MasterKey searching with minimal effort.
+
+The following files must be hosted on mkws.indexdata.com:
+       mkws.js
+       mkwsStyle.css
+       /libjs-pz2/pz2api.1.js (*)
+
+The following files make up the application:
+       index.html
+       favicon.ico [optional]
+       robots.txt [optional]
+
+(At present, the client application's configuruation also needs an
+Alias for /service-proxy/, to avoid cross-site scripting issues. We
+will fix this.)
+
+(*) if you don't have already installed libjs-pz2 on the machine, you can
+do it by installing a debian package or check it out from GIT:
+$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2
+
+Configuring a client
+--------------------
+
+The application's HTML must contains the following elements as well as
+whatever makes up the application itself:
+
+Prerequisites:
+    <link rel="stylesheet" href="mkwsStyle.css" />
+    <script type="text/javascript">
+       var mkws_config = { };
+    </script>
+    <script type="text/javascript" src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
+    <script type="text/javascript" src="/libjs-pz2/pz2api.1.js"></script>
+    <script type="text/javascript" src="mkws.js"></script>
+(Yes, we're using JQuery. We use it only in the most trivial ways, and
+could probably get rid of it without too much pain. I'd like to have
+mkws.js automatically pull in pz2api.1.js, too, so you don't need to
+do so many things, but that's not quite trivial.)
+
+Then the following special <div>s can be added (with no content), and
+will be filled in by MKWS:
+    <div id="mkwsSwitch"></div> -- switch between record and target views
+    <div id="mkwsLang"></div>   -- switch between English, Danish and German
+    <div id="mkwsSearch"></div> -- search box and button
+    <div id="mkwsResults"></div> -- result list, including pager/sorting
+    <div id="mkwsTargets"></div> -- target list, including status
+    <div id="mkwsStat"></div> -- summary statistics
+
+At present, MKWS will not work correctly if any of these is
+missing. One of the TODOs is to fix it so that it doesn't try to use
+whatever is not there, and just uses what is.
+
+
+You can configure and control the client with the JavaScript mkws_config object.
+
+Here is an example of all 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
+                                                    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 */
+
+               responsive_design: false    /* true, false: resize for smaller mobile devices */
+               pazpar2_url: "/pazpar2/search.pz2",        /* URL */
+               service_proxy_url: "/service-proxy/",      /* URL */
+               service_proxy_auth: "/service-proxy-auth", /* URL */
+         };
+    </script>
+
+Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files.
+
+Supported Browsers
+------------------
+
+Any modern HTML5 browser will work fine. JavaScript must be enabled.
+
+* IE8 or later
+* Firefox 17 or later
+* Google Chrome 27 or later
+* Safari 6 or later
+* Opera  12 or later
+* iOS 6.x (iPhone, iPad)
+* Android 4.x
+
+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
+
+
+What next?
+----------
+
+Main areas of work:
+* Make MKWS robust to missing widgets
+* Clean up the code
diff --git a/tools/htdocs/html-structure.txt b/tools/htdocs/html-structure.txt
new file mode 100644 (file)
index 0000000..c6d0da8
--- /dev/null
@@ -0,0 +1,62 @@
+The HTML structure of the MKWS <div>s is as follows. This is useful to
+know when working on stylesheets. As in CSS, #ID indicates a unique
+identifier and .CLASS indicates an instance of a class.
+
+
+#mkwsSwitch
+  a*
+
+#mkwsLang
+  ( a | span )*
+
+#mkwsSearch
+  form
+    input#mkwsQuery type=text
+    input#mkwsButton type=submit
+
+#mkwsBlanket
+  (no contents -- used only for masking)
+
+#mkwsResults
+  table
+    tbody
+      tr
+        td
+          #mkwsTermlists
+            div.title
+            div.facet*
+              div.termtitle
+              ( a span br )*
+        td
+          div#mkwsRanking
+            form#mkwsSelect
+              select#mkwsSort
+              select#mkwsPerpage
+          #mkwsPager
+          #mkwsNavi
+          #mkwsRecords
+            div.record*
+              span (for sequence number)
+              a (for title)
+              span (for other information such as author)
+              div.details (sometimes)
+                table
+                  tbody
+                    tr*
+                      th
+                      td
+#mkwsTargets
+  #mkwsBytarget
+    table
+      thead
+        tr*
+          td*
+      tbody
+        tr*
+          td*
+
+#mkwsStat
+  span.head
+  span.clients
+  span.records
+
diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js
new file mode 100644 (file)
index 0000000..98ac5ee
--- /dev/null
@@ -0,0 +1,873 @@
+/* A very simple client that shows a basic usage of the pz2.js
+*/
+
+"use strict"; // HTML5: disable for debug >= 2
+
+/*
+ * global config object: mkws_config
+ *
+ * needs to be defined in the HTML header before
+ * including this JS file
+ */
+
+if (!mkws_config)
+    var mkws_config = {}; // for the guys who forgot to define mkws_config...
+
+if (typeof mkws_config.use_service_proxy === 'undefined')
+    mkws_config.use_service_proxy = true;
+
+// global debug flag
+var mkws_debug;
+
+var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
+var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
+
+var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
+var usesessions = mkws_config.use_service_proxy ? false : true;
+
+
+var mkws_locale_lang = {
+    "de": {
+       "Authors": "Autoren",
+       "Subjects": "Schlagw&ouml;rter",
+       "Sources": "Daten und Quellen",
+       "Termlists": "Termlisten",
+       "Next": "Weiter",
+       "Prev": "Zur&uuml;ck",
+       "Search": "Suche",
+       "Sort by": "Sortieren nach",
+       "and show": "und zeige",
+       "per page": "pro Seite",
+       "Displaying": "Zeige",
+       "to": "von",
+       "of": "aus",
+       "found": "gefunden",
+       "Title": "Titel",
+       "Author": "Autor",
+       "Date": "Datum",
+       "Subject": "Schlagwort",
+       "Location": "Ort",
+
+       "dummy": "dummy"
+    },
+
+    "da": {
+       "Authors": "Forfattere",
+       "Subjects": "Emner",
+       "Sources": "Kilder",
+       "Termlists": "Termlists",
+       "Next": "N&aelig;ste",
+       "Prev": "Forrige",
+       "Search": "S&oslash;g",
+       "Sort by": "Sorter efter",
+       "and show": "og vis",
+       "per page": "per side",
+       "Displaying": "Viser",
+       "to": "til",
+       "of": "ud af",
+       "found": "fandt",
+       "Title": "Title",
+       "Author": "Forfatter",
+       "Date": "Dato",
+       "Subject": "Emneord",
+       "Location": "Lokation",
+
+       "dummy": "dummy"
+    }
+};
+
+
+for (var key in mkws_config) {
+    if (mkws_config.hasOwnProperty(key)) {
+       if (key.match(/^language_/)) {
+           var lang = key.replace(/^language_/, "");
+           // Copy custom languages into list
+           mkws_locale_lang[lang] = mkws_config[key];
+       }
+    }
+}
+
+
+// create a parameters array and pass it to the pz2's constructor
+// then register the form submit event with the pz2.search function
+// autoInit is set to true on default
+var my_paz = new pz2( { "onshow": my_onshow,
+                    "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
+                    "pazpar2path": pazpar2path,
+                    "oninit": my_oninit,
+                    "onstat": my_onstat,
+                    "onterm": my_onterm,
+                    "termlist": "xtargets,subject,author",
+                    "onbytarget": my_onbytarget,
+                   "usesessions" : usesessions,
+                    "showResponseType": '', // or "json" (for debugging?)
+                    "onrecord": my_onrecord } );
+// some state vars
+var curPage = 1;
+var recPerPage = 20;
+var totalRec = 0;
+var curDetRecId = '';
+var curDetRecData = null;
+var curSort = 'relevance';
+var curFilter = null;
+var submitted = false;
+var SourceMax = 16;
+var SubjectMax = 10;
+var AuthorMax = 10;
+
+//
+// pz2.js event handlers:
+//
+function my_oninit() {
+    my_paz.stat();
+    my_paz.bytarget();
+}
+
+function my_onshow(data) {
+    totalRec = data.merged;
+    // move it out
+    var pager = document.getElementById("mkwsPager");
+    pager.innerHTML = "";
+    pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
+                    + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
+                     ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
+                     + data.total + ')</div>';
+    drawPager(pager);
+    // navi
+    var results = document.getElementById("mkwsRecords");
+
+    var html = [];
+    for (var i = 0; i < data.hits.length; i++) {
+        var hit = data.hits[i];
+             html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
+            +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
+            +'<a href="#" id="mkwsRec_'+hit.recid
+            +'" onclick="showDetails(this.id);return false;"><b>'
+            + hit["md-title"] +' </b></a>');
+             if (hit["md-title-remainder"] !== undefined) {
+               html.push('<span>' + hit["md-title-remainder"] + ' </span>');
+             }
+             if (hit["md-title-responsibility"] !== undefined) {
+           html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
+       }
+        if (hit.recid == curDetRecId) {
+            html.push(renderDetails(curDetRecData));
+        }
+       html.push('</div>');
+    }
+    replaceHtml(results, html.join(''));
+}
+
+function my_onstat(data) {
+    var stat = document.getElementById("mkwsStat");
+    if (stat == null)
+       return;
+
+    stat.innerHTML = '<span class="head">Status info</span>' +
+       ' -- ' +
+       '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
+       ' -- ' +
+        '<span class="records">' + data.records + '/' + data.hits + '</span>';
+}
+
+function my_onterm(data) {
+    // no facets
+    if (!mkws_config.facets || mkws_config.facets.length == 0) {
+       $("#mkwsTermlists").hide();
+       return;
+    }
+
+    // display if we first got results
+    $("#mkwsTermlists").show();
+
+    var acc = [];
+    acc.push('<div class="title">' + M('Termlists') + '</div>');
+    var facets = mkws_config.facets;
+
+    for(var i = 0; i < facets.length; i++) {
+       if (facets[i] == "sources") {
+           add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
+       } else if (facets[i] == "subjects") {
+           add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "su");
+       } else if (facets[i] == "authors") {
+           add_single_facet(acc, "Authors",  data.author,   AuthorMax, "au");
+       } else {
+           alert("bad facet configuration: '" + facets[i] + "'");
+       }
+    }
+
+    var termlist = document.getElementById("mkwsTermlists");
+    replaceHtml(termlist, acc.join(''));
+
+    if (mkws_config.responsive_design)
+        mkws_mobile_resize();
+}
+
+function add_single_facet(acc, caption, data, max, cclIndex) {
+    acc.push('<div class="facet">');
+    acc.push('<div class="termtitle">' + M(caption) + '</div>');
+    for (var i = 0; i < data.length && i < max; i++ ) {
+        acc.push('<a href="#" ');
+       var action;
+       if (!cclIndex) {
+           // Special case: target selection
+           acc.push('target_id='+data[i].id+' ');
+           action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
+       } else {
+           action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
+       }
+       acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
+                + '<span> (' + data[i].freq + ')</span><br/>');
+    }
+    acc.push('</div>');
+}
+
+function my_onrecord(data) {
+    // FIXME: record is async!!
+    clearTimeout(my_paz.recordTimer);
+    // in case on_show was faster to redraw element
+    var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
+    if (detRecordDiv) return;
+    curDetRecData = data;
+    var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
+    var html = renderDetails(curDetRecData);
+    recordDiv.innerHTML += html;
+}
+
+function my_onbytarget(data) {
+    var targetDiv = document.getElementById("mkwsBytarget");
+    var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
+        +'<td>Records</td><td>State</td></tr></thead><tbody>';
+
+    for (var i = 0; i < data.length; i++ ) {
+        table += "<tr><td>" + data[i].id +
+            "</td><td>" + data[i].hits +
+            "</td><td>" + data[i].diagnostic +
+            "</td><td>" + data[i].records +
+            "</td><td>" + data[i].state + "</td></tr>";
+    }
+
+    table += '</tbody></table>';
+    targetDiv.innerHTML = table;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+
+// wait until the DOM is ready
+function domReady ()
+{
+    document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
+    document.mkwsSearchForm.mkwsQuery.value = '';
+    if (document.mkwsSelect) {
+       if (document.mkwsSelect.mkwsSort)
+           document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
+       if (document.mkwsSelect.mkwsPerpage)
+           document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
+    }
+}
+
+// when search button pressed
+function onFormSubmitEventHandler()
+{
+    resetPage();
+    loadSelect();
+    triggerSearch();
+    switchView('records'); // In case it's configured to start off as hidden
+    submitted = true;
+    return false;
+}
+
+function onSelectDdChange()
+{
+    if (!submitted) return false;
+    resetPage();
+    loadSelect();
+    my_paz.show(0, recPerPage, curSort);
+    return false;
+}
+
+function resetPage()
+{
+    curPage = 1;
+    totalRec = 0;
+}
+
+function triggerSearch ()
+{
+    my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter);
+}
+
+function loadSelect ()
+{
+    if (document.mkwsSelect) {
+       if (document.mkwsSelect.mkwsSort)
+           curSort = document.mkwsSelect.mkwsSort.value;
+       if (document.mkwsSelect.mkwsPerpage)
+           recPerPage = document.mkwsSelect.mkwsPerpage.value;
+    }
+}
+
+// limit the query after clicking the facet
+function limitQuery (field, value)
+{
+    document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
+    onFormSubmitEventHandler();
+}
+
+// limit by target functions
+function limitTarget (id, name)
+{
+    var navi = document.getElementById('mkwsNavi');
+    navi.innerHTML =
+        'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
+        + name + '</a>';
+    curFilter = 'pz:id=' + id;
+    resetPage();
+    loadSelect();
+    triggerSearch();
+    return false;
+}
+
+function delimitTarget ()
+{
+    var navi = document.getElementById('mkwsNavi');
+    navi.innerHTML = '';
+    curFilter = null;
+    resetPage();
+    loadSelect();
+    triggerSearch();
+    return false;
+}
+
+function drawPager (pagerDiv)
+{
+    //client indexes pages from 1 but pz2 from 0
+    var onsides = 6;
+    var pages = Math.ceil(totalRec / recPerPage);
+
+    var firstClkbl = ( curPage - onsides > 0 )
+        ? curPage - onsides
+        : 1;
+
+    var lastClkbl = firstClkbl + 2*onsides < pages
+        ? firstClkbl + 2*onsides
+        : pages;
+
+    var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
+    if (curPage > 1)
+        prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
+        +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
+
+    var middle = '';
+    for(var i = firstClkbl; i <= lastClkbl; i++) {
+        var numLabel = i;
+        if(i == curPage)
+            numLabel = '<b>' + i + '</b>';
+
+        middle += '<a href="#" onclick="showPage(' + i + ')"> '
+            + numLabel + ' </a>';
+    }
+
+    var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
+    if (pages - curPage > 0)
+        next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
+        + M('Next') + ' &#62;&#62;</a>';
+
+    var predots = '';
+    if (firstClkbl > 1)
+        predots = '...';
+
+    var postdots = '';
+    if (lastClkbl < pages)
+        postdots = '...';
+
+    pagerDiv.innerHTML += '<div style="float: clear">'
+        + prev + predots + middle + postdots + next + '</div>';
+}
+
+function showPage (pageNum)
+{
+    curPage = pageNum;
+    my_paz.showPage( curPage - 1 );
+}
+
+// simple paging functions
+
+function pagerNext() {
+    if ( totalRec - recPerPage*curPage > 0) {
+        my_paz.showNext();
+        curPage++;
+    }
+}
+
+function pagerPrev() {
+    if ( my_paz.showPrev() != false )
+        curPage--;
+}
+
+// switching view between targets and records
+
+function switchView(view) {
+    var targets = document.getElementById('mkwsTargets');
+    var results = document.getElementById('mkwsResults') ||
+                 document.getElementById('mkwsRecords');
+    var blanket = document.getElementById('mkwsBlanket');
+    var motd    = document.getElementById('mkwsEmbeddedMOTD');
+
+    switch(view) {
+        case 'targets':
+            if (targets) targets.style.display = "block";
+            if (results) results.style.display = "none";
+            if (blanket) blanket.style.display = "none";
+            if (motd) motd.style.display = "none";
+            break;
+        case 'records':
+            if (targets) targets.style.display = "none";
+            if (results) results.style.display = "block";
+            if (blanket) blanket.style.display = "block";
+            if (motd) motd.style.display = "none";
+            break;
+       case 'none':
+            if (targets) targets.style.display = "none";
+            if (results) results.style.display = "none";
+            if (blanket) blanket.style.display = "none";
+            if (motd) motd.style.display = "none";
+            break;
+        default:
+            alert("Unknown view '" + view + "'");
+    }
+}
+
+// detailed record drawing
+function showDetails (prefixRecId) {
+    var recId = prefixRecId.replace('mkwsRec_', '');
+    var oldRecId = curDetRecId;
+    curDetRecId = recId;
+
+    // remove current detailed view if any
+    var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
+    // lovin DOM!
+    if (detRecordDiv)
+      detRecordDiv.parentNode.removeChild(detRecordDiv);
+
+    // if the same clicked, just hide
+    if (recId == oldRecId) {
+        curDetRecId = '';
+        curDetRecData = null;
+        return;
+    }
+    // request the record
+    my_paz.record(recId);
+}
+
+function replaceHtml(el, html) {
+  var oldEl = typeof el === "string" ? document.getElementById(el) : el;
+  /*@cc_on // Pure innerHTML is slightly faster in IE
+    oldEl.innerHTML = html;
+    return oldEl;
+    @*/
+  var newEl = oldEl.cloneNode(false);
+  newEl.innerHTML = html;
+  oldEl.parentNode.replaceChild(newEl, oldEl);
+  /* Since we just removed the old element from the DOM, return a reference
+     to the new element, which can be used to restore variable references. */
+  return newEl;
+};
+
+function renderDetails(data, marker)
+{
+    var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
+    if (marker) details += '<tr><td>'+ marker + '</td></tr>';
+
+    details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
+    details += renderField("Date", data["md-date"]);
+    details += renderField("Author", data["md-author"]);
+    details += renderField("URL", data["md-electronic-url"]);
+    details += renderField("Subject", data["location"][0]["md-subject"]);
+    details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
+    details += '</table></div>';
+
+    return details;
+}
+
+function renderField(caption, data, data2, data3) {
+    if (data === undefined) {
+       return "";
+    }
+
+    if (caption == "URL") {
+       data = '<a href="' + data + '" target="_blank">' + data + '</a>';
+    }
+
+    if (data2 != undefined) {
+       data = data + " (" + data2 + ")";
+    }
+
+    if (data3 != undefined) {
+       data = data + " <i>" + data3 + "</i>";
+    }
+
+    return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
+}
+
+
+/*
+ * All the HTML stuff to render the search forms and
+ * result pages.
+ */
+function mkws_html_all(config) {
+
+    /* default mkws config */
+    var mkws_config_default = {
+       sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
+       perpage: [10, 20, 30, 50],
+       sort_default: "relevance",
+       perpage_default: 20,
+       query_width: 50,
+       switch_menu: false,     /* show/hide Records|Targets menu */
+       lang_menu: true,        /* show/hide language menu */
+       sort_menu: true,        /* show/hide sort menu */
+       perpage_menu: true,     /* show/hide perpage menu */
+       lang_display: [],       /* display languages links for given languages, [] for all */
+       facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
+       responsive_design_width: 980, /* a page with less pixel width considered as mobile */
+       debug: 1,     /* debug level for development: 0..2 */
+
+       dummy: "dummy"
+    };
+
+    /* set global debug flag early */
+    if (typeof config.debug !== 'undefined') {
+       mkws_debug = config.debug;
+    } else if (typeof mkws_config_default.debug !== 'undefined') {
+       mkws_debug = mkws_config_default.debug;
+    }
+
+    /* override standard config values by function parameters */
+    for (var k in mkws_config_default) {
+       if (typeof config[k] === 'undefined')
+          mkws_config[k] = mkws_config_default[k];
+       debug("Set config: " + k + ' => ' + mkws_config[k]);
+    }
+
+    if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
+       debug("Reset query width: " + mkws_config.query_width);
+       mkws_config.query_width = 50;
+    }
+
+    mkws_set_lang(mkws_config);
+    if (mkws_config.lang_menu)
+       mkws_html_lang(mkws_config);
+
+    // For some reason, doing this programmatically results in
+    // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
+    debug("HTML search form");
+    $("#mkwsSearch").html('\
+    <form name="mkwsSearchForm" action="" >\
+      <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
+      <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
+    </form>');
+
+    debug("HTML records");
+    // If the application has an #mkwsResults, populate it in the
+    // usual way. If not, assume that it's a smarter application that
+    // defines its own subcomponents:
+    // #mkwsTermlists
+    // #mkwsRanking
+    // #mkwsPager
+    // #mkwsNavi
+    // #mkwsRecords
+    if ($("#mkwsResults").length) {
+       $("#mkwsResults").html('\
+      <table width="100%" border="0" cellpadding="6" cellspacing="0">\
+        <tr>\
+          <td width="250" valign="top">\
+            <div id="mkwsTermlists"></div>\
+          </td>\
+          <td valign="top">\
+            <div id="mkwsRanking"></div>\
+            <div id="mkwsPager"></div>\
+            <div id="mkwsNavi"></div>\
+            <div id="mkwsRecords"></div>\
+            <div id="mkwsEmbeddedMOTD"></div>\
+          </td>\
+        </tr>\
+      </table>');
+    }
+
+    if ($("#mkwsRanking").length) {
+       var ranking_data = '';
+       ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
+       if (config.sort_menu) {
+           ranking_data +=  M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
+       }
+       if (config.perpage_menu) {
+           ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
+       }
+        ranking_data += '</form>';
+
+       $("#mkwsRanking").html(ranking_data);
+    }
+
+    mkws_html_switch(config);
+
+    if (mkws_config.use_service_proxy)
+       mkws_service_proxy_auth(config.service_proxy_auth);
+
+    if (mkws_config.responsive_design)
+       mkws_responsive_design();
+
+    domReady();
+
+    // on first page, hide the termlist
+    $(document).ready(function() { $("#mkwsTermlists").hide(); } );
+    var elem = document.getElementById("mkwsMOTD");
+    if (elem) {
+       // Move the MOTD from the provided element down into the embedded one
+       document.getElementById("mkwsEmbeddedMOTD").innerHTML = elem.innerHTML;
+        elem.style.display = "none";
+    }
+}
+
+/* Responsive web design - change layout on the fly depending on
+ * the current screen size width/height. Required for mobile devices.
+ */
+function mkws_responsive_design () {
+    var timeout = null;
+
+    $(window).resize( function(e) {
+       if (timeout)
+           clearTimeout(timeout);
+       timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
+    });
+
+    // initial check after page load
+    $(document).ready(function() { mkws_mobile_resize() });
+}
+
+function mkws_set_lang(mkws_config)  {
+    var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
+    if (!lang || !mkws_locale_lang[lang]) {
+       mkws_config.lang = ""
+    } else {
+       mkws_config.lang = lang;
+    }
+
+    debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
+    return mkws_config.lang;
+}
+
+function mkws_html_switch(config) {
+    debug("HTML switch");
+
+    $("#mkwsSwitch").html($("<a/>", {
+       href: '#',
+       onclick: "switchView(\'records\')",
+       text: M("Records")
+    }));
+    $("#mkwsSwitch").append($("<span/>", { text: " | " }));
+    $("#mkwsSwitch").append($("<a/>", {
+       href: '#',
+       onclick: "switchView(\'targets\')",
+       text: M("Targets")
+    }));
+
+    debug("HTML targets");
+    $("#mkwsTargets").html('\
+      <div id="mkwsBytarget">\
+       No information available yet.\
+      </div>');
+    $("#mkwsTargets").css("display", "none");
+
+    if (!config.switch_menu) {
+       debug("disable switch menu");
+        $("#mkwsSwitch").css("display", "none");
+    }
+}
+
+function mkws_html_sort(config) {
+    debug("HTML sort");
+    var sort_html = '<select name="mkwsSort" id="mkwsSort">';
+
+    for(var i = 0; i < config.sort.length; i++) {
+       var key = config.sort[i][0];
+       var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
+
+       sort_html += '<option value="' + key + '"';
+       if (key == config.sort_default) {
+           sort_html += ' selected="selected"';
+       }
+       sort_html += '>' + val + '</option>';
+    }
+    sort_html += '</select>';
+
+    return sort_html;
+}
+
+function mkws_html_perpage(config) {
+    debug("HTML perpage");
+    var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
+
+    for(var i = 0; i < config.perpage.length; i++) {
+       var key = config.perpage[i];
+
+       perpage_html += '<option value="' + key + '"';
+       if (key == config.perpage_default) {
+           perpage_html += ' selected="selected"';
+       }
+       perpage_html += '>' + key + '</option>';
+    }
+    perpage_html += '</select>';
+
+    return perpage_html;
+}
+
+/*
+ * Run service-proxy authentication in background (after page load).
+ * The username/password is configured in the apache config file
+ * for the site.
+ */
+function mkws_service_proxy_auth(auth_url) {
+    if (!auth_url)
+       auth_url = "http://mkws.indexdata.com/service-proxy-auth";
+
+    debug("Run service proxy auth URL: " + auth_url);
+
+    var request = new pzHttpRequest(auth_url);
+    request.get(null, function(data) {
+       if (!jQuery.isXMLDoc(data)) {
+           alert("service proxy auth response document is not valid XML document, give up!");
+           return;
+       }
+       var status = $(data).find("status");
+       if (status.text() != "OK") {
+           alert("service proxy auth repsonse status: " + status.text() + ", give up!");
+           return;
+       }
+    });
+}
+
+/* create locale language menu */
+function mkws_html_lang(mkws_config) {
+    var lang_default = "en";
+    var lang = mkws_config.lang || lang_default;
+    var list = [];
+
+    /* display a list of configured languages, or all */
+    var lang_display = mkws_config.lang_display || [];
+    var hash = {};
+    for (var i = 0; i < lang_display.length; i++) {
+       hash[lang_display[i]] = 1;
+    }
+
+    for (var k in mkws_locale_lang) {
+       if (hash[k] == 1 || lang_display.length == 0)
+           list.push(k);
+    }
+
+    // add english link
+    if (lang_display.length == 0 || hash[lang_default] == 1)
+        list.push(lang_default);
+
+    debug("Language menu for: " + list.join(", "));
+
+    /* the HTML part */
+    var data = "";
+    for(var i = 0; i < list.length; i++) {
+       var l = list[i];
+
+       if (data)
+           data += ' | ';
+
+       if (lang == l) {
+           data += ' <span>' + l + '</span> ';
+       } else {
+           data += ' <a href="?lang=' + l + '">' + l + '</a> '
+       }
+    }
+
+    $("#mkwsLang").html(data);
+}
+
+function mkws_mobile_resize () {
+    debug("resize width: " + $(window).height() + ", width: " + $(window).width());
+    var list = ["mkwsSwitch"];
+    var obj;
+    // alert($(window).width());
+
+    var width = mkws_config.responsive_design_width || 980;
+
+    if ($(window).width() <= width) {
+       for(var i = 0; i < list.length; i++) {
+           $("#" + list[i]).hide();
+       }
+
+       $("#mkwsTermlists").hide();
+       obj = $("#mkwsTermlists").html();
+        $("#mkwsShiftedTermlists").html(obj);
+    } else {
+       for(var i = 0; i < list.length; i++) {
+           $("#" + list[i]).show();
+       }
+       $("#mkwsTermlists").show();
+       $("#mkwsShiftedTermlists").html("");
+    }
+};
+
+/* locale */
+function M(word) {
+    var lang = mkws_config.lang;
+
+    if (!lang || !mkws_locale_lang[lang])
+       return word;
+
+    return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
+}
+
+/* implement jQuery.parseQuerystring() for parsing URL parameters */
+jQuery.extend({
+  parseQuerystring: function() {
+    var nvpair = {};
+    var qs = window.location.search.replace('?', '');
+    var pairs = qs.split('&');
+    $.each(pairs, function(i, v){
+       var pair = v.split('=');
+       nvpair[pair[0]] = pair[1];
+    });
+    return nvpair;
+  },
+  pazpar2: function(data) {
+       document.write('<div id="mkwsSwitch"></div>\
+    <div id="mkwsLang"></div>\
+    <div id="mkwsSearch"></div>\
+    <div id="mkwsResults"></div>\
+    <div id="mkwsTargets"></div>\
+    <div id="mkwsFooter">\
+      <div id="mkwsStat"></div>\
+      <span>Powered by MKWS &copy; 2013 <a target="_new" href="http://www.indexdata.com">Index Data</a></span>\
+    </div>');
+
+    mkws_html_all(mkws_config);
+  }
+});
+
+function debug(string) {
+    if (!mkws_debug)
+       return;
+
+    if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
+       return;
+    }
+
+    // you need to disable use strict at the top of the file!!!
+    if (mkws_debug >= 3) {
+       console.log(arguments.callee.caller);
+    } else if (mkws_debug >= 2) {
+       console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
+    }
+    console.log(string);
+}
+
+/* magic */
+$(document).ready(function() { mkws_html_all(mkws_config) });
diff --git a/tools/htdocs/mkwsStyle.css b/tools/htdocs/mkwsStyle.css
new file mode 100644 (file)
index 0000000..08e2fbf
--- /dev/null
@@ -0,0 +1,196 @@
+#mkwsLang,
+#mkwsSwitch,
+#mkwsSearch,
+#mkwsTermlists,
+#mkwsRanking,
+#mkwsPager,
+#mkwsNavi,
+#mkwsRecords,
+#mkwsTargets,
+#mkwsStat,
+#mkwsShiftedTermlists,
+#mkwsEmbeddedMOTD {
+    font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif;
+}
+
+#mkwsLang {
+    float: left;
+    padding-left: 1em;
+    padding-top: 0.4em;
+}
+
+#mkwsLang a {
+    background: #d0e0ff;
+    padding: 1px 4px;
+}
+
+#mkwsLang span {
+    border: solid 1px #d0e0ff;
+    padding: 0px 3px;
+}
+
+#mkwsSearch {
+    float: right;
+}
+
+#mkwsSwitch {
+    float: right;
+    padding-left: 1em;
+    padding-top: 0.4em;
+}
+
+#mkwsTargets {
+    background-color: #fafafa;
+}
+
+#mkwsStat {
+    margin-top: 10px;
+    border-top: 1px solid  #156a16;
+    padding-top: 5px;
+    font-size: small;
+}
+
+#mkwsStat span.head {
+    font-weight: bold;
+}
+
+#mkwsStat span.clients:before {
+    content: "Active clients: ";
+}
+
+#mkwsStat span.records:before {
+    content: "Retrieved records: ";
+}
+
+#mkwsSwitch a,
+#mkwsLang a,
+#mkwsTermlists a,
+#mkwsRanking a,
+#mkwsPager a,
+#mkwsNavi a,
+#mkwsRecords a,
+#mkwsShiftedTermlists a {
+    color: #005701;
+    text-decoration: none;
+}
+
+#mkwsSwitch a:hover,
+#mkwsLang a:hover,
+#mkwsTermlists a:hover,
+#mkwsPager a:hover,
+#mkwsRecords a:hover,
+#mkwsShiftedTermlists a:hover {
+    text-decoration: underline;
+}
+
+#mkwsNavi a.crossout:hover {
+    text-decoration: line-through;
+}
+
+#mkwsSearch input#mkwsButton {
+    border: 3px outset #132194;
+    background-color: #132194;
+    padding: 2px;
+    width: 6em;
+    color: #FFFFFF;
+    font-weight: bold;
+    text-transform: uppercase;
+    font-size: 10px;
+    margin-left: 8px;
+    cursor: pointer;
+}
+
+#mkwsSearch input#mkwsQuery {
+    border: 2px inset #e0f0ff;
+    padding: 3px;
+    font-size: 12px;
+    background: #f0f8ff;
+}
+
+#mkwsTermlists .title,
+#mkwsShiftedTermlists .title {
+    font-size: large;
+    font-weight: bold;
+    text-transform: uppercase;
+}
+
+#mkwsTermlists,
+#mkwsShiftedTermlists div#termlist  {
+    background: #d0e0ff;
+    padding: 0.7em;
+    font-size: small;
+
+    border-top-right-radius: 10px;
+    -moz-border-top-right-radius: 10px;
+    -webkit-border-top-right-radius: 10px;
+}
+
+#mkwsTermlists div.facet,
+#mkwsShiftedTermlists div.facet {
+    background: #e0f0ff;
+    padding: 0.7em;
+    margin-top: 0.7em;
+
+    border-top-right-radius: 10px;
+    -moz-border-top-right-radius: 10px;
+    -webkit-border-top-right-radius: 10px;
+}
+
+#mkwsTermlists div.termtitle,
+#mkwsShiftedTermlists div.termtitle {
+    font-weight: bold;
+}
+
+#mkwsRecords div.record,
+#mkwsShiftedTermlists div.record {
+    padding: 5px;
+}
+
+#mkwsRecords div.details {
+    border: 1px solid #404040;
+    background: #e8e8e8;
+    color: darkgray;
+    padding: 5px 10px;
+    margin: 10px 0px;
+    box-shadow: 10px 10px 5px #808080;
+
+    border-top-right-radius: 10px;
+    -moz-border-top-right-radius: 10px;
+    -webkit-border-top-right-radius: 10px;
+}
+
+#mkwsRecords div.details th,
+#mkwsShiftedTermlists div.details th {
+    text-align: right;
+    vertical-align: top;
+    padding-right: 0.6em;
+}
+
+#mkwsRecords div.details th:after,
+#mkwsShiftedTermlists div.details th:after {
+    content: ":";
+}
+
+#mkwsPager {
+    background: #e0e0e0;
+    padding: 0.3em;
+}
+
+#mkwsBytarget table thead tr td {
+    background-color: #132194;
+    color: white;
+    font-weight: bold;
+    padding: 0.2em 0.5em;
+}
+
+#mkwsBytarget table tbody tr:nth-child(odd) {
+    background-color: #e0f0ff;
+}
+
+#mkwsBytarget table tbody tr:nth-child(even) {
+    background-color: #d0e0ff;
+}
+
+#mkwsBytarget table tbody tr td {
+    padding: 0.2em 0.5em;
+}