Simplify popup example, include link to relevant part of reference section.
[mkws-moved-to-github.git] / doc / mkws-manual.markdown
1 % The MKWS manual: embedded metasearching with the MasterKey Widget Set
2 % Mike Taylor
3 % October 2014
4
5
6 Introduction
7 ============
8
9 There are lots of practical problems in building resource discovery
10 solutions. One of the biggest, and most ubiquitous is incorporating
11 metasearching functionality into existing web-sites -- for example,
12 content-management systems, library catalogues or intranets. In
13 general, even when access to core metasearching functionality is
14 provided by simple web-services such as
15 [Pazpar2](http://www.indexdata.com/pazpar2), integration work is seen
16 as a major part of most projects.
17
18 Index Data provides several different toolkits for communicating with
19 its metasearching middleware, trading off varying degrees of
20 flexibility against convenience:
21
22 * [pz2.js](http://www.indexdata.com/pazpar2/doc/ajaxdev.html) --
23   a low-level JavaScript library for interrogating the
24   [Service Proxy](http://www.indexdata.com/service-proxy/)
25   and
26   [Pazpar2](http://www.indexdata.com/pazpar2/).
27   It allows the HTML/JavaScript programmer
28   to create JavaScript applications to display facets, records,
29   etc. that are fetched from the metasearching middleware.
30
31 * masterkey-ui-core -- a higher-level, complex JavaScript library that
32   uses pz2.js to provide the pieces needed for building a
33   full-featured JavaScript application.
34
35 * MasterKey Demo UI -- an example of a searching application built on
36   top of masterkey-ui-core. Available as a public demo at
37   <http://mk2.indexdata.com/>
38
39 * [MKDru](http://www.indexdata.com/masterkey-drupal) --
40   a toolkit for embedding MasterKey-like searching into
41   [Drupal](https://www.drupal.org/)
42   sites.
43
44 All of these approaches require programming to a greater or lesser
45 extent. Against this backdrop, we introduced
46 [MKWS (the MasterKey Widget Set)](http://mkws.indexdata.com/)
47 -- a set of simple, very high-level HTML+CSS+JavaScript
48 components that can be incorporated into any web-site to provide
49 MasterKey searching facilities. By placing `<div>`s with well-known
50 MKWS classes in any HTML page, the various components of an application
51 can be embedded: search-boxes, results areas, target information, etc.
52
53
54 Simple example
55 ==============
56
57 The following is
58 [a complete MKWS-based searching application](//example.indexdata.com/simple.html):
59
60     <html>
61       <head>
62         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
63         <title>MKWS demo client</title>
64         <script type="text/javascript" src="//mkws.indexdata.com/mkws-complete.js"></script>
65         <link rel="stylesheet" href="//mkws.indexdata.com/mkws.css" />
66       </head>
67       <body>
68         <div class="mkws-search"></div>
69         <div class="mkws-results"></div>
70       </body>
71     </html>
72
73 Go ahead, try it! Simply put the above in a file (e.g index.html),
74 drop it into a folder accessible with an ordinary web-server (e.g
75 Apache) and load it in your web browser. Just like that, you have
76 working metasearching.
77
78 How the example works
79 ---------------------
80
81 If you know any HTML, the structure of the file will be familar to
82 you: the `<html>` element at the top level contains a `<head>` and a
83 `<body>`. In addition to whatever else you might want to put on your
84 page, you can add MKWS elements.
85
86 These fall into two categories. First, the prerequisites in the HTML
87 header, which are loaded from the tool site `mkws.indexdata.com`:
88
89 * `mkws-complete.js`
90   contains all the JavaScript needed by the widget-set, including a
91   copy of the jQuery library.
92
93 * `mkws.css`
94   provides the default CSS styling
95
96 Second, within the HTML body, `<div>` elements with special IDs that
97 begin `mkws-` can be provided. These are filled in by the MKWS code,
98 and provide the components of the searching UI. The very simple
99 application above has only two such widgets: a search box and a
100 results area. But more are supported.
101
102 Defining widget elements
103 ========================
104
105 Widget type
106 -----------
107
108 An HTML element is made an MKWS widget by including an MKWS
109 class-name. These names begin `mkws-`: what follows that prefix
110 specifies the type of the widget. The type can be any sequence of
111 alphanumeric characters and hyphens _except_ something beginning
112 `team` -- see below.
113
114 The main widgets are:
115
116 * `mkws-search` -- provides the search box and button.
117
118 * `mkws-results` -- provides the results area, including a list of
119    brief records (which open out into full versions when clicked),
120    paging for large results sets, facets for refining a search,
121    sorting facilities, etc.
122
123 * `mkws-progress` -- shows a progress bar indicating how many of the
124    targets have responded to the search request.
125
126 * `mkws-stat` -- provides a status line summarising the statistics of
127    the various targets.
128
129 * `mkws-switch` -- provides links to switch between a view of the
130    result records and of the targets that provide them. Only
131    meaningful when `mkws-targets` is also provided.
132
133 * `mkws-targets` -- the area where per-target information will appear
134    when selected by the link in the `mkws-switch` area. Of interest
135    mostly for fault diagnosis rather than for end-users.
136
137 * `mkws-lang` -- provides links to switch between one of several
138    different UI languages. By default, English, Danish and German are
139    provided.
140
141 To see all of these working together, just put them all into the HTML
142 `<body>` like so:
143
144         <div class="mkws-switch"></div>
145         <div class="mkws-lang"></div>
146         <div class="mkws-progress"></div>
147         <div class="mkws-search"></div>
148         <div class="mkws-results"></div>
149         <div class="mkws-targets"></div>
150         <div class="mkws-stat"></div>
151
152 The full set of supported widgets is described in the
153 reference guide below.
154
155 Widget team
156 -----------
157
158 In general a set of widgets work together in a team: in the example
159 above, the search-term that the user enters in the `mkws-search`
160 widget is used to generate the set of records that are displayed in
161 the `mkws-results` widget.
162
163 Sometimes, it's desirable to have multiple teams in a single page. A
164 widget can be placed in a named team by giving it (in addition to its
165 main class) a class that begins with `mkws-team-`: what follows that
166 prefix specifies the team that the widget is part of. For example,
167 `<div class="mkws-search mkws-team-aux">` creates a search widget that
168 is part of the `aux` team.
169
170 Widgets that do not have a team specified (as in the examples above)
171 are placed in the team called `AUTO`.
172
173 Old and new-style class-names
174 -----------------------------
175
176 **NOTE.** Versions of MKWS before v1.0 used camel-case class-names:
177 without hyphens and with second and subsequent words capitalised. So
178 instead of `mkws-search`, it used to be `mkwsSearch`. And the classes
179 used to specify team names used an `mkwsTeam_` prefix (with an
180 underscore). So instead of `mkws-team-foo`, it used to be
181 `mkwsTeam_foo`.
182
183 The 1.x series of MKWS releases recognise these old-style class-names
184 as well as the canonical ones, as a facility for backwards
185 compatibility. However, **these old class-names are deprecated, and
186 support will be removed in v2.0**. Existing applications that use them
187 should be upgraded to the new-style class names as soon as convenient.
188
189 Configuring widgets
190 ===================
191
192 Global configuration
193 --------------------
194
195 Many aspects of the behaviour of MKWS can be modified by setting
196 parameters into the `mkws_config` object. So the HTML header looks
197 like this:
198
199         <script type="text/javascript">
200           var mkws_config = {
201             lang_options: [ "en", "da" ]
202             lang: "da",
203             sort_default: "title",
204             query_width: 60
205           };
206         </script>
207         <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
208
209 This configuration restricts the set of available UI languages English
210 and Danish (omitting German), sets the default to Danish (rather than
211 the English), initially sorts search results by title rather than
212 relevance (though as always this can be changed in the UI) and makes
213 the search box a bit wider than the default.
214
215 The full set of supported configuration items is described in the
216 reference guide below.
217
218 Per-widget configuration
219 ------------------------
220
221 In addition to the global configuration provided by the `mkws_config`
222 object, individual widgets' behaviour can be configured by providing
223 configuration items as attributed on their HTML elements. For example,
224 a `records` widget might be restricted to displaying no more than
225 three records by setting the `numrecs` parameter as follows:
226
227         <div class="mkws-records" maxrecs="3">
228
229 Although this works well, HTML validators will consider this element
230 acceptable, since the `maxrecs` attribute is not part of the HTML
231 schema. However, attributes beginning `data-` are always accepted as
232 HTML extensions, much like email headers beginning with
233 `X-`. Therefore, the widget set also recognises configuration
234 attributes prefixed with `data-mkws-`, so:
235
236         <div class="mkws-records" data-mkws-maxrecs="3">
237
238 For first form is more convenient; the second is more correct.
239
240 Because some configuration items take structured values rather than
241 simple strings, they cannot be directly provided by inline
242 attributes. To allow for this, the special attribute
243 `data-mkws-config`, if provided, is parsed as JSON and its key-value
244 pairs set as configuration items for the widget in question. For
245 example, the value of `lang_options` is an array of strings specifying
246 which of the supported UI languages should be made available. The
247 following invocation will limit this list to only English and Danish
248 (omitting German):
249
250         <div class="mkws-lang" data-mkws-config='{ "lang_options": [ "en", "da" ] }'></div>
251
252 (Note that, as JSON requires double quotes around all strings, single
253 quotes must be used to contain the entire attribute value.)
254
255
256 Control over HTML and CSS
257 =========================
258
259 More sophisticated applications will not simply place the widgets
260 together, but position them carefully within an existing page
261 framework -- such as a Drupal template, an OPAC or a SharePoint page.
262
263 While it's convenient for simple applications to use a monolithic
264 `mkws-results` area which contains record, facets, sorting options,
265 etc., customised layouts may wish to treat each of these components
266 separately. In this case, `mkws-results` can be omitted, and the
267 following lower-level widgets provided instead:
268
269 * `mkws-termlists` -- provides the facets
270
271 * `mkws-ranking` -- provides the options for how records are sorted and
272    how many are included on each page of results.
273
274 * `mkws-pager` -- provides the links for navigating back and forth
275    through the pages of records.
276
277 * `mkws-navi` -- when a search result has been narrowed by one or more
278    facets, this area shows the names of those facets, and allows the
279    selected values to be clicked in order to remove them.
280
281 * `mkws-records` -- lists the actual result records.
282
283 Customisation of MKWS searching widgets can also be achieved by
284 overriding the styles set in the toolkit's CSS stylesheet. The default
285 styles can be inspected in [mkws.css](mkws.css)
286 and overridden in any
287 styles that appears later in the HTML than that file. At the simplest
288 level, this might just mean changing fonts, sizes and colours, but
289 more fundamental changes are also possible.
290
291 To properly apply styles, it's necessary to understand how the HTML is
292 structured, e.g. which elements are nested within which
293 containers. The structures used by the widget-set are described in the
294 reference guide below.
295
296
297 Customised display using Handlebars templates
298 =============================================
299
300 A lot can be done by styling widgets in CSS and changing basic MKWS config
301 options. For further customisation, MKWS allows you to change the markup it
302 outputs for any widget. This is done by overriding the
303 [Handlebars](http://handlebarsjs.com/) template used to generate it. In general
304 these consist of `{{things in double braces}}` that are replaced by values from
305 the system. For details of Handlebars template syntax, see [the online
306 documentation](http://handlebarsjs.com/).
307
308 The templates used by the core widgets can be viewed in [our git
309 repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/templates;).
310 Parameters are documented in a comment at the top of each template so
311 you can see what's going where. If all you want to do is add a CSS class to
312 something or change a `span` to a `div` it's easy to just copy the existing
313 template and make your edits.
314
315 Overriding templates
316 --------------------
317
318 To override the template for a widget, include it inline in the document
319 as a `<script>` tag marked with a class of `mkws-template-foo` where foo is the
320 name of the template you want to override (typically the name of the widget).
321 Inline Handlebars templates are distinguished from Javascript via a
322 `type="text/x-handlebars-template"` attribute. For example, to override the
323 pager template you would include this in your document:
324
325     <script class="mkws-template-pager" type="text/x-handlebars-template">
326       ...new Pager template
327     </script>
328
329 The Facet template has a special feature where you can override it on
330 a per-facet basis by adding a dash and the facet name as a suffix eg.
331 `facet-subjects`. (So `class="mkws-template-facet-subjects"`.) When
332 rendering a facet for which no specific template is defined, the code
333 falls back to using the generic facet template, just called `facet`.
334
335 You can also explicitly specify a different template for a particular
336 instance of a widget by providing the name of your alternative
337 (eg. `special-pager`) as the value of the `template` key in the MKWS
338 config object for that widget: for example, `<div class="mkws-pager"
339 template="special-pager"/>`.
340
341 Templates for MKWS can also be
342 [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled
343 template of the same name is found in the `Handlebars.templates` object, it
344 will be used instead of the default.
345
346 Inspecting metadata for templating
347 ----------------------------------
348
349 MKWS makes requests to the Service Proxy or Pazpar2 that perform the
350 actual searching. Depending on how these are configured and what is
351 available from the targets you are searching there may be more data
352 available than what is presented by the default templates.
353
354 Handlebars offers a convenient log helper that will output the contents of a
355 variable for you to inspect. This lets you look at exactly what is being
356 returned by the back end without needing to use a Javascript debugger. For
357 example, you might prepend `{{log hits}}` to the Records template in order to
358 see what is being returned with each search result in the list. In order for
359 this to work you'll need to enable verbose output from Handlebars which is done
360 by including this line or similar:
361
362     <script>Handlebars.logger.level = 1;</script>
363
364 Internationalisation
365 --------------------
366
367 If you would like your template to use the built in translation functionality,
368 output locale specific text via the mkws-translate helper like so:
369 `{{{mkws-translate "a few words"}}}`.
370
371 Example
372 -------
373
374 Rather than use the toolkit's included AJAX helpers to render record
375 details inline, here's a summary template that will link directly to
376 the source via the address provided in the metadata as the first
377 element of `md-electronic-url`:
378
379     <script class="mkws-template-summary" type="text/x-handlebars-template">
380       <a href="{{md-electronic-url.[0]}}">
381         <b>{{md-title}}</b>
382       </a>
383       {{#if md-title-remainder}}
384         <span>{{md-title-remainder}}</span>
385       {{/if}}
386       {{#if md-title-responsibility}}
387         <span><i>{{md-title-responsibility}}</i></span>
388       {{/if}}
389     </script>
390
391 For a more involved example where markup for multiple widgets is decorated with
392 [Bootstrap](http://getbootstrap.com/) classes and a custom Handlebars helper is
393 employed, take a look at the source of
394 [topic.html](http://example.indexdata.com/topic.html?q=water).
395
396
397 Some Refinements
398 ================
399
400
401 Message of the day
402 ------------------
403
404 Some applications might like to open with content in the area that
405 will subsequently be filled with result-records -- a message of the
406 day, a welcome message or a help page. This can be done by placing an
407 `mkws-motd` division anywhere on the page. It will initially be moved
408 into the `mkws-results` area and displayed, but will be hidden as soon
409 as the first search is made.
410
411
412 Popup results with jQuery UI
413 ----------------------------
414
415 The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI)
416 can be used to construct MKWS applications in which the only widget
417 generally visible on the page is a search box, and the results appear
418 in a popup. The key part of such an application is this invocation of
419 the MKWS jQuery plugin:
420
421         <div class="mkws-search"></div>
422         <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0">
423           <div class="mkws-results"></div>
424         </div>
425
426 The necessary scaffolding can be seen in an example application,
427 [popup.html](http://example.indexdata.com/popup.html).
428
429 The relevant properties (`popup_width`, etc.) are documented
430 [below](#jquery-ui-popup-invocation)
431 in the reference section.
432
433
434 Authentication and target configuration
435 ---------------------------------------
436
437 By default, MKWS configures itself to use a demonstration account on a
438 service hosted by mkws.indexdata.com. This account (username `demo`,
439 password `demo`) provides access to about a dozen free data
440 sources. Authentication onto this service is via an authentication URL
441 on the same MKWS server, so no explicit configuration is needed.
442
443 In order to search in a customised set of targets, including
444 subscription resources, it's necessary to create an account with
445 Index Data's hosted Service Proxy, and protect that account with
446 authentication tokens (to prevent unauthorised use of subscription
447 resources). For information on how to do this, see the next section.
448
449
450 MKWS target selection
451 =====================
452
453 MKWS accesses targets using the Pazpar2 metasearching engine. Although
454 Pazpar2 can be used directly, using a statically configured set of
455 targets, this usage is unusual. More often, Pazpar2 is fronted by the
456 Service Proxy (SP), which manages authentication, sessions, target
457 selection, etc.
458
459 This document assumes the SP is used, and explains how to go about
460 making a set of targets (a "library") available, how to connect your
461 MKWS application to that library, and how to choose which of the
462 available targets to use.
463
464
465 Maintaining the library
466 -----------------------
467
468 The Service Proxy accesses sets of targets that are known as
469 "libraries". In general, each customer will have their own library,
470 though some standard libraries may be shared between many customers --
471 for example, a library containing all open-access academic journals.
472 A library can also contain other configuration information, including
473 the set of categories by which targets are classified for the library.
474
475 Libraries are maintained using MKAdmin (MasterKey
476 Admin). Specifically, those used by MKWS are generally maintained on
477 the "MKX Admin" installation at
478 <http://mkx-admin.indexdata.com/console/>
479
480 In general, Index Data will create a library for each customer, then
481 give the customer a username/password pair that they can use to enter
482 MKAdmin and administrate that library.
483
484 Once logged in, customers can select which targets to include (from
485 the list of several thousand that MKAdmin knows about), and make
486 customer-specific modifications -- e.g. overriding the titles of the
487 targets.
488
489 Most importantly, customers' administrators can add authentication
490 credentials that the Service Proxy will used on their behalf when
491 accessing subscription resources -- username/password pairs or proxies
492 to use for IP-based authentication. Note that **it is then crucial to
493 secure the library from use by unauthorised clients**, otherwise the
494 customer's paid subscriptions will be exploited.
495
496 Access to libraries is managed by creating one or more "User Access"
497 records in MKAdmin, under the tab of that name. Each of these records
498 provides a combination of credentials and other data that allow an
499 incoming MKWS client to be identified as having legitimate access to
500 the library. The authentication process, described below, works by
501 searching for a matching User Access record.
502
503
504 Authenticating your MWKS application onto the library
505 -----------------------------------------------------
506
507 Some MKWS applications will be content to use the default library with
508 its selection of targets. Most, though, will want to define their own
509 library providing a different range of available targets. An important
510 case is that of applications that authenticate onto subscription
511 resources by means of back-end site credentials stored in MKAdmin:
512 precautions must be taken so that such library accounts do not allow
513 unauthorised access.
514
515 Setting up such a library is a process of several stages.
516
517 ### Create the User Access account
518
519 Log in to MKAdmin to add a User Access account for your library:
520
521 * Go to <http://mkx-admin.indexdata.com/console/>
522 * Enter the adminstrative username/password
523 * Go to the User Access tab
524 * Create an end-user account
525 * Depending on what authentication method it be used, set the
526   User Access account's username and password, or referring URL, or
527   Service Proxy hostname, or IP-address range.
528
529 If your MWKS application runs at a well-known, permanent address --
530 <http://yourname.com/app.html>, say -- you can set the User Access
531 record so that this originating URL is recognised by setting it into
532 the "Referring URL" field.
533
534 If your application accesses the Service Proxy by a unique virtual
535 hostname -- yourname.sp-mkws.indexdata.com, say -- you can tie the use
536 of this hostname to your library by setting the User Access record's
537 "Host Name" field to name of the host where the SP is accessed. **Note
538 that this is not secure, as other applications can use this virtual
539 hostname to gain access to your library.**
540
541 Or if your application's users are coming from a well-known range of
542 IP-address space, you can enter the range in the "IP Ranges"
543 field. The format of this field is as follows: it can contain any
544 number of ranges, separated by commas; each range is either a single
545 IP address or two addresses separated by a hyphen; each IP address is
546 four small integers separated by periods. For example,
547 `80.229.143.255-80.229.143.255, 5.57.0.0-5.57.255.255, 127.0.0.1`.
548
549 Alternatively, your application can authenticate by username and
550 password credentials. This is a useful approach in several situations,
551 including when you need to specify the use of a different library from
552 usual one. To arrange for this, set the username and password as a
553 single string separated by a slash -- e.g. "mike/swordfish" -- into
554 the User Access record's Authentication field.
555
556 You can set multiple fields into a single User Access record; or
557 create multiple User Access records. For example, a single User Access
558 record can specify both a Referring URL a username/password pair that
559 can be used when running an application from a different URL. But if
560 multiple Referring URLs are needed, then each must be specified in its
561 own User Access record.
562
563 ### Tell the application to use the library
564
565 In the HTML of the application, tell MKWS to authenticate on to the
566 Service Proxy. When referer-based or IP-based authentication is used,
567 this is very simple:
568
569         <script type="text/javascript">
570           var mkws_config = { service_proxy_auth:
571           "//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig" };
572         </script>
573
574 > TODO This should be the default setting: see **MKWS-251**.
575
576 And ensure that access to the MWKS application is from the correct
577 Referrer URL or IP-range.
578
579 ### (Optional): access by a different virtual hostname
580
581 When hostname-based authentication is in use, it's necessary to access
582 the Service Proxy as the correctly named virtual host. This can be
583 done by setting the `service_proxy_auth` configuration item to a
584 URL containing that hostname, such as
585 `//yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig`
586
587 > TODO It should be possible to change just the hostname without
588 > needing to repeat the rest of the URL (protocol, path, query): see
589 > **MKWS-252**.
590
591 > TODO When changing the SP authentication URL, the Pazpar2 URL should
592 > in general change along with it: see **MKWS-253**.
593
594 ### (Optional): embed credentials for access to the library
595
596 When credential-based authentication is in use (username and
597 password), it's necessary to pass these credentials into the Service
598 Proxy when establishing the session. This can most simply be done just
599 by setting the `service_proxy_auth` configuration item to a URL such as
600 `//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish`
601
602 > TODO It should be possible to add the username and password to the
603 > configuration without needing to repeat the rest of the URL: see
604 > **MKWS-254**.
605
606 ### (Optional): conceal credentials from HTML source
607
608 Using a credential-based Service-Proxy authentication URL such as the
609 one above reveals the the credentials to public view -- to anyone who
610 does View Source on the MKWS application. This may be acceptable for
611 some libraries, but is intolerable for those which provide
612 authenticated access to subscription resources.
613
614 In these circumstances, a more elaborate approach is necessary. The
615 idea is to make a URL local to the customer that is used for
616 authentication onto the Service Proxy, hiding the credentials in a
617 local rewrite rule. Then local mechanisms can be used to limit access
618 to that local authentication URL. Here is one way to do it when
619 Apache2 is the application's web-server, which we will call
620 yourname.com:
621
622 Step 1: add a rewriting authentication alias to the configuration:
623
624         RewriteEngine on
625         RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
626
627 Step 2: set the MKWS configuration item `service_proxy_auth` to
628 <http://yourname.com/spauth/>
629
630 Step 3: protect access to the local path <http://yourname.com/spauth/>
631 (e.g. using a `.htaccess` file).
632
633
634 Choosing targets from the library
635 ---------------------------------
636
637 MKWS applications can choose what subset of the library's targets to
638 use, by means of several alternative settings on individual widgets or
639 in the `mkws_config` structure:
640
641 * `targets` -- contains a Pazpar2 targets string, typically of the form
642   "pz:id=" or "pz:id~" followed by a pipe-separated list of low-level
643   target IDs.
644   At present, these IDs can take one of two forms, depending on the
645   configuration of the Service Proxy being used: they may be based on
646   ZURLs (so a typical value would be something like
647   `pz:id=josiah.brown.edu:210/innopac|lui.indexdata.com:8080/solr4/select?fq=database:4902`)
648   or they may be UDBs (so a typical value would be something like
649   `pz:id=brown|artstor`)
650
651 * `targetfilter` -- contains a CQL query which is used to find relevant
652   targets from the relvant library. For example,
653   `udb==Google_Images`
654   or
655   `categories=news`
656
657 * `target` -- contains a single UDB, that of the sole target to be
658   used. For example,
659   `Google_Images`.
660   This is merely syntactic sugar for "targetfilter" with the query
661   `udb==NAME`
662
663 For example, a `Records` widget can be limited to searching only in
664 targets that have been categorised as news sources by providing an
665 attribute as follows:
666
667         <div class="mkws-records" targetfilter='categories=news'/>
668
669
670 Reference guide
671 ===============
672
673 Configuration object
674 --------------------
675
676 The configuration object `mkws_config` may be created before including
677 the MKWS JavaScript code to modify default behaviour. This structure
678 is a key-value lookup table, whose entries are described in the table
679 below. All entries are optional, but if specified must be given values
680 of the specified type. If ommitted, each setting takes the indicated
681 default value; long default values are in footnotes to keep the table
682 reasonably narrow.
683
684 ----
685 Element                   Type    Default   Description
686 --------                  -----   --------- ------------
687 log_level                 int     1         Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
688                                             datestamps, 3 = messages with datestamps and stack-traces.
689
690 facets                    array   *Note 1*  Ordered list of names of facets to display. Supported facet names are
691                                             `xtargets`, `subject` and `author`.
692
693 lang                      string  en        Code of the default language to display the UI in. Supported language codes are `en` =
694                                             English, `de` = German, `da` = Danish, and whatever additional languages are configured
695                                             using `language_*` entries (see below).
696
697 lang_options              array   []        A list of the languages to offer as options. If empty (the default), then all
698                                             configured languages are listed.
699
700 language_*                hash              Support for any number of languages can be added by providing entries whose name is
701                                             `language_` followed by the code of the language. See the separate section below for
702                                             details.
703
704 pazpar2_url               string  *Note 2*  The URL used to access the metasearch middleware. This service must be configured to
705                                             provide search results, facets, etc. It may be either unmediated or Pazpar2 the
706                                             MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In
707                                             the latter case, `service_proxy_auth` must be provided.
708
709 perpage_default           string  20        The initial value for the number of records to show on each page.
710
711 perpage_options           array   *Note 3*  A list of candidate page sizes. Users can choose between these to determine how many
712                                             records are displayed on each page of results.
713
714 query_width               int     50        The width of the query box, in characters.
715
716 responsive_design_width   int               If defined, then the facets display moves between two locations as the screen-width
717                                             varies, as described above. The specified number is the threshhold width, in pixels,
718                                             at which the facets move between their two locations.
719
720 service_proxy_auth        url     *Note 4*  A URL which, when `use_service_proxy` is true, is fetched once at the beginning of each
721                                             session to authenticate the user and establish a session that encompasses a defined set
722                                             of targets to search in.
723
724 service_proxy_auth_domain domain            Can be set to the domain for which `service_proxy_auth` proxies authentication, so
725                                             that cookies are rewritten to appear to be from this domain. In general, this is not
726                                             necessary, as this setting defaults to the domain of `pazpar2_url`.
727
728 show_lang                 bool    true      Indicates whether or not to display the language menu.
729
730 show_perpage              bool    true      Indicates whether or not to display the perpage menu.
731
732 show_sort                 bool    true      Indicates whether or not to display the sort menu.
733
734 show_switch               bool    true      Indicates whether or not to display the switch menu, for switching between showing
735                                             retrieved records and target information.
736
737 sort_default              string  relevance The label of the default sort criterion to use. Must be one of those in the `sort`
738                                             array.
739
740 sort_options              array   *Note 6*  List of supported sort criteria. Each element of the list is itself a two-element list:
741                                             the first element of each sublist is a pazpar2 sort-expression such as `data:0` and
742                                             the second is a human-readable label such as `newest`.
743
744 use_service_proxy         bool    true      If true, then a Service Proxy is used to deliver searching services rather than raw
745                                             Pazpar2.
746 ----
747
748 Perhaps we should get rid of the `show_lang`, `show_perpage`,
749 `show_sort` and `show_switch` configuration items, and simply display the relevant menus
750 only when their containers are provided -- e.g. an `mkws-lang` element
751 for the language menu. But for now we retain these, as an easier route
752 to lightly customise the display than my changing providing a full HTML
753 structure.
754
755 ### Notes
756
757 1. ["sources", "subjects", "authors"]
758
759 2. /pazpar2/search.pz2
760
761 3. [10, 20, 30, 50]
762
763 4. http://sp-mkws.indexdata.com/service-proxy-auth
764
765 5. http://sp-mkws.indexdata.com/service-proxy/
766
767 6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]
768
769
770 Language specification
771 ----------------------
772
773 Support for another UI language can be added by providing an entry in
774 the `mkws_config` object whose name is `language_` followed by the
775 name of the language: for example, `language_French` to support
776 French. Then value of this entry must be a key-value lookup table,
777 mapping the English-language strings of the UI into their equivalents
778 in the specified language. For example:
779
780             var mkws_config = {
781               language_French: {
782                 "Authors": "Auteurs",
783                 "Subjects": "Sujets",
784                 // ... and others ...
785               }
786             }
787
788 The following strings occurring in the UI can be translated:
789 `Displaying`,
790 `Next`,
791 `Prev`,
792 `Records`,
793 `Search`,
794 `Sort by`,
795 `Targets`,
796 `Termlists`,
797 `and show`,
798 `found`,
799 `of`,
800 `per page`
801 and
802 `to`.
803
804 In addition, facet names can be translated:
805 `Authors`,
806 `Sources`
807 and
808 `Subjects`.
809
810 Finally, the names of fields in the full-record display can be
811 translated. These include, but may not be limited to:
812 `Author`,
813 `Date`,
814 `Location`,
815 `Subject`
816 and
817 `Title`.
818
819
820
821 jQuery UI popup invocation
822 --------------------------
823
824 The MasterKey Widget Set can be invoked in a popup window on top of the page.
825
826 Note that when using the `popup` layout, facilities from the jQuery UI
827 toolkit are used, so it's necessary to include both CSS and JavaScript
828 from that toolkit. The relevant lines are:
829
830     <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
831     <link rel="stylesheet" type="text/css"
832           href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
833
834     <div class="mkws-search"></div>
835     <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
836       <div class="mkws-switch"></div>
837       <div class="mkws-lang"></div>
838       <div class="mkws-results"></div>
839       <div class="mkws-targets"></div>
840       <div class="mkws-stat"></div>
841     </div>
842
843 ----
844 Element         Type    Default             Description
845 --------        -----   -------             ------------
846 popup_width     string  880                 Width of the popup window (if used), in
847                                             pixels.
848
849 popup_height    string  760                 Height of the popup window (if used), in
850                                             pixels.
851
852 popup_button    string  `input.mkwsButton`  (Never change this.)
853
854 popup_modal     string  0                   Modal confirmation mode. Valid values are 0 or 1
855
856 popup_autoOpen  string  1                   Open popup window on load. Valid values are 0 or 1
857
858 ----
859
860
861 The structure of the HTML generated by the MKWS widgets
862 -------------------------------------------------------
863
864 In order to override the default CSS styles provided by the MasterKey Widget
865 Set, it's necessary to understand that structure of the HTML elements that are
866 generated within the widgets. This knowledge make it possible, for example,
867 to style each `<div>` with class `term` but only when it occurs inside an
868 element with class `mkws-termlists`, so as to avoid inadvertently styling other
869 elements using the same class in the non-MKWS parts of the page.
870
871 The HTML structure is as follows. As in CSS, #ID indicates a unique identifier
872 and .CLASS indicates an instance of a class.
873
874     #mkwsSwitch
875       a*
876
877     #mkwsLang
878       ( a | span )*
879
880     #mkwsSearch
881       form
882         input#mkwsQuery type=text
883         input#mkwsButton type=submit
884
885     #mkwsBlanket
886       (no contents -- used only for masking)
887
888     #mkwsResults
889       table
890         tbody
891           tr
892             td
893               #mkwsTermlists
894                 div.title
895                 div.facet*
896                   div.termtitle
897                   ( a span br )*
898             td
899               div#mkwsRanking
900                 form#mkwsSelect
901                   select#mkwsSort
902                   select#mkwsPerpage
903               #mkwsPager
904               #mkwsNavi
905               #mkwsRecords
906                 div.record*
907                   span (for sequence number)
908                   a (for title)
909                   span (for other information such as author)
910                   div.details (sometimes)
911                     table
912                       tbody
913                         tr*
914                           th
915                           td
916     #mkwsTargets
917       #mkwsBytarget
918         table
919           thead
920             tr*
921               td*
922           tbody
923             tr*
924               td*
925
926     #mkwsStat
927       span.head
928       span.clients
929       span.records
930
931 - - -
932
933 Copyright (C) 2013-2014 Index Data ApS. <http://indexdata.com>