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