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