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