1 % The MKWS manual: embedded metasearching with the MasterKey Widget Set
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.
18 Index Data provides several different toolkits for communicating with
19 its metasearching middleware, trading off varying degrees of
20 flexibility against convenience:
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/)
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.
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.
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/>
39 * [MKDru](http://www.indexdata.com/masterkey-drupal) --
40 a toolkit for embedding MasterKey-like searching into
41 [Drupal](https://www.drupal.org/)
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.
58 [a complete MKWS-based searching application](//example.indexdata.com/simple.html):
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" />
68 <div class="mkws-search"></div>
69 <div class="mkws-results"></div>
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.
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.
86 These fall into two categories. First, the prerequisites in the HTML
87 header, which are loaded from the tool site `mkws.indexdata.com`:
90 contains all the JavaScript needed by the widget-set, including a
91 copy of the jQuery library.
94 provides the default CSS styling
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.
102 Defining widget elements
103 ========================
108 An HTML element is made an MKWS widget by including an MKWS
109 class-name. These names begin `mkws-`: what follows that prefix
110 specifies the type of the widget. The type can be any sequence of
111 alphanumeric characters and hyphens _except_ something beginning
114 The main widgets are:
116 * `mkws-search` -- provides the search box and button.
118 * `mkws-results` -- provides the results area, including a list of
119 brief records (which open out into full versions when clicked),
120 paging for large results sets, facets for refining a search,
121 sorting facilities, etc.
123 * `mkws-progress` -- shows a progress bar indicating how many of the
124 targets have responded to the search request.
126 * `mkws-stat` -- provides a status line summarising the statistics of
129 * `mkws-switch` -- provides links to switch between a view of the
130 result records and of the targets that provide them. Only
131 meaningful when `mkws-targets` is also provided.
133 * `mkws-targets` -- the area where per-target information will appear
134 when selected by the link in the `mkws-switch` area. Of interest
135 mostly for fault diagnosis rather than for end-users.
137 * `mkws-lang` -- provides links to switch between one of several
138 different UI languages. By default, English, Danish and German are
141 To see all of these working together, just put them all into the HTML
144 <div class="mkws-switch"></div>
145 <div class="mkws-lang"></div>
146 <div class="mkws-progress"></div>
147 <div class="mkws-search"></div>
148 <div class="mkws-results"></div>
149 <div class="mkws-targets"></div>
150 <div class="mkws-stat"></div>
152 The full set of supported widgets is described in the
153 reference guide below.
158 In general a set of widgets work together in a team: in the example
159 above, the search-term that the user enters in the `mkws-search`
160 widget is used to generate the set of records that are displayed in
161 the `mkws-results` widget.
163 Sometimes, it's desirable to have multiple teams in a single page. A
164 widget can be placed in a named team by giving it (in addition to its
165 main class) a class that begins with `mkws-team-`: what follows that
166 prefix specifies the team that the widget is part of. For example,
167 `<div class="mkws-search mkws-team-aux">` creates a search widget that
168 is part of the `aux` team.
170 Widgets that do not have a team specified (as in the examples above)
171 are placed in the team called `AUTO`.
173 Old and new-style class-names
174 -----------------------------
176 **NOTE.** Versions of MKWS before v1.0 used camel-case class-names:
177 without hyphens and with second and subsequent words capitalised. So
178 instead of `mkws-search`, it used to be `mkwsSearch`. And the classes
179 used to specify team names used an `mkwsTeam_` prefix (with an
180 underscore). So instead of `mkws-team-foo`, it used to be
183 The 1.x series of MKWS releases recognise these old-style class-names
184 as well as the canonical ones, as a facility for backwards
185 compatibility. However, **these old class-names are deprecated, and
186 support will be removed in v2.0**. Existing applications that use them
187 should be upgraded to the new-style class names as soon as convenient.
195 Many aspects of the behaviour of MKWS can be modified by setting
196 parameters into the `mkws_config` object. So the HTML header looks
199 <script type="text/javascript">
201 lang_options: [ "en", "da" ]
203 sort_default: "title",
207 <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
209 This configuration restricts the set of available UI languages English
210 and Danish (omitting German), sets the default to Danish (rather than
211 the English), initially sorts search results by title rather than
212 relevance (though as always this can be changed in the UI) and makes
213 the search box a bit wider than the default.
215 The full set of supported configuration items is described in the
216 reference guide below.
218 Per-widget configuration
219 ------------------------
221 In addition to the global configuration provided by the `mkws_config`
222 object, individual widgets' behaviour can be configured by providing
223 configuration items as attributed on their HTML elements. For example,
224 a `records` widget might be restricted to displaying no more than
225 three records by setting the `numrecs` parameter as follows:
227 <div class="mkws-records" maxrecs="3">
229 Although this works well, HTML validators will consider this element
230 acceptable, since the `maxrecs` attribute is not part of the HTML
231 schema. However, attributes beginning `data-` are always accepted as
232 HTML extensions, much like email headers beginning with
233 `X-`. Therefore, the widget set also recognises configuration
234 attributes prefixed with `data-mkws-`, so:
236 <div class="mkws-records" data-mkws-maxrecs="3">
238 For first form is more convenient; the second is more correct.
240 Because some configuration items take structured values rather than
241 simple strings, they cannot be directly provided by inline
242 attributes. To allow for this, the special attribute
243 `data-mkws-config`, if provided, is parsed as JSON and its key-value
244 pairs set as configuration items for the widget in question. For
245 example, the value of `lang_options` is an array of strings specifying
246 which of the supported UI languages should be made available. The
247 following invocation will limit this list to only English and Danish
250 <div class="mkws-lang" data-mkws-config='{ "lang_options": [ "en", "da" ] }'></div>
252 (Note that, as JSON requires double quotes around all strings, single
253 quotes must be used to contain the entire attribute value.)
256 Control over HTML and CSS
257 =========================
259 More sophisticated applications will not simply place the widgets
260 together, but position them carefully within an existing page
261 framework -- such as a Drupal template, an OPAC or a SharePoint page.
263 While it's convenient for simple applications to use a monolithic
264 `mkws-results` area which contains record, facets, sorting options,
265 etc., customised layouts may wish to treat each of these components
266 separately. In this case, `mkws-results` can be omitted, and the
267 following lower-level widgets provided instead:
269 * `mkws-termlists` -- provides the facets
271 * `mkws-ranking` -- provides the options for how records are sorted and
272 how many are included on each page of results.
274 * `mkws-pager` -- provides the links for navigating back and forth
275 through the pages of records.
277 * `mkws-navi` -- when a search result has been narrowed by one or more
278 facets, this area shows the names of those facets, and allows the
279 selected values to be clicked in order to remove them.
281 * `mkws-records` -- lists the actual result records.
283 Customisation of MKWS searching widgets can also be achieved by
284 overriding the styles set in the toolkit's CSS stylesheet. The default
285 styles can be inspected in [mkws.css](mkws.css)
286 and overridden in any
287 styles that appears later in the HTML than that file. At the simplest
288 level, this might just mean changing fonts, sizes and colours, but
289 more fundamental changes are also possible.
291 To properly apply styles, it's necessary to understand how the HTML is
292 structured, e.g. which elements are nested within which
293 containers. The structures used by the widget-set are described in the
294 reference guide below.
297 Customised display using Handlebars templates
298 =============================================
300 A lot can be done by styling widgets in CSS and changing basic MKWS config
301 options. For further customisation, MKWS allows you to change the markup it
302 outputs for any widget. This is done by overriding the
303 [Handlebars](http://handlebarsjs.com/) template used to generate it. In general
304 these consist of `{{things in double braces}}` that are replaced by values from
305 the system. For details of Handlebars template syntax, see [the online
306 documentation](http://handlebarsjs.com/).
308 The templates used by the core widgets can be viewed in [our git
309 repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/templates;).
310 Parameters are documented in a comment at the top of each template so
311 you can see what's going where. If all you want to do is add a CSS class to
312 something or change a `span` to a `div` it's easy to just copy the existing
313 template and make your edits.
318 To override the template for a widget, include it inline in the document
319 as a `<script>` tag marked with a class of `mkws-template-foo` where foo is the
320 name of the template you want to override (typically the name of the widget).
321 Inline Handlebars templates are distinguished from Javascript via a
322 `type="text/x-handlebars-template"` attribute. For example, to override the
323 pager template you would include this in your document:
325 <script class="mkws-template-pager" type="text/x-handlebars-template">
326 ...new Pager template
329 The Facet template has a special feature where you can override it on
330 a per-facet basis by adding a dash and the facet name as a suffix eg.
331 `facet-subjects`. (So `class="mkws-template-facet-subjects"`.) When
332 rendering a facet for which no specific template is defined, the code
333 falls back to using the generic facet template, just called `facet`.
335 You can also explicitly specify a different template for a particular
336 instance of a widget by providing the name of your alternative
337 (eg. `special-pager`) as the value of the `template` key in the MKWS
338 config object for that widget: for example, `<div class="mkws-pager"
339 template="special-pager"/>`.
341 Templates for MKWS can also be
342 [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled
343 template of the same name is found in the `Handlebars.templates` object, it
344 will be used instead of the default.
346 Inspecting metadata for templating
347 ----------------------------------
349 MKWS makes requests to the Service Proxy or Pazpar2 that perform the
350 actual searching. Depending on how these are configured and what is
351 available from the targets you are searching there may be more data
352 available than what is presented by the default templates.
354 Handlebars offers a convenient log helper that will output the contents of a
355 variable for you to inspect. This lets you look at exactly what is being
356 returned by the back end without needing to use a Javascript debugger. For
357 example, you might prepend `{{log hits}}` to the Records template in order to
358 see what is being returned with each search result in the list. In order for
359 this to work you'll need to enable verbose output from Handlebars which is done
360 by including this line or similar:
362 <script>Handlebars.logger.level = 1;</script>
367 If you would like your template to use the built in translation functionality,
368 output locale specific text via the mkws-translate helper like so:
369 `{{{mkws-translate "a few words"}}}`.
374 Rather than use the included AJAX helpers to render record details inline,
375 here's a Records template that will link directly to the source via the address
376 provided in the metadata as the first element of `md-electronic-url`:
378 <script class="mkws-template-records" type="text/x-handlebars-template">
380 <div class="{{containerClass}}">
381 <a href="{{md-electronic-url.[0]}}">
384 {{#if md-title-remainder}}
385 <span>{{md-title-remainder}}</span>
387 {{#if md-title-responsibility}}
388 <span><i>{{md-title-responsibility}}</i></span>
394 For a more involved example where markup for multiple widgets is decorated with
395 [Bootstrap](http://getbootstrap.com/) classes and a custom Handlebars helper is
396 employed, take a look at the source of
397 [topic.html](http://example.indexdata.com/topic.html?q=water).
407 Some applications might like to open with content in the area that
408 will subsequently be filled with result-records -- a message of the
409 day, a welcome message or a help page. This can be done by placing an
410 `mkws-motd` division anywhere on the page. It will be moved into the
411 `mkws-results` area and initially displayed, but will be hidden when a
415 Popup results with jQuery UI
416 ----------------------------
418 The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI)
419 can be used to construct MKWS applications in which the only widget
420 generally visible on the page is a search box, and the results appear
421 in a popup. The key part of such an application is this invocation of
422 the MKWS jQuery plugin:
424 <div class="mkws-search"></div>
425 <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
426 <div class="mkws-switch"></div>
427 <div class="mkws-lang"></div>
428 <div class="mkws-results"></div>
429 <div class="mkws-targets"></div>
430 <div class="mkws-stat"></div>
433 The necessary scaffolding can be seen in an example application,
434 http://example.indexdata.com/index-popup.html
437 Authentication and target configuration
438 ---------------------------------------
440 By default, MKWS configures itself to use a demonstration account on a
441 service hosted by mkws.indexdata.com. This account (username `demo`,
442 password `demo`) provides access to about a dozen free data
443 sources. Authentication onto this service is via an authentication URL
444 on the same MKWS server, so no explicit configuration is needed.
446 In order to search in a customised set of targets, including
447 subscription resources, it's necessary to create an account with
448 Index Data's hosted Service Proxy, and protect that account with
449 authentication tokens (to prevent unauthorised use of subscription
450 resources). For information on how to do this, see the next section.
453 MKWS target selection
454 =====================
456 MKWS accesses targets using the Pazpar2 metasearching engine. Although
457 Pazpar2 can be used directly, using a statically configured set of
458 targets, this usage is unusual. More often, Pazpar2 is fronted by the
459 Service Proxy (SP), which manages authentication, sessions, target
462 This document assumes the SP is used, and explains how to go about
463 making a set of targets (a "library") available, how to connect your
464 MKWS application to that library, and how to choose which of the
465 available targets to use.
468 Maintaining the library
469 -----------------------
471 The Service Proxy accesses sets of targets that are known as
472 "libraries". In general, each customer will have their own library,
473 though some standard libraries may be shared between many customers --
474 for example, a library containing all open-access academic journals.
475 A library can also contain other configuration information, including
476 the set of categories by which targets are classified for the library.
478 Libraries are maintained using MKAdmin (MasterKey
479 Admin). Specifically, those used by MKWS are generally maintained on
480 the "MKX Admin" installation at
481 <http://mkx-admin.indexdata.com/console/>
483 In general, Index Data will create a library for each customer, then
484 give the customer a username/password pair that they can use to enter
485 MKAdmin and administrate that library.
487 Once logged in, customers can select which targets to include (from
488 the list of several thousand that MKAdmin knows about), and make
489 customer-specific modifications -- e.g. overriding the titles of the
492 Most importantly, customers' administrators can add authentication
493 credentials that the Service Proxy will used on their behalf when
494 accessing subscription resources -- username/password pairs or proxies
495 to use for IP-based authentication. Note that **it is then crucial to
496 secure the library from use by unauthorised clients**, otherwise the
497 customer's paid subscriptions will be exploited.
499 Access to libraries is managed by creating one or more "User Access"
500 records in MKAdmin, under the tab of that name. Each of these records
501 provides a combination of credentials and other data that allow an
502 incoming MKWS client to be identified as having legitimate access to
503 the library. The authentication process, described below, works by
504 searching for a matching User Access record.
507 Authenticating your MWKS application onto the library
508 -----------------------------------------------------
510 Some MKWS applications will be content to use the default library with
511 its selection of targets. Most, though, will want to define their own
512 library providing a different range of available targets. An important
513 case is that of applications that authenticate onto subscription
514 resources by means of back-end site credentials stored in MKAdmin:
515 precautions must be taken so that such library accounts do not allow
518 Setting up such a library is a process of several stages.
520 ### Create the User Access account
522 Log in to MKAdmin to add a User Access account for your library:
524 * Go to <http://mkx-admin.indexdata.com/console/>
525 * Enter the adminstrative username/password
526 * Go to the User Access tab
527 * Create an end-user account
528 * Depending on what authentication method it be used, set the
529 User Access account's username and password, or referring URL, or
530 Service Proxy hostname, or IP-address range.
532 If your MWKS application runs at a well-known, permanent address --
533 <http://yourname.com/app.html>, say -- you can set the User Access
534 record so that this originating URL is recognised by setting it into
535 the "Referring URL" field.
537 If your application accesses the Service Proxy by a unique virtual
538 hostname -- yourname.sp-mkws.indexdata.com, say -- you can tie the use
539 of this hostname to your library by setting the User Access record's
540 "Host Name" field to name of the host where the SP is accessed. **Note
541 that this is not secure, as other applications can use this virtual
542 hostname to gain access to your library.**
544 Or if your application's users are coming from a well-known range of
545 IP-address space, you can enter the range in the "IP Ranges"
546 field. The format of this field is as follows: it can contain any
547 number of ranges, separated by commas; each range is either a single
548 IP address or two addresses separated by a hyphen; each IP address is
549 four small integers separated by periods. For example,
550 `80.229.143.255-80.229.143.255, 5.57.0.0-5.57.255.255, 127.0.0.1`.
552 Alternatively, your application can authenticate by username and
553 password credentials. This is a useful approach in several situations,
554 including when you need to specify the use of a different library from
555 usual one. To arrange for this, set the username and password as a
556 single string separated by a slash -- e.g. "mike/swordfish" -- into
557 the User Access record's Authentication field.
559 You can set multiple fields into a single User Access record; or
560 create multiple User Access records. For example, a single User Access
561 record can specify both a Referring URL a username/password pair that
562 can be used when running an application from a different URL. But if
563 multiple Referring URLs are needed, then each must be specified in its
564 own User Access record.
566 ### Tell the application to use the library
568 In the HTML of the application, tell MKWS to authenticate on to the
569 Service Proxy. When referer-based or IP-based authentication is used,
572 <script type="text/javascript">
573 var mkws_config = { service_proxy_auth:
574 "//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig" };
577 > TODO This should be the default setting: see **MKWS-251**.
579 And ensure that access to the MWKS application is from the correct
580 Referrer URL or IP-range.
582 ### (Optional): access by a different virtual hostname
584 When hostname-based authentication is in use, it's necessary to access
585 the Service Proxy as the correctly named virtual host. This can be
586 done by setting the `service_proxy_auth` configuration item to a
587 URL containing that hostname, such as
588 `//yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig`
590 > TODO It should be possible to change just the hostname without
591 > needing to repeat the rest of the URL (protocol, path, query): see
594 > TODO When changing the SP authentication URL, the Pazpar2 URL should
595 > in general change along with it: see **MKWS-253**.
597 ### (Optional): embed credentials for access to the library
599 When credential-based authentication is in use (username and
600 password), it's necessary to pass these credentials into the Service
601 Proxy when establishing the session. This can most simply be done just
602 by setting the `service_proxy_auth` configuration item to a URL such as
603 `//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish`
605 > TODO It should be possible to add the username and password to the
606 > configuration without needing to repeat the rest of the URL: see
609 ### (Optional): conceal credentials from HTML source
611 Using a credential-based Service-Proxy authentication URL such as the
612 one above reveals the the credentials to public view -- to anyone who
613 does View Source on the MKWS application. This may be acceptable for
614 some libraries, but is intolerable for those which provide
615 authenticated access to subscription resources.
617 In these circumstances, a more elaborate approach is necessary. The
618 idea is to make a URL local to the customer that is used for
619 authentication onto the Service Proxy, hiding the credentials in a
620 local rewrite rule. Then local mechanisms can be used to limit access
621 to that local authentication URL. Here is one way to do it when
622 Apache2 is the application's web-server, which we will call
625 Step 1: add a rewriting authentication alias to the configuration:
628 RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
630 Step 2: set the MKWS configuration item `service_proxy_auth` to
631 <http://yourname.com/spauth/>
633 Step 3: protect access to the local path <http://yourname.com/spauth/>
634 (e.g. using a `.htaccess` file).
637 Choosing targets from the library
638 ---------------------------------
640 MKWS applications can choose what subset of the library's targets to
641 use, by means of several alternative settings on individual widgets or
642 in the `mkws_config` structure:
644 * `targets` -- contains a Pazpar2 targets string, typically of the form
645 "pz:id=" or "pz:id~" followed by a pipe-separated list of low-level
647 At present, these IDs can take one of two forms, depending on the
648 configuration of the Service Proxy being used: they may be based on
649 ZURLs (so a typical value would be something like
650 `pz:id=josiah.brown.edu:210/innopac|lui.indexdata.com:8080/solr4/select?fq=database:4902`)
651 or they may be UDBs (so a typical value would be something like
652 `pz:id=brown|artstor`)
654 * `targetfilter` -- contains a CQL query which is used to find relevant
655 targets from the relvant library. For example,
660 * `target` -- contains a single UDB, that of the sole target to be
663 This is merely syntactic sugar for "targetfilter" with the query
666 For example, a `Records` widget can be limited to searching only in
667 targets that have been categorised as news sources by providing an
668 attribute as follows:
670 <div class="mkws-records" targetfilter='categories=news'/>
679 The configuration object `mkws_config` may be created before including
680 the MKWS JavaScript code to modify default behaviour. This structure
681 is a key-value lookup table, whose entries are described in the table
682 below. All entries are optional, but if specified must be given values
683 of the specified type. If ommitted, each setting takes the indicated
684 default value; long default values are in footnotes to keep the table
688 Element Type Default Description
689 -------- ----- --------- ------------
690 log_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
691 datestamps, 3 = messages with datestamps and stack-traces.
693 facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
694 `xtargets`, `subject` and `author`.
696 lang string en Code of the default language to display the UI in. Supported language codes are `en` =
697 English, `de` = German, `da` = Danish, and whatever additional languages are configured
698 using `language_*` entries (see below).
700 lang_options array [] A list of the languages to offer as options. If empty (the default), then all
701 configured languages are listed.
703 language_* hash Support for any number of languages can be added by providing entries whose name is
704 `language_` followed by the code of the language. See the separate section below for
707 pazpar2_url string *Note 2* The URL used to access the metasearch middleware. This service must be configured to
708 provide search results, facets, etc. It may be either unmediated or Pazpar2 the
709 MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In
710 the latter case, `service_proxy_auth` must be provided.
712 perpage_default string 20 The initial value for the number of records to show on each page.
714 perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many
715 records are displayed on each page of results.
717 query_width int 50 The width of the query box, in characters.
719 responsive_design_width int If defined, then the facets display moves between two locations as the screen-width
720 varies, as described above. The specified number is the threshhold width, in pixels,
721 at which the facets move between their two locations.
723 service_proxy_auth url *Note 4* A URL which, when `use_service_proxy` is true, is fetched once at the beginning of each
724 session to authenticate the user and establish a session that encompasses a defined set
725 of targets to search in.
727 service_proxy_auth_domain domain Can be set to the domain for which `service_proxy_auth` proxies authentication, so
728 that cookies are rewritten to appear to be from this domain. In general, this is not
729 necessary, as this setting defaults to the domain of `pazpar2_url`.
731 show_lang bool true Indicates whether or not to display the language menu.
733 show_perpage bool true Indicates whether or not to display the perpage menu.
735 show_sort bool true Indicates whether or not to display the sort menu.
737 show_switch bool true Indicates whether or not to display the switch menu, for switching between showing
738 retrieved records and target information.
740 sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort`
743 sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list:
744 the first element of each sublist is a pazpar2 sort-expression such as `data:0` and
745 the second is a human-readable label such as `newest`.
747 use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw
751 Perhaps we should get rid of the `show_lang`, `show_perpage`,
752 `show_sort` and `show_switch` configuration items, and simply display the relevant menus
753 only when their containers are provided -- e.g. an `mkws-lang` element
754 for the language menu. But for now we retain these, as an easier route
755 to lightly customise the display than my changing providing a full HTML
760 1. ["sources", "subjects", "authors"]
762 2. /pazpar2/search.pz2
766 4. http://sp-mkws.indexdata.com/service-proxy-auth
768 5. http://sp-mkws.indexdata.com/service-proxy/
770 6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]
773 Language specification
774 ----------------------
776 Support for another UI language can be added by providing an entry in
777 the `mkws_config` object whose name is `language_` followed by the
778 name of the language: for example, `language_French` to support
779 French. Then value of this entry must be a key-value lookup table,
780 mapping the English-language strings of the UI into their equivalents
781 in the specified language. For example:
785 "Authors": "Auteurs",
786 "Subjects": "Sujets",
787 // ... and others ...
791 The following strings occurring in the UI can be translated:
807 In addition, facet names can be translated:
813 Finally, the names of fields in the full-record display can be
814 translated. These include, but may not be limited to:
824 jQuery UI popup invocation
825 --------------------------
827 The MasterKey Widget Set can be invoked in a popup window on top of the page.
829 Note that when using the `popup` layout, facilities from the jQuery UI
830 toolkit are used, so it's necessary to include both CSS and JavaScript
831 from that toolkit. The relevant lines are:
833 <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
834 <link rel="stylesheet" type="text/css"
835 href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
837 <div class="mkws-search"></div>
838 <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
839 <div class="mkws-switch"></div>
840 <div class="mkws-lang"></div>
841 <div class="mkws-results"></div>
842 <div class="mkws-targets"></div>
843 <div class="mkws-stat"></div>
847 Element Type Default Description
848 -------- ----- ------- ------------
849 popup_width string 880 Width of the popup window (if used), in
852 popup_height string 760 Height of the popup window (if used), in
855 popup_button string `input.mkwsButton` (Never change this.)
857 popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1
859 popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1
864 The structure of the HTML generated by the MKWS widgets
865 -------------------------------------------------------
867 In order to override the default CSS styles provided by the MasterKey Widget
868 Set, it's necessary to understand that structure of the HTML elements that are
869 generated within the widgets. This knowledge make it possible, for example,
870 to style each `<div>` with class `term` but only when it occurs inside an
871 element with class `mkws-termlists`, so as to avoid inadvertently styling other
872 elements using the same class in the non-MKWS parts of the page.
874 The HTML structure is as follows. As in CSS, #ID indicates a unique identifier
875 and .CLASS indicates an instance of a class.
885 input#mkwsQuery type=text
886 input#mkwsButton type=submit
889 (no contents -- used only for masking)
910 span (for sequence number)
912 span (for other information such as author)
913 div.details (sometimes)
936 Copyright (C) 2013-2014 Index Data ApS. <http://indexdata.com>