Comment formatting.
[mkws-moved-to-github.git] / src / mkws-team.js
1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
3 // private scope.
4 //
5 // Some functions are visible as member-functions to be called from
6 // outside code -- specifically, from generated HTML. These functions
7 // are that.switchView(), showDetails(), limitTarget(), limitQuery(),
8 // delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
9 // pagerNext().
10 //
11 function team($, teamName) {
12     var that = {};
13     var m_teamName = teamName;
14     var m_submitted = false;
15     var m_query; // initially undefined
16     var m_sortOrder; // will be set below
17     var m_perpage; // will be set below
18     var m_filters = [];
19     var m_totalRecordCount = 0;
20     var m_currentPage = 1;
21     var m_currentRecordId = '';
22     var m_currentRecordData = null;
23     var m_logTime = {
24         // Timestamps for logging
25         "start": $.now(),
26         "last": $.now()
27     };
28     var m_paz; // will be initialised below
29     var m_template = {};
30
31     that.name = function() { return m_teamName; }
32     that.submitted = function() { return m_submitted; }
33     that.perpage = function() { return m_perpage; }
34     that.totalRecordCount = function() { return m_totalRecordCount; }
35     that.currentPage = function() { return m_currentPage; }
36     that.currentRecordId = function() { return m_currentRecordId; }
37     that.currentRecordData = function() { return m_currentRecordData; }
38     that.filters = function() { return m_filters; }
39
40     that.set_sortOrder = function(val) { m_sortOrder = val };
41     that.set_perpage = function(val) { m_perpage = val };
42
43
44     var log = function (s) {
45         var now = $.now();
46         var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
47         m_logTime.last = now;
48
49         mkws.log(m_teamName + ": " + timestamp + s);
50     }
51     that.log = log;
52
53     log("start running MKWS");
54
55     m_sortOrder = mkws_config.sort_default;
56     m_perpage = mkws_config.perpage_default;
57
58     log("Create main pz2 object");
59     // create a parameters array and pass it to the pz2's constructor
60     // then register the form submit event with the pz2.search function
61     // autoInit is set to true on default
62     m_paz = new pz2({ "windowid": teamName,
63                       "pazpar2path": mkws_config.pazpar2_url,
64                       "usesessions" : mkws_config.use_service_proxy ? false : true,
65                       "oninit": onInit,
66                       "onbytarget": onBytarget,
67                       "onstat": onStat,
68                       "onterm": (mkws_config.facets.length ? onTerm : undefined),
69                       "onshow": onShow,
70                       "onrecord": onRecord,
71                       "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
72                       "termlist": mkws_config.facets.join(',')
73                     });
74
75
76     //
77     // pz2.js event handlers:
78     //
79     function onInit() {
80         log("init");
81         m_paz.stat();
82         m_paz.bytarget();
83     }
84
85
86     function onBytarget(data) {
87         log("target");
88         queue("targets").publish(data);
89     }
90
91
92     function onStat(data) {
93         log("stat");
94         queue("stat").publish(data);
95     }
96
97
98     function onTerm(data) {
99         log("term");
100         queue("termlists").publish(data);
101     }
102
103
104     function onShow(data, teamName) {
105         log("show");
106         m_totalRecordCount = data.merged;
107         queue("pager").publish(data);
108         queue("records").publish(data);
109     }
110
111
112     function onRecord(data, args, teamName) {
113         log("record");
114         // FIXME: record is async!!
115         clearTimeout(m_paz.recordTimer);
116         // ##### restrict to current team
117         var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
118         if (detRecordDiv) {
119             // in case on_show was faster to redraw element
120             return;
121         }
122         m_currentRecordData = data;
123         var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
124         var html = renderDetails(m_currentRecordData);
125         $(recordDiv).append(html);
126     }
127
128
129     // Used by promoteRecords() and onRecord()
130     function recordElementId(s) {
131         return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
132     }
133     that.recordElementId = recordElementId;
134
135     // Used by onRecord(), showDetails() and renderDetails()
136     function recordDetailsId(s) {
137         return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
138     }
139     that.recordElementId = recordElementId;
140
141
142     that.targetFiltered = function(id) {
143         for (var i = 0; i < m_filters.length; i++) {
144             if (m_filters[i].id === id ||
145                 m_filters[i].id === 'pz:id=' + id) {
146                 return true;
147             }
148         }
149         return false;
150     }
151
152
153     ////////////////////////////////////////////////////////////////////////////////
154     ////////////////////////////////////////////////////////////////////////////////
155
156
157     // when search button pressed
158     function onFormSubmitEventHandler()
159     {
160         var val = findnode('.mkwsQuery').val();
161         newSearch(val);
162         return false;
163     }
164
165
166     function newSearch(query, sortOrder, targets)
167     {
168         log("newSearch: " + query);
169
170         if (mkws_config.use_service_proxy && !mkws.authenticated) {
171             alert("searching before authentication");
172             return;
173         }
174
175         m_filters = []
176         triggerSearch(query, sortOrder, targets);
177         switchView('records'); // In case it's configured to start off as hidden
178         m_submitted = true;
179     }
180
181
182     // limit by target functions
183     that.limitTarget  = function (id, name)
184     {
185         log("limitTarget(id=" + id + ", name=" + name + ")");
186         m_filters.push({ id: id, name: name });
187         triggerSearch();
188         return false;
189     }
190
191
192     // limit the query after clicking the facet
193     that.limitQuery = function (field, value)
194     {
195         log("limitQuery(field=" + field + ", value=" + value + ")");
196         m_filters.push({ field: field, value: value });
197         triggerSearch();
198         return false;
199     }
200
201
202     that.delimitTarget = function (id)
203     {
204         log("delimitTarget(id=" + id + ")");
205         var newFilters = [];
206         for (var i in m_filters) {
207             var filter = m_filters[i];
208             if (filter.id) {
209                 log("delimitTarget() removing filter " + $.toJSON(filter));
210             } else {
211                 log("delimitTarget() keeping filter " + $.toJSON(filter));
212                 newFilters.push(filter);
213             }
214         }
215         m_filters = newFilters;
216
217         triggerSearch();
218         return false;
219     }
220
221
222     that.delimitQuery = function (field, value)
223     {
224         log("delimitQuery(field=" + field + ", value=" + value + ")");
225         var newFilters = [];
226         for (var i in m_filters) {
227             var filter = m_filters[i];
228             if (filter.field &&
229                 field == filter.field &&
230                 value == filter.value) {
231                 log("delimitQuery() removing filter " + $.toJSON(filter));
232             } else {
233                 log("delimitQuery() keeping filter " + $.toJSON(filter));
234                 newFilters.push(filter);
235             }
236         }
237         m_filters = newFilters;
238
239         triggerSearch();
240         return false;
241     }
242
243
244     function resetPage()
245     {
246         m_currentPage = 1;
247         m_totalRecordCount = 0;
248     }
249     that.resetPage = resetPage;
250
251
252     function triggerSearch (query, sortOrder, targets)
253     {
254         resetPage();
255         queue("navi").publish();
256
257         var pp2filter = "";
258         var pp2limit = "";
259
260         // Continue to use previous query/sort-order unless new ones are specified
261         if (query) {
262             m_query = query;
263         }
264         if (sortOrder) {
265             m_sortOrder = sortOrder;
266         }
267         if (targets) {
268             m_filters.push({ id: targets, name: targets });
269         }
270
271         for (var i in m_filters) {
272             var filter = m_filters[i];
273             if (filter.id) {
274                 if (pp2filter)
275                     pp2filter += ",";
276                 if (filter.id.match(/^[a-z:]+[=~]/)) {
277                     log("filter '" + filter.id + "' already begins with SETTING OP");
278                 } else {
279                     filter.id = 'pz:id=' + filter.id;
280                 }
281                 pp2filter += filter.id;
282             } else {
283                 if (pp2limit)
284                     pp2limit += ",";
285                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
286             }
287         }
288
289         var params = {};
290         if (pp2limit) {
291             params.limit = pp2limit;
292         }
293
294         log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
295
296         // We can use: params.torusquery = "udb=NAME"
297         // Note: that won't work when running against raw pazpar2
298         m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
299     }
300
301
302     that.reShow = function() {
303         m_paz.show(0, m_perpage, m_sortOrder);
304     }
305
306
307
308     that.showPage = function (pageNum)
309     {
310         m_currentPage = pageNum;
311         m_paz.showPage(m_currentPage - 1);
312     }
313
314
315     // simple paging functions
316     that.pagerNext = function () {
317         if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
318             m_paz.showNext();
319             m_currentPage++;
320         }
321     }
322
323
324     that.pagerPrev = function () {
325         if (m_paz.showPrev() != false)
326             m_currentPage--;
327     }
328
329
330     // switching view between targets and records
331     function switchView(view) {
332         var targets = findnode('.mkwsTargets');
333         var results = findnode('.mkwsResults,.mkwsRecords');
334         var blanket = findnode('.mkwsBlanket');
335         var motd    = findnode('.mkwsMOTD');
336
337         switch(view) {
338         case 'targets':
339             if (targets) targets.css('display', 'block');
340             if (results) results.css('display', 'none');
341             if (blanket) blanket.css('display', 'none');
342             if (motd) motd.css('display', 'none');
343             break;
344         case 'records':
345             if (targets) targets.css('display', 'none');
346             if (results) results.css('display', 'block');
347             if (blanket) blanket.css('display', 'block');
348             if (motd) motd.css('display', 'none');
349             break;
350         case 'none':
351             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
352             if (targets) targets.css('display', 'none');
353             if (results) results.css('display', 'none');
354             if (blanket) blanket.css('display', 'none');
355             if (motd) motd.css('display', 'none');
356             break;
357         default:
358             alert("Unknown view '" + view + "'");
359         }
360     }
361     that.switchView = switchView;
362
363
364     // detailed record drawing
365     that.showDetails = function (recId) {
366         var oldRecordId = m_currentRecordId;
367         m_currentRecordId = recId;
368
369         // remove current detailed view if any
370         // ##### restrict to current team
371         var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
372         // lovin DOM!
373         if (detRecordDiv)
374             detRecordDiv.parentNode.removeChild(detRecordDiv);
375
376         // if the same clicked, just hide
377         if (recId == oldRecordId) {
378             m_currentRecordId = '';
379             m_currentRecordData = null;
380             return;
381         }
382         // request the record
383         log("showDetails() requesting record '" + recId + "'");
384         m_paz.record(recId);
385     }
386
387
388     /*
389      * All the HTML stuff to render the search forms and
390      * result pages.
391      */
392     function mkwsHtmlAll() {
393         mkwsSetLang();
394         if (mkws_config.show_lang)
395             mkwsHtmlLang();
396
397         log("HTML search form");
398         findnode('.mkwsSearch').html('\
399 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
400   <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
401   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
402 </form>');
403
404         log("HTML records");
405         // If the team has a .mkwsResults, populate it in the usual
406         // way. If not, assume that it's a smarter application that
407         // defines its own subcomponents, some or all of the
408         // following:
409         //      .mkwsTermlists
410         //      .mkwsRanking
411         //      .mkwsPager
412         //      .mkwsNavi
413         //      .mkwsRecords
414         findnode(".mkwsResults").html('\
415 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
416   <tr>\
417     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
418       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
419     </td>\
420     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
421       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
422       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
423       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
424       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
425     </td>\
426   </tr>\
427   <tr>\
428     <td colspan="2">\
429       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
430     </td>\
431   </tr>\
432 </table>');
433
434         var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
435         if (mkws_config.show_sort) {
436             ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
437         }
438         if (mkws_config.show_perpage) {
439             ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
440         }
441         ranking_data += '</form>';
442         findnode(".mkwsRanking").html(ranking_data);
443
444         mkwsHtmlSwitch();
445
446         findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
447
448         // on first page, hide the termlist
449         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
450         var container = findnode(".mkwsMOTDContainer");
451         if (container.length) {
452             // Move the MOTD from the provided element down into the container
453             findnode(".mkwsMOTD").appendTo(container);
454         }
455     }
456
457
458     function mkwsSetLang()  {
459         var lang = getParameterByName("lang") || mkws_config.lang;
460         if (!lang || !mkws.locale_lang[lang]) {
461             mkws_config.lang = ""
462         } else {
463             mkws_config.lang = lang;
464         }
465
466         log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
467         return mkws_config.lang;
468     }
469
470
471     /* create locale language menu */
472     function mkwsHtmlLang() {
473         var lang_default = "en";
474         var lang = mkws_config.lang || lang_default;
475         var list = [];
476
477         /* display a list of configured languages, or all */
478         var lang_options = mkws_config.lang_options || [];
479         var toBeIncluded = {};
480         for (var i = 0; i < lang_options.length; i++) {
481             toBeIncluded[lang_options[i]] = true;
482         }
483
484         for (var k in mkws.locale_lang) {
485             if (toBeIncluded[k] || lang_options.length == 0)
486                 list.push(k);
487         }
488
489         // add english link
490         if (lang_options.length == 0 || toBeIncluded[lang_default])
491             list.push(lang_default);
492
493         log("Language menu for: " + list.join(", "));
494
495         /* the HTML part */
496         var data = "";
497         for(var i = 0; i < list.length; i++) {
498             var l = list[i];
499
500             if (data)
501                 data += ' | ';
502
503             if (lang == l) {
504                 data += ' <span>' + l + '</span> ';
505             } else {
506                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
507             }
508         }
509
510         findnode(".mkwsLang").html(data);
511     }
512
513
514     function mkwsHtmlSort() {
515         log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
516         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
517
518         for(var i = 0; i < mkws_config.sort_options.length; i++) {
519             var opt = mkws_config.sort_options[i];
520             var key = opt[0];
521             var val = opt.length == 1 ? opt[0] : opt[1];
522
523             sort_html += '<option value="' + key + '"';
524             if (m_sortOrder == key || m_sortOrder == val) {
525                 sort_html += ' selected="selected"';
526             }
527             sort_html += '>' + M(val) + '</option>';
528         }
529         sort_html += '</select>';
530
531         return sort_html;
532     }
533
534
535     function mkwsHtmlPerpage() {
536         log("HTML perpage, m_perpage = " + m_perpage);
537         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
538
539         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
540             var key = mkws_config.perpage_options[i];
541
542             perpage_html += '<option value="' + key + '"';
543             if (key == m_perpage) {
544                 perpage_html += ' selected="selected"';
545             }
546             perpage_html += '>' + key + '</option>';
547         }
548         perpage_html += '</select>';
549
550         return perpage_html;
551     }
552
553
554     function mkwsHtmlSwitch() {
555         log("HTML switch for team " + m_teamName);
556
557         var node = findnode(".mkwsSwitch");
558         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
559         node.append($("<span/>", { text: " | " }));
560         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
561
562         log("HTML targets");
563         var node = findnode(".mkwsTargets");
564         node.html('\
565 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
566   No information available yet.\
567 </div>');
568         node.css("display", "none");
569     }
570
571
572     that.runAutoSearch = function() {
573         var node = findnode('.mkwsRecords,.mkwsTermlists');
574         var query = node.attr('autosearch');
575         if (!query)
576             return;
577
578         if (query.match(/^!param!/)) {
579             var param = query.replace(/^!param!/, '');
580             query = getParameterByName(param);
581             log("obtained query '" + query + "' from param '" + param + "'");
582             if (!query) {
583                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
584             }
585         } else if (query.match(/^!path!/)) {
586             var index = query.replace(/^!path!/, '');
587             var path = window.location.pathname.split('/');
588             query = path[path.length - index];
589             log("obtained query '" + query + "' from path-component '" + index + "'");
590             if (!query) {
591                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
592             }
593         }
594
595         log("node=" + node + ", class='" + node.className + "', query=" + query);
596
597         var sortOrder = node.attr('sort');
598         var targets = node.attr('targets');
599         var s = "running auto search: '" + query + "'";
600         if (sortOrder) s += " sorted by '" + sortOrder + "'";
601         if (targets) s += " in targets '" + targets + "'";
602         log(s);
603
604         newSearch(query, sortOrder, targets);
605     }
606
607
608     // This function is taken from a StackOverflow answer
609     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
610     function getParameterByName(name) {
611         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
612         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
613             results = regex.exec(location.search);
614         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
615     }
616
617
618     // Translation function. At present, this is properly a
619     // global-level function (hence the assignment to mkws.M) but we
620     // want to make it per-team so different teams can operate in
621     // different languages.
622     //
623     function M(word) {
624         var lang = mkws_config.lang;
625
626         if (!lang || !mkws.locale_lang[lang])
627             return word;
628
629         return mkws.locale_lang[lang][word] || word;
630     }
631     mkws.M = M; // so the Handlebars helper can use it
632
633
634     // Finds the node of the specified class within the current team
635     // Multiple OR-clauses separated by commas are handled
636     // More complex cases may not work
637     //
638     function findnode(selector, teamName) {
639         teamName = teamName || m_teamName;
640
641         selector = $.map(selector.split(','), function(s, i) {
642             return s + '.mkwsTeam_' + teamName;
643         }).join(',');
644
645         return $(selector);
646     }
647
648
649     function renderDetails(data, marker)
650     {
651         var template = loadTemplate("Record");
652         var details = template(data);
653         return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
654     }
655     that.renderDetails = renderDetails;
656
657
658     function loadTemplate(name)
659     {
660         var template = m_template[name];
661
662         if (template === undefined) {
663             // Fall back to generic template if there is no team-specific one
664             var node = findnode(".mkwsTemplate_" + name);
665             if (!node.length) {
666                 node = findnode(".mkwsTemplate_" + name, "ALL");
667             }
668
669             var source = node.html();
670             if (!source) {
671                 source = defaultTemplate(name);
672             }
673
674             template = Handlebars.compile(source);
675             log("compiled template '" + name + "'");
676             m_template[name] = template;
677         }
678
679         return template;
680     }
681     that.loadTemplate = loadTemplate;
682
683
684     function defaultTemplate(name)
685     {
686         if (name === 'Record') {
687             return '\
688 <table>\
689   <tr>\
690     <th>{{translate "Title"}}</th>\
691     <td>\
692       {{md-title}}\
693       {{#if md-title-remainder}}\
694         ({{md-title-remainder}})\
695       {{/if}}\
696       {{#if md-title-responsibility}}\
697         <i>{{md-title-responsibility}}</i>\
698       {{/if}}\
699     </td>\
700   </tr>\
701   {{#if md-date}}\
702   <tr>\
703     <th>{{translate "Date"}}</th>\
704     <td>{{md-date}}</td>\
705   </tr>\
706   {{/if}}\
707   {{#if md-author}}\
708   <tr>\
709     <th>{{translate "Author"}}</th>\
710     <td>{{md-author}}</td>\
711   </tr>\
712   {{/if}}\
713   {{#if md-electronic-url}}\
714   <tr>\
715     <th>{{translate "Links"}}</th>\
716     <td>\
717       {{#each md-electronic-url}}\
718         <a href="{{this}}">Link{{index1}}</a>\
719       {{/each}}\
720     </td>\
721   </tr>\
722   {{/if}}\
723   {{#if-any location having="md-subject"}}\
724   <tr>\
725     <th>{{translate "Subject"}}</th>\
726     <td>\
727       {{#first location having="md-subject"}}\
728         {{#if md-subject}}\
729           {{#commaList md-subject}}\
730             {{this}}{{/commaList}}\
731         {{/if}}\
732       {{/first}}\
733     </td>\
734   </tr>\
735   {{/if-any}}\
736   <tr>\
737     <th>{{translate "Locations"}}</th>\
738     <td>\
739       {{#commaList location}}\
740         {{attr "@name"}}{{/commaList}}\
741     </td>\
742   </tr>\
743 </table>\
744 ';
745         } else if (name === "Summary") {
746             return '\
747 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
748   <b>{{md-title}}</b>\
749 </a>\
750 {{#if md-title-remainder}}\
751   <span>{{md-title-remainder}}</span>\
752 {{/if}}\
753 {{#if md-title-responsibility}}\
754   <span><i>{{md-title-responsibility}}</i></span>\
755 {{/if}}\
756 ';
757         }
758
759         var s = "There is no default '" + name +"' template!";
760         alert(s);
761         return s;
762     }
763
764
765     // The following PubSub code is modified from the jQuery manual:
766     // https://api.jquery.com/jQuery.Callbacks/
767     //
768     // Use as:
769     //  team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
770     //  team.queue("eventName").publish(arg1, arg2, ...);
771
772     var queues = {};
773     var queue = function(id) {
774         if (!queues[id]) {
775             var callbacks = $.Callbacks();
776             queues[id] = {
777                 publish: callbacks.fire,
778                 subscribe: callbacks.add,
779                 unsubscribe: callbacks.remove
780             };
781         }
782         return queues[id];
783     }
784     that.queue = queue;
785
786
787     // main
788     (function() {
789         try {
790             mkwsHtmlAll()
791         }
792
793         catch (e) {
794             mkws_config.error = e.message;
795             // alert(e.message);
796         }
797     })();
798
799     // Bizarrely, 'that' is just an empty hash. All its state is in
800     // the closure variables defined earlier in this function.
801     return that;
802 };