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