tools/htdocs/mkws.js

   1 /* A very simple client that shows a basic usage of the pz2.js
   2 */
   3
   4 "use strict"; // HTML5: disable for debug_level >= 2
   5
   6 // Set up namespace and some state.
   7 var mkws = {
   8     filters: [],
   9 };
  10
  11 /*
  12  * global config object: mkws_config
  13  *
  14  * Needs to be defined in the HTML header before including this JS file.
  15  * Define empty mkws_config for simple applications that don't define it.
  16  */
  17 if (!mkws_config)
  18     var mkws_config = {};
  19
  20 // Wrapper for jQuery
  21 (function ($) {
  22
  23 mkws.locale_lang = {
  24     "de": {
  25         "Authors": "Autoren",
  26         "Subjects": "Schlagw&ouml;rter",
  27         "Sources": "Daten und Quellen",
  28         "Termlists": "Termlisten",
  29         "Next": "Weiter",
  30         "Prev": "Zur&uuml;ck",
  31         "Search": "Suche",
  32         "Sort by": "Sortieren nach",
  33         "and show": "und zeige",
  34         "per page": "pro Seite",
  35         "Displaying": "Zeige",
  36         "to": "von",
  37         "of": "aus",
  38         "found": "gefunden",
  39         "Title": "Titel",
  40         "Author": "Autor",
  41         "Date": "Datum",
  42         "Subject": "Schlagwort",
  43         "Location": "Ort",
  44         // ### to add: Records, Targets
  45
  46         "dummy": "dummy"
  47     },
  48
  49     "da": {
  50         "Authors": "Forfattere",
  51         "Subjects": "Emner",
  52         "Sources": "Kilder",
  53         "Termlists": "Termlists",
  54         "Next": "N&aelig;ste",
  55         "Prev": "Forrige",
  56         "Search": "S&oslash;g",
  57         "Sort by": "Sorter efter",
  58         "and show": "og vis",
  59         "per page": "per side",
  60         "Displaying": "Viser",
  61         "to": "til",
  62         "of": "ud af",
  63         "found": "fandt",
  64         "Title": "Title",
  65         "Author": "Forfatter",
  66         "Date": "Dato",
  67         "Subject": "Emneord",
  68         "Location": "Lokation",
  69         // ### to add: Records, Targets
  70
  71         "dummy": "dummy"
  72     }
  73 };
  74
  75 // keep time state for debugging
  76 mkws.debug_time = {
  77     "start": $.now(),
  78     "last": $.now()
  79 };
  80
  81 mkws.debug_function = function (string) {
  82     if (!mkws.debug_level)
  83         return;
  84
  85     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  86         return;
  87     }
  88
  89     var now = $.now();
  90     var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
  91     mkws.debug_time.last = now;
  92
  93     // you need to disable use strict at the top of the file!!!
  94     if (mkws.debug_level >= 3) {
  95         console.log(timestamp + arguments.callee.caller);
  96     } else if (mkws.debug_level >= 2) {
  97         console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
  98     }
  99     console.log(timestamp + string);
 100 }
 101 var debug = mkws.debug_function; // local alias
 102
 103
 104 Handlebars.registerHelper('link', function(a) {
 105     var result = "";
 106     for (var i in a) {
 107         if (i > 0) result += "<br/>";
 108         var text = Handlebars.Utils.escapeExpression(a[i]);
 109         result += '<a href="' + text + '">' + text + '</a>';
 110     }
 111
 112     return new Handlebars.SafeString(result);
 113 });
 114
 115
 116 Handlebars.registerHelper('json', function(obj) {
 117     return JSON.stringify(obj);
 118 });
 119
 120
 121 Handlebars.registerHelper('first', function(items, options) {
 122     return options.fn(items[0]);
 123 });
 124
 125
 126 {
 127     /* default mkws config */
 128     var config_default = {
 129         use_service_proxy: true,
 130         service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth",
 131         lang: "",
 132         sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 133         perpage_options: [10, 20, 30, 50],
 134         sort_default: "relevance",
 135         perpage_default: 20,
 136         query_width: 50,
 137         show_lang: true,        /* show/hide language menu */
 138         show_sort: true,        /* show/hide sort menu */
 139         show_perpage: true,     /* show/hide perpage menu */
 140         lang_options: [],       /* display languages links for given languages, [] for all */
 141         facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
 142         responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 143         debug_level: 1,     /* debug level for development: 0..2 */
 144
 145         dummy: "dummy"
 146     };
 147
 148     /* set global debug_level flag early */
 149     if (typeof mkws_config.debug_level !== 'undefined') {
 150         mkws.debug_level = mkws_config.debug_level;
 151     } else if (typeof config_default.debug_level !== 'undefined') {
 152         mkws.debug_level = config_default.debug_level;
 153     }
 154
 155     /* override standard config values by function parameters */
 156     for (var k in config_default) {
 157         if (typeof mkws_config[k] === 'undefined')
 158            mkws_config[k] = config_default[k];
 159         debug("Set config: " + k + ' => ' + mkws_config[k]);
 160     }
 161 }
 162
 163 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
 164     debug("Reset query width: " + mkws_config.query_width);
 165     mkws_config.query_width = 50;
 166 }
 167
 168 for (var key in mkws_config) {
 169     if (mkws_config.hasOwnProperty(key)) {
 170         if (key.match(/^language_/)) {
 171             var lang = key.replace(/^language_/, "");
 172             // Copy custom languages into list
 173             mkws.locale_lang[lang] = mkws_config[key];
 174             debug("Added locally configured language '" + lang + "'");
 175         }
 176     }
 177 }
 178
 179
 180 // create a parameters array and pass it to the pz2's constructor
 181 // then register the form submit event with the pz2.search function
 182 // autoInit is set to true on default
 183 var my_paz = new pz2( { "onshow": my_onshow,
 184                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
 185                     "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/",
 186                     "oninit": my_oninit,
 187                     "onstat": my_onstat,
 188                     "onterm": my_onterm,
 189                     "termlist": "xtargets,subject,author",
 190                     "onbytarget": my_onbytarget,
 191                     "usesessions" : mkws_config.use_service_proxy ? false : true,
 192                     "showResponseType": '', // or "json" (for debugging?)
 193                     "onrecord": my_onrecord } );
 194
 195 mkws.my_paz = my_paz; // export
 196
 197 // some state vars
 198 var curPage = 1;
 199 var recPerPage = 20;
 200 var totalRec = 0;
 201 var curDetRecId = '';
 202 var curDetRecData = null;
 203 var curSort = 'relevance';
 204 var submitted = false;
 205 var SourceMax = 16;
 206 var SubjectMax = 10;
 207 var AuthorMax = 10;
 208
 209 //
 210 // pz2.js event handlers:
 211 //
 212 function my_oninit() {
 213     my_paz.stat();
 214     my_paz.bytarget();
 215 }
 216
 217 function my_onshow(data) {
 218     totalRec = data.merged;
 219     // move it out
 220     var pager = document.getElementById("mkwsPager");
 221     if (pager) {
 222         pager.innerHTML = "";
 223         pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
 224             + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
 225             ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
 226             + data.total + ')</div>';
 227         drawPager(pager);
 228     }
 229
 230     // navi
 231     var results = document.getElementById("mkwsRecords");
 232
 233     var html = [];
 234     for (var i = 0; i < data.hits.length; i++) {
 235         var hit = data.hits[i];
 236               html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
 237             +'<a href="#" id="mkwsRec_'+hit.recid
 238             +'" onclick="mkws.showDetails(this.id);return false;"><b>'
 239             + hit["md-title"] +' </b></a>');
 240               if (hit["md-title-remainder"] !== undefined) {
 241                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
 242               }
 243               if (hit["md-title-responsibility"] !== undefined) {
 244             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
 245         }
 246         if (hit.recid == curDetRecId) {
 247             html.push(renderDetails(curDetRecData));
 248         }
 249         html.push('</div>');
 250     }
 251     replaceHtml(results, html.join(''));
 252 }
 253
 254 function my_onstat(data) {
 255     var stat = document.getElementById("mkwsStat");
 256     if (stat == null)
 257         return;
 258
 259     stat.innerHTML = '<span class="head">' + M('Status info') + '</span>' +
 260         ' -- ' +
 261         '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
 262         ' -- ' +
 263         '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
 264 }
 265
 266 function my_onterm(data) {
 267     // no facets
 268     if (!mkws_config.facets || mkws_config.facets.length == 0) {
 269         $("#mkwsTermlists").hide();
 270         return;
 271     }
 272
 273     // display if we first got results
 274     $("#mkwsTermlists").show();
 275
 276     var acc = [];
 277     acc.push('<div class="title">' + M('Termlists') + '</div>');
 278     var facets = mkws_config.facets;
 279
 280     for(var i = 0; i < facets.length; i++) {
 281         if (facets[i] == "sources") {
 282             add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
 283         } else if (facets[i] == "subjects") {
 284             add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "subject");
 285         } else if (facets[i] == "authors") {
 286             add_single_facet(acc, "Authors",  data.author,   AuthorMax, "author");
 287         } else {
 288             alert("bad facet configuration: '" + facets[i] + "'");
 289         }
 290     }
 291
 292     var termlist = document.getElementById("mkwsTermlists");
 293     replaceHtml(termlist, acc.join(''));
 294 }
 295
 296 function add_single_facet(acc, caption, data, max, pzIndex) {
 297     acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
 298     acc.push('<div class="termtitle">' + M(caption) + '</div>');
 299     for (var i = 0; i < data.length && i < max; i++ ) {
 300         acc.push('<div class="term">');
 301         acc.push('<a href="#" ');
 302         var action;
 303         if (!pzIndex) {
 304             // Special case: target selection
 305             acc.push('target_id='+data[i].id+' ');
 306             action = 'mkws.limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
 307         } else {
 308             action = 'mkws.limitQuery(\'' + pzIndex + '\', this.firstChild.nodeValue)';
 309         }
 310         acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
 311                  + ' <span>' + data[i].freq + '</span>');
 312         acc.push('</div>');
 313     }
 314     acc.push('</div>');
 315 }
 316
 317 function my_onrecord(data) {
 318     // FIXME: record is async!!
 319     clearTimeout(my_paz.recordTimer);
 320     // in case on_show was faster to redraw element
 321     var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
 322     if (detRecordDiv) return;
 323     curDetRecData = data;
 324     var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
 325     var html = renderDetails(curDetRecData);
 326     recordDiv.innerHTML += html;
 327 }
 328
 329 function my_onbytarget(data) {
 330     var targetDiv = document.getElementById("mkwsBytarget");
 331     if (!targetDiv) {
 332         // No mkwsTargets div.
 333         return;
 334     }
 335
 336     var table ='<table><thead><tr>' +
 337         '<td>' + M('Target ID') + '</td>' +
 338         '<td>' + M('Hits') + '</td>' +
 339         '<td>' + M('Diags') + '</td>' +
 340         '<td>' + M('Records') + '</td>' +
 341         '<td>' + M('State') + '</td>' +
 342         '</tr></thead><tbody>';
 343
 344     for (var i = 0; i < data.length; i++ ) {
 345         table += "<tr><td>" + data[i].id +
 346             "</td><td>" + data[i].hits +
 347             "</td><td>" + data[i].diagnostic +
 348             "</td><td>" + data[i].records +
 349             "</td><td>" + data[i].state + "</td></tr>";
 350     }
 351
 352     table += '</tbody></table>';
 353     targetDiv.innerHTML = table;
 354 }
 355
 356 ////////////////////////////////////////////////////////////////////////////////
 357 ////////////////////////////////////////////////////////////////////////////////
 358
 359 // wait until the DOM is ready
 360 function domReady ()
 361 {
 362     document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
 363     document.mkwsSearchForm.mkwsQuery.value = '';
 364     if (document.mkwsSelect) {
 365         if (document.mkwsSelect.mkwsSort)
 366             document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
 367         if (document.mkwsSelect.mkwsPerpage)
 368             document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
 369     }
 370 }
 371
 372 // when search button pressed
 373 function onFormSubmitEventHandler()
 374 {
 375     resetPage();
 376     loadSelect();
 377     triggerSearch();
 378     mkws.switchView('records'); // In case it's configured to start off as hidden
 379     submitted = true;
 380     return false;
 381 }
 382
 383 function onSelectDdChange()
 384 {
 385     if (!submitted) return false;
 386     resetPage();
 387     loadSelect();
 388     my_paz.show(0, recPerPage, curSort);
 389     return false;
 390 }
 391
 392 function resetPage()
 393 {
 394     curPage = 1;
 395     totalRec = 0;
 396 }
 397
 398 function triggerSearch ()
 399 {
 400     var pp2filter = "";
 401     var pp2limit = "";
 402
 403     for (var i in mkws.filters) {
 404         var filter = mkws.filters[i];
 405         if (filter.id) {
 406             if (pp2filter)
 407                 pp2filter += ",";
 408             pp2filter += 'pz:id=' + filter.id;
 409         } else {
 410             if (pp2limit)
 411                 pp2limit += ",";
 412             pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
 413         }
 414     }
 415
 416     debug("triggerSearch: filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
 417     my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, pp2filter, undefined, { limit: pp2limit });
 418 }
 419
 420 function loadSelect ()
 421 {
 422     if (document.mkwsSelect) {
 423         if (document.mkwsSelect.mkwsSort)
 424             curSort = document.mkwsSelect.mkwsSort.value;
 425         if (document.mkwsSelect.mkwsPerpage)
 426             recPerPage = document.mkwsSelect.mkwsPerpage.value;
 427     }
 428 }
 429
 430 // limit the query after clicking the facet
 431 mkws.limitQuery = function (field, value)
 432 {
 433     debug("limitQuery(field=" + field + ", value=" + value + ")");
 434     mkws.filters.push({ field: field, value: value });
 435     redraw_navi();
 436     resetPage();
 437     loadSelect();
 438     triggerSearch();
 439     return false;
 440 }
 441
 442 // limit by target functions
 443 mkws.limitTarget  = function (id, name)
 444 {
 445     debug("limitTarget(id=" + id + ", name=" + name + ")");
 446     mkws.filters.push({ id: id, name: name });
 447     redraw_navi();
 448     resetPage();
 449     loadSelect();
 450     triggerSearch();
 451     return false;
 452 }
 453
 454 mkws.delimitQuery = function (field, value)
 455 {
 456     debug("delimitQuery(field=" + field + ", value=" + value + ")");
 457     var newFilters = [];
 458     for (var i in mkws.filters) {
 459         var filter = mkws.filters[i];
 460         if (filter.field &&
 461             field == filter.field &&
 462             value == filter.value) {
 463             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 464         } else {
 465             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 466             newFilters.push(filter);
 467         }
 468     }
 469     mkws.filters = newFilters;
 470
 471     redraw_navi();
 472     resetPage();
 473     loadSelect();
 474     triggerSearch();
 475     return false;
 476 }
 477
 478
 479 mkws.delimitTarget = function (id)
 480 {
 481     debug("delimitTarget(id=" + id + ")");
 482     var newFilters = [];
 483     for (var i in mkws.filters) {
 484         var filter = mkws.filters[i];
 485         if (filter.id) {
 486             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 487         } else {
 488             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 489             newFilters.push(filter);
 490         }
 491     }
 492     mkws.filters = newFilters;
 493
 494     redraw_navi();
 495     resetPage();
 496     loadSelect();
 497     triggerSearch();
 498     return false;
 499 }
 500
 501
 502 function redraw_navi ()
 503 {
 504     var navi = document.getElementById('mkwsNavi');
 505     if (!navi) return;
 506
 507     var text = "";
 508     for (var i in mkws.filters) {
 509         if (text) {
 510             text += " | ";
 511         }
 512         var filter = mkws.filters[i];
 513         if (filter.id) {
 514             text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
 515                 "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
 516         } else {
 517             text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
 518                 "'" + filter.field + "', '" + filter.value + "'" +
 519                 ');return false;">' + filter.value + '</a>';
 520         }
 521     }
 522
 523     navi.innerHTML = text;
 524 }
 525
 526
 527 function drawPager (pagerDiv)
 528 {
 529     //client indexes pages from 1 but pz2 from 0
 530     var onsides = 6;
 531     var pages = Math.ceil(totalRec / recPerPage);
 532
 533     var firstClkbl = ( curPage - onsides > 0 )
 534         ? curPage - onsides
 535         : 1;
 536
 537     var lastClkbl = firstClkbl + 2*onsides < pages
 538         ? firstClkbl + 2*onsides
 539         : pages;
 540
 541     var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
 542     if (curPage > 1)
 543         prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
 544         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 545
 546     var middle = '';
 547     for(var i = firstClkbl; i <= lastClkbl; i++) {
 548         var numLabel = i;
 549         if(i == curPage)
 550             numLabel = '<b>' + i + '</b>';
 551
 552         middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
 553             + numLabel + ' </a>';
 554     }
 555
 556     var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
 557     if (pages - curPage > 0)
 558         next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
 559         + M('Next') + ' &#62;&#62;</a>';
 560
 561     var predots = '';
 562     if (firstClkbl > 1)
 563         predots = '...';
 564
 565     var postdots = '';
 566     if (lastClkbl < pages)
 567         postdots = '...';
 568
 569     pagerDiv.innerHTML += '<div style="float: clear">'
 570         + prev + predots + middle + postdots + next + '</div>';
 571 }
 572
 573 mkws.showPage = function (pageNum)
 574 {
 575     curPage = pageNum;
 576     my_paz.showPage( curPage - 1 );
 577 }
 578
 579 // simple paging functions
 580
 581 mkws.pagerNext = function () {
 582     if ( totalRec - recPerPage*curPage > 0) {
 583         my_paz.showNext();
 584         curPage++;
 585     }
 586 }
 587
 588 mkws.pagerPrev = function () {
 589     if ( my_paz.showPrev() != false )
 590         curPage--;
 591 }
 592
 593 // switching view between targets and records
 594
 595 mkws.switchView = function(view) {
 596     debug("switchView: " + view);
 597
 598     var targets = document.getElementById('mkwsTargets');
 599     var results = document.getElementById('mkwsResults') ||
 600                   document.getElementById('mkwsRecords');
 601     var blanket = document.getElementById('mkwsBlanket');
 602     var motd    = document.getElementById('mkwsMOTD');
 603
 604     switch(view) {
 605         case 'targets':
 606             if (targets) targets.style.display = "block";
 607             if (results) results.style.display = "none";
 608             if (blanket) blanket.style.display = "none";
 609             if (motd) motd.style.display = "none";
 610             break;
 611         case 'records':
 612             if (targets) targets.style.display = "none";
 613             if (results) results.style.display = "block";
 614             if (blanket) blanket.style.display = "block";
 615             if (motd) motd.style.display = "none";
 616             break;
 617         case 'none':
 618             if (targets) targets.style.display = "none";
 619             if (results) results.style.display = "none";
 620             if (blanket) blanket.style.display = "none";
 621             if (motd) motd.style.display = "none";
 622             break;
 623         default:
 624             alert("Unknown view '" + view + "'");
 625     }
 626 }
 627
 628 // detailed record drawing
 629 mkws.showDetails = function (prefixRecId) {
 630     var recId = prefixRecId.replace('mkwsRec_', '');
 631     var oldRecId = curDetRecId;
 632     curDetRecId = recId;
 633
 634     // remove current detailed view if any
 635     var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
 636     // lovin DOM!
 637     if (detRecordDiv)
 638       detRecordDiv.parentNode.removeChild(detRecordDiv);
 639
 640     // if the same clicked, just hide
 641     if (recId == oldRecId) {
 642         curDetRecId = '';
 643         curDetRecData = null;
 644         return;
 645     }
 646     // request the record
 647     my_paz.record(recId);
 648 }
 649
 650 function replaceHtml(el, html) {
 651   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 652   /*@cc_on // Pure innerHTML is slightly faster in IE
 653     oldEl.innerHTML = html;
 654     return oldEl;
 655     @*/
 656   var newEl = oldEl.cloneNode(false);
 657   newEl.innerHTML = html;
 658   oldEl.parentNode.replaceChild(newEl, oldEl);
 659   /* Since we just removed the old element from the DOM, return a reference
 660      to the new element, which can be used to restore variable references. */
 661   return newEl;
 662 };
 663
 664 function renderDetails(data, marker)
 665 {
 666     if (mkws.templateRecord === undefined) {
 667         maybeLoadTemplate("Record");
 668     }
 669
 670     var details;
 671     if (mkws.templateRecord) {
 672         var template = mkws.templateRecord;
 673         details = template(data);
 674     } else {
 675         details = defaultRenderDetails(data, marker);
 676     }
 677
 678     return '<div class="details" id="mkwsDet_' + data.recid + '">' + details + '</div>';
 679 }
 680
 681
 682 function maybeLoadTemplate(name)
 683 {
 684     var source = $("#mkwsTemplate" + name).html();
 685     if (!source) {
 686         debug("no template '" + name + "': falling back to default behaviour");
 687         // Mark template as not provided
 688         mkws['template' + name] = 0;
 689         return;
 690     }
 691
 692     var template = Handlebars.compile(source);
 693     debug("compiled template '" + name + "'");
 694     mkws['template' + name] = template;
 695 }
 696
 697
 698 function defaultRenderDetails(data, marker)
 699 {
 700     var details = '<table>';
 701     if (marker) details += '<tr><td colspan="2">'+ marker + '</td></tr>';
 702
 703     var locations = [];
 704     for (var i in data.location) {
 705         locations.push(data.location[i]['@name']);
 706     }
 707
 708     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
 709     details += renderField("Date", data["md-date"]);
 710     details += renderField("Author", data["md-author"]);
 711     details += renderField("URL", data["md-electronic-url"]);
 712     details += renderField("Subject", data["location"][0]["md-subject"]);
 713     if (locations.length == 0) {
 714         details += '<tr><td colspan="2">No locations for record!</td></tr>';
 715     } else {
 716         details += renderField("Location" + (locations.length == 1 ? "" : "s"), locations);
 717     }
 718     details += '</table>';
 719     return details;
 720 }
 721
 722
 723 function renderField(caption, data, data2, data3) {
 724     if (data === undefined) {
 725         return "";
 726     }
 727
 728     var res = "";
 729     for (var i = 0; i < data.length; i++) {
 730         var s = data[i];
 731         if (i > 0)
 732             res += ", ";
 733
 734         if (caption == "URL")
 735             s = '<a href="' + s + '" target="_blank">' + s + '</a>';
 736
 737         res += s
 738     }
 739
 740     if (data2 != undefined) {
 741         res = res + " (" + data2 + ")";
 742     }
 743
 744     if (data3 != undefined) {
 745         res = res + " <i>" + data3 + "</i>";
 746     }
 747
 748     return '<tr><th>' + M(caption) + '</th><td>' + res + '</td></tr>';
 749 }
 750
 751
 752 /*
 753  * All the HTML stuff to render the search forms and
 754  * result pages.
 755  */
 756 function mkws_html_all() {
 757     mkws_set_lang();
 758     if (mkws_config.show_lang)
 759         mkws_html_lang();
 760
 761     // For some reason, doing this programmatically results in
 762     // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
 763     debug("HTML search form");
 764     $("#mkwsSearch").html('\
 765     <form name="mkwsSearchForm" action="" >\
 766       <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
 767       <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
 768     </form>');
 769
 770     debug("HTML records");
 771     // If the application has an #mkwsResults, populate it in the
 772     // usual way. If not, assume that it's a smarter application that
 773     // defines its own subcomponents:
 774     //  #mkwsTermlists
 775     //  #mkwsRanking
 776     //  #mkwsPager
 777     //  #mkwsNavi
 778     //  #mkwsRecords
 779     if ($("#mkwsResults").length) {
 780         $("#mkwsResults").html('\
 781       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 782         <tr>\
 783           <td id="mkwsTermlistContainer1" width="250" valign="top">\
 784             <div id="mkwsTermlists"></div>\
 785           </td>\
 786           <td id="mkwsMOTDContainer" valign="top">\
 787             <div id="mkwsRanking"></div>\
 788             <div id="mkwsPager"></div>\
 789             <div id="mkwsNavi"></div>\
 790             <div id="mkwsRecords"></div>\
 791           </td>\
 792         </tr>\
 793         <tr>\
 794           <td colspan="2">\
 795             <div id="mkwsTermlistContainer2"></div>\
 796           </td>\
 797         </tr>\
 798       </table>');
 799     }
 800
 801     if ($("#mkwsRanking").length) {
 802         var ranking_data = '';
 803         ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
 804         if (mkws_config.show_sort) {
 805             ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
 806         }
 807         if (mkws_config.show_perpage) {
 808             ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
 809         }
 810         ranking_data += '</form>';
 811
 812         $("#mkwsRanking").html(ranking_data);
 813     }
 814
 815     mkws_html_switch();
 816
 817     if (mkws_config.use_service_proxy)
 818           mkws_service_proxy_auth(mkws_config.service_proxy_auth,
 819           mkws_config.service_proxy_auth_domain);
 820
 821     if (mkws_config.responsive_design_width) {
 822         // Responsive web design - change layout on the fly based on
 823         // current screen width. Required for mobile devices.
 824         $(window).resize( function(e) { mkws_resize_page() });
 825         // initial check after page load
 826         $(document).ready(function() { mkws_resize_page() });
 827     }
 828
 829     domReady();
 830
 831     // on first page, hide the termlist
 832     $(document).ready(function() { $("#mkwsTermlists").hide(); } );
 833     var motd = document.getElementById("mkwsMOTD");
 834     var container = document.getElementById("mkwsMOTDContainer");
 835     if (motd && container) {
 836         // Move the MOTD from the provided element down into the container
 837         motd.parentNode.removeChild(motd);
 838         container.appendChild(motd);
 839     }
 840 }
 841
 842 function mkws_set_lang()  {
 843     var lang = $.parseQuerystring().lang || mkws_config.lang;
 844     if (!lang || !mkws.locale_lang[lang]) {
 845         mkws_config.lang = ""
 846     } else {
 847         mkws_config.lang = lang;
 848     }
 849
 850     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
 851     return mkws_config.lang;
 852 }
 853
 854 function mkws_html_switch() {
 855     debug("HTML switch");
 856
 857     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
 858     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
 859     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
 860
 861     debug("HTML targets");
 862     $("#mkwsTargets").html('\
 863       <div id="mkwsBytarget">\
 864        No information available yet.\
 865       </div>');
 866     $("#mkwsTargets").css("display", "none");
 867 }
 868
 869 function mkws_html_sort() {
 870     debug("HTML sort");
 871     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 872
 873     for(var i = 0; i < mkws_config.sort_options.length; i++) {
 874         var opt = mkws_config.sort_options[i];
 875         var key = opt[0];
 876         var val = opt.length == 1 ? opt[0] : opt[1];
 877
 878         sort_html += '<option value="' + key + '"';
 879         if (key == mkws_config.sort_default) {
 880             sort_html += ' selected="selected"';
 881         }
 882         sort_html += '>' + M(val) + '</option>';
 883     }
 884     sort_html += '</select>';
 885
 886     return sort_html;
 887 }
 888
 889 function mkws_html_perpage() {
 890     debug("HTML perpage");
 891     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
 892
 893     for(var i = 0; i < mkws_config.perpage_options.length; i++) {
 894         var key = mkws_config.perpage_options[i];
 895
 896         perpage_html += '<option value="' + key + '"';
 897         if (key == mkws_config.perpage_default) {
 898             perpage_html += ' selected="selected"';
 899         }
 900         perpage_html += '>' + key + '</option>';
 901     }
 902     perpage_html += '</select>';
 903
 904     return perpage_html;
 905 }
 906
 907 /*
 908  * Run service-proxy authentication in background (after page load).
 909  * The username/password is configured in the apache config file
 910  * for the site.
 911  */
 912 function mkws_service_proxy_auth(auth_url, auth_domain) {
 913     debug("Run service proxy auth URL: " + auth_url);
 914
 915     var request = new pzHttpRequest(auth_url, function(err) {
 916           alert("HTTP call for authentication failed: " + err)
 917           return;
 918     }, auth_domain);
 919
 920     request.get(null, function(data) {
 921         if (!$.isXMLDoc(data)) {
 922             alert("service proxy auth response document is not valid XML document, give up!");
 923             return;
 924         }
 925         var status = $(data).find("status");
 926         if (status.text() != "OK") {
 927             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
 928             return;
 929         }
 930
 931         debug("Service proxy auth successfully done");
 932         mkws.service_proxy_auth = true;
 933     });
 934 }
 935
 936 /* create locale language menu */
 937 function mkws_html_lang() {
 938     var lang_default = "en";
 939     var lang = mkws_config.lang || lang_default;
 940     var list = [];
 941
 942     /* display a list of configured languages, or all */
 943     var lang_options = mkws_config.lang_options || [];
 944     var hash = {};
 945     for (var i = 0; i < lang_options.length; i++) {
 946         hash[lang_options[i]] = 1;
 947     }
 948
 949     for (var k in mkws.locale_lang) {
 950         if (hash[k] == 1 || lang_options.length == 0)
 951             list.push(k);
 952     }
 953
 954     // add english link
 955     if (lang_options.length == 0 || hash[lang_default] == 1)
 956         list.push(lang_default);
 957
 958     debug("Language menu for: " + list.join(", "));
 959
 960     /* the HTML part */
 961     var data = "";
 962     for(var i = 0; i < list.length; i++) {
 963         var l = list[i];
 964
 965         if (data)
 966             data += ' | ';
 967
 968         if (lang == l) {
 969             data += ' <span>' + l + '</span> ';
 970         } else {
 971             data += ' <a href="?lang=' + l + '">' + l + '</a> '
 972         }
 973     }
 974
 975     $("#mkwsLang").html(data);
 976 }
 977
 978 function mkws_resize_page () {
 979     var list = ["mkwsSwitch"];
 980
 981     var width = mkws_config.responsive_design_width;
 982     var parentId = $("#mkwsTermlists").parent().attr('id');
 983
 984     if ($(window).width() <= width &&
 985         parentId === "mkwsTermlistContainer1") {
 986         debug("changing from wide to narrow: " + $(window).width());
 987         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
 988         $("#mkwsTermlistContainer1").hide();
 989         $("#mkwsTermlistContainer2").show();
 990         for(var i = 0; i < list.length; i++) {
 991             $("#" + list[i]).hide();
 992         }
 993     } else if ($(window).width() > width &&
 994         parentId === "mkwsTermlistContainer2") {
 995         debug("changing from narrow to wide: " + $(window).width());
 996         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
 997         $("#mkwsTermlistContainer1").show();
 998         $("#mkwsTermlistContainer2").hide();
 999         for(var i = 0; i < list.length; i++) {
1000             $("#" + list[i]).show();
1001         }
1002     }
1003 };
1004
1005 /* locale */
1006 function M(word) {
1007     var lang = mkws_config.lang;
1008
1009     if (!lang || !mkws.locale_lang[lang])
1010         return word;
1011
1012     return mkws.locale_lang[lang][word] || word;
1013 }
1014
1015 /*
1016  * implement jQuery plugins
1017  */
1018 $.extend({
1019     // implement $.parseQuerystring() for parsing URL parameters
1020     parseQuerystring: function() {
1021         var nvpair = {};
1022         var qs = window.location.search.replace('?', '');
1023         var pairs = qs.split('&');
1024         $.each(pairs, function(i, v){
1025             var pair = v.split('=');
1026             nvpair[pair[0]] = pair[1];
1027         });
1028         return nvpair;
1029     },
1030
1031     debug2: function(string) { // delayed debug, internal variables are set after dom ready
1032         setTimeout(function() { debug(string); }, 500);
1033     },
1034
1035     // service-proxy or pazpar2
1036     pazpar2: function(config) {
1037         var id_popup = config.id_popup || "#mkwsPopup";
1038         id_popup = id_popup.replace(/^#/, "");
1039
1040         // simple layout
1041         var div = '<div id="mkwsSwitch"></div>\
1042         <div id="mkwsLang"></div>\
1043         <div id="mkwsSearch"></div>\
1044         <div id="mkwsResults"></div>\
1045         <div id="mkwsTargets"></div>\
1046         <div id="mkwsStat"></div>';
1047
1048         // new table layout
1049         var table = '\
1050         <style type="text/css">\
1051           #mkwsTermlists div.facet {\
1052           float:left;\
1053           width: 30%;\
1054           margin: 0.3em;\
1055           }\
1056           #mkwsStat {\
1057           text-align: right;\
1058           }\
1059         </style>\
1060             \
1061         <table width="100%" border="0">\
1062           <tr>\
1063             <td>\
1064               <div id="mkwsSwitch"></div>\
1065               <div id="mkwsLang"></div>\
1066               <div id="mkwsSearch"></div>\
1067             </td>\
1068           </tr>\
1069           <tr>\
1070             <td>\
1071               <div style="height:500px; overflow: auto">\
1072                 <div id="mkwsPager"></div>\
1073                 <div id="mkwsNavi"></div>\
1074                 <div id="mkwsRecords"></div>\
1075                 <div id="mkwsTargets"></div>\
1076                 <div id="mkwsRanking"></div>\
1077               </div>\
1078             </td>\
1079           </tr>\
1080           <tr>\
1081             <td>\
1082               <div style="height:300px; overflow: hidden">\
1083                 <div id="mkwsTermlists"></div>\
1084               </div>\
1085             </td>\
1086           </tr>\
1087           <tr>\
1088             <td>\
1089               <div id="mkwsStat"></div>\
1090             </td>\
1091           </tr>\
1092         </table>';
1093
1094         var popup = '\
1095           <div id="mkwsSearch"></div>\
1096           <div id="' + id_popup + '">\
1097             <div id="mkwsSwitch"></div>\
1098             <div id="mkwsLang"></div>\
1099             <div id="mkwsResults"></div>\
1100             <div id="mkwsTargets"></div>\
1101             <div id="mkwsStat"></div>\
1102           </div>'
1103
1104         if (config && config.layout == 'div') {
1105             this.debug2("jquery plugin layout: div");
1106             document.write(div);
1107         } else if (config && config.layout == 'popup') {
1108             this.debug2("jquery plugin layout: popup with id: " + id_popup);
1109             document.write(popup);
1110             $(document).ready( function() { init_popup(config); } );
1111         } else {
1112             this.debug2("jquery plugin layout: table");
1113             document.write(table);
1114         }
1115     }
1116 });
1117
1118 function init_popup(obj) {
1119     var config = obj ? obj : {};
1120
1121     var height = config.height || 760;
1122     var width = config.width || 880;
1123     var id_button = config.id_button || "input#mkwsButton";
1124     var id_popup = config.id_popup || "#mkwsPopup";
1125
1126     debug("popup height: " + height + ", width: " + width);
1127
1128     // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
1129     // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
1130     if (!$.ui) {
1131         debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
1132         return;
1133     }
1134
1135     $(id_popup).dialog({
1136       closeOnEscape: true,
1137       autoOpen: false,
1138       height: height,
1139       width: width,
1140       modal: true,
1141       resizable: true,
1142       buttons: {
1143               Cancel: function() {
1144                       $(this).dialog("close");
1145               }
1146       },
1147       close: function() { }
1148     });
1149
1150     $(id_button)
1151       .button()
1152       .click(function() {
1153               $(id_popup).dialog("open");
1154       });
1155 };
1156
1157
1158
1159
1160 /* magic */
1161 $(document).ready(function() {
1162     try {
1163         mkws_html_all()
1164     }
1165
1166     catch (e) {
1167         mkws_config.error = e.message;
1168         // alert(e.message);
1169     }
1170 });
1171
1172 })(jQuery);