doc/mkws-manual.markdown

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