switchView() supports argument 'none'
[mkws-moved-to-github.git] / experiments / spclient / 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 >= 2
5
6 /* 
7  * global config object: mkws_config 
8  * 
9  * needs to be defined in the HTML header before 
10  * including this JS file
11  */
12
13 if (!mkws_config)
14     var mkws_config = {}; // for the guys who forgot to define mkws_config...
15
16 if (typeof mkws_config.use_service_proxy === 'undefined')
17     mkws_config.use_service_proxy = true;
18
19 var mkws_debug = 1;
20
21 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
22 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
23
24 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
25 var usesessions = mkws_config.use_service_proxy ? false : true;
26
27
28 var mkws_locale_lang = {
29     "de": {
30         "Authors": "Autoren",
31         "Subjects": "Schlagwörter",
32         "Sources": "Daten und Quellen",
33         "TERMLISTS": "Termlisten",
34         "Next": "Weiter",
35         "Prev": "Zurück",
36         "Search": "Suche",
37         "Sort by": "Sortieren nach",
38         "and show": "und zeige",
39         "per page": "pro Seite",
40         "Displaying": "Zeige",
41         "to": "von",
42         "of": "aus",
43         "found": "gefunden",
44         "Title": "Titel",
45         "Author": "Autor",
46         "Date": "Datum",
47         "Subject": "Schlagwort",
48         "Location": "Ort",
49
50         "dummy": "dummy"
51     },
52
53     "da": {
54         "Authors": "Forfattere",
55         "Subjects": "Emner",
56         "Sources": "Kilder",
57         "TERMLISTS": "TERMLISTS",
58         "Next": "Næste",
59         "Prev": "Forrige",
60         "Search": "Søg",
61         "Sort by": "Sorter efter",
62         "and show": "og vis",
63         "per page": "per side",
64         "Displaying": "Viser",
65         "to": "til",
66         "of": "ud af",
67         "found": "fandt",
68         "Title": "Title",
69         "Author": "Forfatter",
70         "Date": "Dato",
71         "Subject": "Emneord",
72         "Location": "Lokation",
73
74         "dummy": "dummy"
75     }
76 };
77
78 // create a parameters array and pass it to the pz2's constructor
79 // then register the form submit event with the pz2.search function
80 // autoInit is set to true on default
81 var my_paz = new pz2( { "onshow": my_onshow,
82                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
83                     "pazpar2path": pazpar2path,
84                     "oninit": my_oninit,
85                     "onstat": my_onstat,
86                     "onterm": my_onterm,
87                     "termlist": "xtargets,subject,author",
88                     "onbytarget": my_onbytarget,
89                     "usesessions" : usesessions,
90                     "showResponseType": '', // or "json" (for debugging?)
91                     "onrecord": my_onrecord } );
92 // some state vars
93 var curPage = 1;
94 var recPerPage = 20;
95 var totalRec = 0;
96 var curDetRecId = '';
97 var curDetRecData = null;
98 var curSort = 'relevance';
99 var curFilter = null;
100 var submitted = false;
101 var SourceMax = 16;
102 var SubjectMax = 10;
103 var AuthorMax = 10;
104
105 //
106 // pz2.js event handlers:
107 //
108 function my_oninit() {
109     my_paz.stat();
110     my_paz.bytarget();
111 }
112
113 function my_onshow(data) {
114     totalRec = data.merged;
115     // move it out
116     var pager = document.getElementById("pager");
117     pager.innerHTML = "";
118     pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
119                     + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
120                      ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
121                      + data.total + ')</div>';
122     drawPager(pager);
123     // navi
124     var results = document.getElementById("results");
125
126     var html = [];
127     for (var i = 0; i < data.hits.length; i++) {
128         var hit = data.hits[i];
129               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
130             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
131             +'<a href="#" id="rec_'+hit.recid
132             +'" onclick="showDetails(this.id);return false;"><b>'
133             + hit["md-title"] +' </b></a>');
134               if (hit["md-title-remainder"] !== undefined) {
135                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
136               }
137               if (hit["md-title-responsibility"] !== undefined) {
138             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
139         }
140         if (hit.recid == curDetRecId) {
141             html.push(renderDetails(curDetRecData));
142         }
143         html.push('</div>');
144     }
145     replaceHtml(results, html.join(''));
146 }
147
148 function my_onstat(data) {
149     var stat = document.getElementById("mkwsStat");
150     if (stat == null)
151         return;
152
153     stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
154                         + data.activeclients
155                         + '/' + data.clients + ' -- </span>'
156                         + '<span>Retrieved records: ' + data.records
157                         + '/' + data.hits + ' :.</span>';
158 }
159
160 function my_onterm(data) {
161     if (!mkws_config.termlist_menu)
162         return;
163     
164     var termlists = [];
165     termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
166     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
167         termlists.push('<a href="#" target_id='+data.xtargets[i].id
168             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
169         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
170     }
171
172     termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
173     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
174         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
175               + data.subject[i].freq + ')</span><br/>');
176     }
177
178     termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
179     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
180         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
181                             + data.author[i].name
182                             + ' </a><span> ('
183                             + data.author[i].freq
184                             + ')</span><br/>');
185     }
186     var termlist = document.getElementById("termlist");
187     replaceHtml(termlist, termlists.join(''));
188 }
189
190 function my_onrecord(data) {
191     // FIXME: record is async!!
192     clearTimeout(my_paz.recordTimer);
193     // in case on_show was faster to redraw element
194     var detRecordDiv = document.getElementById('det_'+data.recid);
195     if (detRecordDiv) return;
196     curDetRecData = data;
197     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
198     var html = renderDetails(curDetRecData);
199     recordDiv.innerHTML += html;
200 }
201
202 function my_onbytarget(data) {
203     var targetDiv = document.getElementById("bytarget");
204     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
205         +'<td>Records</td><td>State</td></tr></thead><tbody>';
206
207     for (var i = 0; i < data.length; i++ ) {
208         table += "<tr><td>" + data[i].id +
209             "</td><td>" + data[i].hits +
210             "</td><td>" + data[i].diagnostic +
211             "</td><td>" + data[i].records +
212             "</td><td>" + data[i].state + "</td></tr>";
213     }
214
215     table += '</tbody></table>';
216     targetDiv.innerHTML = table;
217 }
218
219 ////////////////////////////////////////////////////////////////////////////////
220 ////////////////////////////////////////////////////////////////////////////////
221
222 // wait until the DOM is ready
223 function domReady ()
224 {
225     document.search.onsubmit = onFormSubmitEventHandler;
226     document.search.query.value = '';
227     document.select.sort.onchange = onSelectDdChange;
228     document.select.perpage.onchange = onSelectDdChange;
229 }
230
231 // when search button pressed
232 function onFormSubmitEventHandler()
233 {
234     resetPage();
235     loadSelect();
236     triggerSearch();
237     switchView('records'); // In case it's configured to start off as hidden
238     submitted = true;
239     return false;
240 }
241
242 function onSelectDdChange()
243 {
244     if (!submitted) return false;
245     resetPage();
246     loadSelect();
247     my_paz.show(0, recPerPage, curSort);
248     return false;
249 }
250
251 function resetPage()
252 {
253     curPage = 1;
254     totalRec = 0;
255 }
256
257 function triggerSearch ()
258 {
259     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
260 }
261
262 function loadSelect ()
263 {
264     curSort = document.select.sort.value;
265     recPerPage = document.select.perpage.value;
266 }
267
268 // limit the query after clicking the facet
269 function limitQuery (field, value)
270 {
271     document.search.query.value += ' and ' + field + '="' + value + '"';
272     onFormSubmitEventHandler();
273 }
274
275 // limit by target functions
276 function limitTarget (id, name)
277 {
278     var navi = document.getElementById('navi');
279     navi.innerHTML =
280         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
281         + name + '</a>';
282     navi.innerHTML += '<hr/>';
283     curFilter = 'pz:id=' + id;
284     resetPage();
285     loadSelect();
286     triggerSearch();
287     return false;
288 }
289
290 function delimitTarget ()
291 {
292     var navi = document.getElementById('navi');
293     navi.innerHTML = '';
294     curFilter = null;
295     resetPage();
296     loadSelect();
297     triggerSearch();
298     return false;
299 }
300
301 function drawPager (pagerDiv)
302 {
303     //client indexes pages from 1 but pz2 from 0
304     var onsides = 6;
305     var pages = Math.ceil(totalRec / recPerPage);
306
307     var firstClkbl = ( curPage - onsides > 0 )
308         ? curPage - onsides
309         : 1;
310
311     var lastClkbl = firstClkbl + 2*onsides < pages
312         ? firstClkbl + 2*onsides
313         : pages;
314
315     var prev = '<span id="prev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
316     if (curPage > 1)
317         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
318         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
319
320     var middle = '';
321     for(var i = firstClkbl; i <= lastClkbl; i++) {
322         var numLabel = i;
323         if(i == curPage)
324             numLabel = '<b>' + i + '</b>';
325
326         middle += '<a href="#" onclick="showPage(' + i + ')"> '
327             + numLabel + ' </a>';
328     }
329
330     var next = '<b> | </b><span id="next">' + M('Next') + ' &#62;&#62;</span>';
331     if (pages - curPage > 0)
332         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
333         + M('Next') + ' &#62;&#62;</a>';
334
335     var predots = '';
336     if (firstClkbl > 1)
337         predots = '...';
338
339     var postdots = '';
340     if (lastClkbl < pages)
341         postdots = '...';
342
343     pagerDiv.innerHTML += '<div style="float: clear">'
344         + prev + predots + middle + postdots + next + '</div><hr/>';
345 }
346
347 function showPage (pageNum)
348 {
349     curPage = pageNum;
350     my_paz.showPage( curPage - 1 );
351 }
352
353 // simple paging functions
354
355 function pagerNext() {
356     if ( totalRec - recPerPage*curPage > 0) {
357         my_paz.showNext();
358         curPage++;
359     }
360 }
361
362 function pagerPrev() {
363     if ( my_paz.showPrev() != false )
364         curPage--;
365 }
366
367 // swithing view between targets and records
368
369 function switchView(view) {
370
371     var targets = document.getElementById('mkwsTargets');
372     var records = document.getElementById('mkwsRecords');
373     var blanket = document.getElementById('mkwsBlanket');
374
375     switch(view) {
376         case 'targets':
377             targets.style.display = "block";
378             records.style.display = "none";
379             if (blanket) { blanket.style.display = "none"; }
380             break;
381         case 'records':
382             targets.style.display = "none";
383             records.style.display = "block";
384             if (blanket) { blanket.style.display = "block"; }
385             break;
386         case 'none':
387             targets.style.display = "none";
388             records.style.display = "none";
389             if (blanket) { blanket.style.display = "none"; }
390             break;
391         default:
392             alert('Unknown view.');
393     }
394 }
395
396 // detailed record drawing
397 function showDetails (prefixRecId) {
398     var recId = prefixRecId.replace('rec_', '');
399     var oldRecId = curDetRecId;
400     curDetRecId = recId;
401
402     // remove current detailed view if any
403     var detRecordDiv = document.getElementById('det_'+oldRecId);
404     // lovin DOM!
405     if (detRecordDiv)
406       detRecordDiv.parentNode.removeChild(detRecordDiv);
407
408     // if the same clicked, just hide
409     if (recId == oldRecId) {
410         curDetRecId = '';
411         curDetRecData = null;
412         return;
413     }
414     // request the record
415     my_paz.record(recId);
416 }
417
418 function replaceHtml(el, html) {
419   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
420   /*@cc_on // Pure innerHTML is slightly faster in IE
421     oldEl.innerHTML = html;
422     return oldEl;
423     @*/
424   var newEl = oldEl.cloneNode(false);
425   newEl.innerHTML = html;
426   oldEl.parentNode.replaceChild(newEl, oldEl);
427   /* Since we just removed the old element from the DOM, return a reference
428      to the new element, which can be used to restore variable references. */
429   return newEl;
430 };
431
432 function renderDetails(data, marker)
433 {
434     var details = '<div class="details" id="det_'+data.recid+'"><table>';
435     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
436     if (data["md-title"] != undefined) {
437         details += '<tr><td><b>' + M('Title') + '</b></td><td><b>:</b> '+data["md-title"];
438         if (data["md-title-remainder"] !== undefined) {
439               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
440         }
441         if (data["md-title-responsibility"] !== undefined) {
442               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
443         }
444           details += '</td></tr>';
445     }
446     if (data["md-date"] != undefined)
447         details += '<tr><td><b>' + M('Date') + '</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
448     if (data["md-author"] != undefined)
449         details += '<tr><td><b>' + M('Author') + '</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
450     if (data["md-electronic-url"] != undefined)
451         details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
452     if (data["location"][0]["md-subject"] != undefined)
453         details += '<tr><td><b>' + M('Subject') + '</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
454     if (data["location"][0]["@name"] != undefined)
455         details += '<tr><td><b>' + M('Location') + '</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
456     details += '</table></div>';
457     return details;
458 }
459
460 /*
461  * All the HTML stuff to render the search forms and
462  * result pages.
463  */
464 function mkws_html_all(config) {
465
466     /* default mkws config */
467     var mkws_config_default = {
468         sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
469         perpage: [10, 20, 30, 50],
470         sort_default: "relevance",
471         perpage_default: 20,
472         query_width: 50,
473         switch_menu: true,      /* show/hide Records|Targets menu */
474         lang_menu: true,        /* show/hide language menu */
475         lang_display: [],       /* display languages links for given languages, [] for all */
476         termlist_menu: true,    /* show/hide termlist */
477         debug: 0,     /* debug level for development: 0..2 */
478
479         dummy: "dummy"
480     };
481
482     /* set global debug flag early */
483     if (config.debug !== 'undefined') {
484         mkws_debug = config.debug;
485     } else if (mkws_config_default.debug !== 'undefined') {
486         mkws_debug = mkws_config_default.debug;
487     }
488     
489     /* override standard config values by function parameters */
490     for (var k in mkws_config_default) {
491         if (typeof config[k] === 'undefined')
492            mkws_config[k] = mkws_config_default[k];
493         debug("Set config: " + k + ' => ' + mkws_config[k]);
494     }
495
496     if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
497         debug("Reset query width: " + mkws_config.query_width);
498         mkws_config.query_width = 50;
499     }
500    
501     mkws_set_lang(mkws_config); 
502     if (mkws_config.lang_menu)
503         mkws_html_lang(mkws_config); 
504
505     // For some reason, doing this programmatically results in
506     // document.search.query being undefined, hence the raw HTML.
507     debug("HTML search form");
508     $("#mkwsSearch").html('\
509     <form id="searchForm" name="search" action="" >\
510       <input id="query" type="text" size="' + mkws_config.query_width + '" />\
511       <input id="button" type="submit" value="' + M('Search') + '" />\
512     </form>');
513
514     debug("HTML records");
515     $("#mkwsRecords").html('\
516       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
517         <tr>\
518           <td width="250" valign="top">\
519             <div id="termlist"></div>\
520           </td>\
521           <td valign="top">\
522             <div id="ranking">\
523               <form name="select" id="select" action="" >\
524         ' + M('Sort by') + mkws_html_sort(config) + '\
525         ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
526         ' + M('per page') + '.\
527        </form>\
528             </div>\
529             <div id="pager"></div>\
530             <div id="navi"></div>\
531             <div id="results"></div>\
532           </td>\
533         </tr>\
534       </table>');
535
536     mkws_html_switch(config);
537     if (mkws_config.use_service_proxy)
538         mkws_service_proxy_auth(config.service_proxy_auth);
539
540     domReady();
541 }
542
543 function mkws_set_lang(mkws_config)  {
544     var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
545     if (!lang || !mkws_locale_lang[lang]) {
546         mkws_config.lang = ""
547     } else {
548         mkws_config.lang = lang;
549     }
550     
551     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
552     return mkws_config.lang;
553 }
554
555 function mkws_html_switch(config) {
556     debug("HTML switch");
557     
558     $("#mkwsSwitch").html($("<a/>", {
559         href: '#',
560         onclick: "switchView(\'records\')",
561         text: "Records"
562     }));
563     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
564     $("#mkwsSwitch").append($("<a/>", {
565         href: '#',
566         onclick: "switchView(\'targets\')",
567         text: "Targets"
568     }));
569
570     debug("HTML targets");
571     $("#mkwsTargets").html('\
572       <div id="bytarget">\
573        No information available yet.\
574       </div>');
575     $("#mkwsTargets").css("display", "none");
576
577     if (!config.switch_menu) {
578         debug("disable switch menu");
579         $("#mkwsSwitch").css("display", "none");
580     }
581 }
582
583 function mkws_html_sort(config) {
584     debug("HTML sort");
585     var sort_html = '<select name="sort" id="sort">';
586
587     for(var i = 0; i < config.sort.length; i++) {
588         var key = config.sort[i][0];
589         var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
590
591         sort_html += '<option value="' + key + '"';
592         if (key == config.sort_default) {
593             sort_html += ' selected="selected"';
594         }
595         sort_html += '>' + val + '</option>';
596     }
597     sort_html += '</select>';
598
599     return sort_html;
600 }
601
602 function mkws_html_perpage(config) {
603     debug("HTML perpage");
604     var perpage_html = '<select name="perpage" id="perpage">';
605
606     for(var i = 0; i < config.perpage.length; i++) {
607         var key = config.perpage[i];
608
609         perpage_html += '<option value="' + key + '"';
610         if (key == config.perpage_default) {
611             perpage_html += ' selected="selected"';
612         }
613         perpage_html += '>' + key + '</option>';
614     }
615     perpage_html += '</select>';
616
617     return perpage_html;
618 }
619
620 /*
621  * Run service-proxy authentication in background (after page load).
622  * The username/password is configured in the apache config file
623  * for the site.
624  */
625 function mkws_service_proxy_auth(auth_url) {
626     if (!auth_url)
627         auth_url = "http://mkws.indexdata.com/service-proxy-auth";
628         
629     debug("Run service proxy auth URL: " + auth_url);
630
631     var request = new pzHttpRequest(auth_url);
632     request.get(null, function(data) {
633         if (!jQuery.isXMLDoc(data)) {
634             alert("service proxy auth response document is not valid XML document, give up!");
635             return;
636         }
637         var status = $(data).find("status");
638         if (status.text() != "OK") {
639             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
640             return;
641         }
642     });
643 }
644
645 /* create locale language menu */
646 function mkws_html_lang(mkws_config) {
647     var lang_default = "en";
648     var lang = mkws_config.lang || lang_default;
649     var list = [];
650
651     /* display a list of configured languages, or all */
652     var lang_display = mkws_config.lang_display || [];
653     var hash = {};
654     for (var i = 0; i < lang_display.length; i++) {
655         hash[lang_display[i]] = 1;
656     }
657     
658     for (var k in mkws_locale_lang) {
659         if (hash[k] == 1 || lang_display.length == 0)
660             list.push(k);
661     }
662
663     // add english link
664     if (lang_display.length == 0 || hash[lang_default] == 1)
665         list.push(lang_default);
666
667     debug("Language menu for: " + list.join(", "));
668
669     /* the HTML part */
670     var data = "";    
671     for(var i = 0; i < list.length; i++) {
672         var l = list[i];
673         
674         if (data)
675             data += ' | ';
676             
677         if (lang == l) {
678             data += l;
679         } else {
680             data += ' <a href="?lang=' + l + '">' + l + '</a> '
681         }
682     }
683     
684     $("#mkwsLang").html(data);
685 }
686
687 /* locale */
688 function M(word) {
689     var lang = mkws_config.lang;
690
691     if (!lang || !mkws_locale_lang[lang])
692         return word;
693
694     return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
695 }
696
697 /* implement jQuery.parseQuerystring() for parsing URL parameters */
698 jQuery.extend({
699   parseQuerystring: function() {
700     var nvpair = {};
701     var qs = window.location.search.replace('?', '');
702     var pairs = qs.split('&');
703     $.each(pairs, function(i, v){
704         var pair = v.split('=');
705         nvpair[pair[0]] = pair[1];
706     });
707     return nvpair;
708   }, 
709   pazpar2: function(data) {
710         document.write('<div id="mkwsSwitch"></div>\
711     <div id="mkwsLang"></div>\
712     <div id="mkwsSearch"></div>\
713     <div id="mkwsRecords"></div>\
714     <div id="mkwsTargets"></div>\
715     <div id="footer">\
716       <div id="mkwsStat"></div>\
717       <span>Powered by MKWS &copy; 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
718     </div>');
719
720     mkws_html_all(mkws_config);
721   }
722 });
723
724 function debug(string) {
725     if (!mkws_debug)
726         return;
727
728     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
729         return;
730     }
731
732     // you need to disable use strict at the top of the file!!!
733     if (mkws_debug >= 3) {
734         console.log(arguments.callee.caller);
735     } else if (mkws_debug >= 2) {
736         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
737     }
738     console.log(string);
739 }
740
741 /* magic */
742 $(document).ready(function() { mkws_html_all(mkws_config) });