doc/mkws-manual.markdown

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