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="mkwsSearch"></div>
69 <div class="mkwsResults"></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.
93 provides the default CSS styling
95 Second, within the HTML body, `<div>` elements with special IDs that
96 begin `mkws` can be provided. These are filled in by the MKWS code,
97 and provide the components of the searching UI. The very simple
98 application above has only two such widgets: a search box and a
99 results area. But more are supported. The main widgets are:
101 * `mkwsSearch` -- provides the search box and button.
103 * `mkwsResults` -- provides the results area, including a list of
104 brief records (which open out into full versions when clicked),
105 paging for large results sets, facets for refining a search,
106 sorting facilities, etc.
108 * `mkwsStat` --provides a status line summarising the statistics of
111 * `mkwsSwitch` -- provides links to switch between a view of the
112 result records and of the targets that provide them. Only
113 meaningful when `mkwsTargets` is also provided.
115 * `mkwsTargets` -- the area where per-target information will appear
116 when selected by the link in the `mkwsSwitch` area. Of interest
117 mostly for fault diagnosis rather than for end-users.
119 * `mkwsLang` -- provides links to switch between one of several
120 different UI languages. By default, English, Danish and German are
123 To see all of these working together, just put them all into the HTML
126 <div id="mkwsSwitch"></div>
127 <div id="mkwsLang"></div>
128 <div id="mkwsSearch"></div>
129 <div id="mkwsResults"></div>
130 <div id="mkwsTargets"></div>
131 <div id="mkwsStat"></div>
133 The full set of supported widgets is described in the
134 reference guide below.
140 Many aspects of the behaviour of MKWS can be modified by setting
141 parameters into the `mkws_config` object. So the HTML header looks
144 <script type="text/javascript">
147 sort_default: "title",
151 <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
153 This configuration sets the UI language to Danish (rather than the
154 default of English), initially sorts search results by title rather
155 than relevance (though as always this can be changed in the UI) and
156 makes the search box a bit wider than the default.
158 The full set of supported configuration items is described in the
159 reference guide below.
162 Control over HTML and CSS
163 =========================
165 More sophisticated applications will not simply place the `<div>`s
166 together, but position them carefully within an existing page
167 framework -- such as a Drupal template, an OPAC or a SharePoint page.
169 While it's convenient for simple applications to use a monolithic
170 `mkwsResults` area which contains record, facets, sorting options,
171 etc., customised layouts may wish to treat each of these components
172 separately. In this case, `mkwsResults` can be omitted, and the
173 following lower-level widgets provided instead:
175 * `mkwsTermlists` -- provides the facets
177 * `mkwsRanking` -- provides the options for how records are sorted and
178 how many are included on each page of results.
180 * `mkwsPager` -- provides the links for navigating back and forth
181 through the pages of records.
183 * `mkwsNavi` -- when a search result has been narrowed by one or more
184 facets, this area shows the names of those facets, and allows the
185 selected values to be clicked in order to remove them.
187 * `mkwsRecords` -- lists the actual result records.
189 Customisation of MKWS searching widgets can also be achieved by
190 overriding the styles set in the toolkit's CSS stylesheet. The default
191 styles can be inspected in [mkws.css](mkws.css)
192 and overridden in any
193 styles that appears later in the HTML than that file. At the simplest
194 level, this might just mean changing fonts, sizes and colours, but
195 more fundamental changes are also possible.
197 To properly apply styles, it's necessary to understand how the HTML is
198 structured, e.g. which elements are nested within which
199 containers. The structures used by the widget-set are described in the
200 reference guide below.
203 Customised display using Handlebars templates
204 =============================================
206 A lot can be done by styling widgets in CSS and changing basic MKWS config
207 options. For further customisation, MKWS allows you to change the markup it
208 outputs for any widget. This is done by overriding the
209 [Handlebars](http://handlebarsjs.com/) template used to generate it. In general
210 these consist of `{{things in double braces}}` that are replaced by values from
211 the system. For details of Handlebars template syntax, see [the online
212 documentation](http://handlebarsjs.com/).
214 The templates used by the core widgets can be viewed in [our git
215 repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/mkws.templates;).
216 Parameters are documented in a comment at the top of each template so
217 you can see what's going where. If all you want to do is add a CSS class to
218 something or change a `span` to a `div` it's easy to just copy the existing
219 template and make your edits.
224 To override the template for a widget, include it inline in the document
225 as a `<script>` tag marked with a class of `mkwsTemplate_Foo` where Foo is the
226 name of the template you want to override (typically the name of the widget).
227 Inline Handlebars templates are distinguished from Javascript via a
228 `type="text/x-handlebars-template"` attribute. For example, to override the
229 Pager template you would include this in your document:
231 <script class="mkwsTemplate_Pager" type="text/x-handlebars-template">
232 ...new Pager template
235 The Facet template has a special feature where you can override it on a
236 per-facet basis by adding a dash and the facet name as a suffix eg.
237 `Facet-Subjects` rather than `Facet`. (So `class="mkwsTemplate_Facet-Subjects"`)
239 You can also explicitly specify a different template for a particular instance
240 of a widget by providing the name of your alternative (eg. SpecialPager) as the
241 value of the `template` key in the MKWS config object for that widget:
242 for example, `<div class="mkwsPager" template="specialPager"/>`.
244 Templates for MKWS can also be
245 [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled
246 template of the same name is found in the `Handlebars.templates` object, it
247 will be used instead of the default.
249 Inspecting metadata for templating
250 ----------------------------------
252 MKWS makes requests to Service Proxy or Pazpar2 that perform the actual
253 searching. Depending on how these are configured and what is available from the
254 targets you are searching there may be more data available than what is
255 presented by the default templates.
257 Handlebars offers a convenient log helper that will output the contents of a
258 variable for you to inspect. This lets you look at exactly what is being
259 returned by the back end without needing to use a Javascript debugger. For
260 example, you might prepend `{{log hits}}` to the Records template in order to
261 see what is being returned with each search result in the list. In order for
262 this to work you'll need to enable verbose output from Handlebars which is done
263 by including this line or similar:
265 <script>Handlebars.logger.level = 1;</script>
270 If you would like your template to use the built in translation functionality,
271 output locale specific text via the mkws-translate helper like so:
272 `{{{mkws-translate "a few words"}}}`.
277 Rather than use the included AJAX helpers to render record details inline,
278 here's a Records template that will link directly to the source via the address
279 provided in the metadata as the first element of `md-electronic-url`:
281 <script class="mkwsTemplate_Records" type="text/x-handlebars-template">
283 <div class="{{containerClass}}">
284 <a href="{{md-electronic-url.[0]}}">
287 {{#if md-title-remainder}}
288 <span>{{md-title-remainder}}</span>
290 {{#if md-title-responsibility}}
291 <span><i>{{md-title-responsibility}}</i></span>
297 For a more involved example where markup for multiple widgets is decorated with
298 [Bootstrap](http://getbootstrap.com/) classes and a custom Handlebars helper is
299 employed, take a look at the source of
300 [topic.html](http://example.indexdata.com/topic.html?q=water).
310 Some applications might like to open with content in the area that
311 will subsequently be filled with result-records -- a message of the
312 day, a welcome message or a help page. This can be done by placing an
313 `mkwsMOTD` division anywhere on the page. It will be moved into the
314 `mkwsResults` area and initially displayed, but will be hidden when a
321 Metasearching applications may need to appear differently on
322 small-screened mobile devices, or change their appearance when
323 screen-width changes (as when a small device is rotated). To achieve
324 this, MKWS supports responsive design which will move the termlists to
325 the bottom on narrow screens and to the sidebar on wide screens.
327 To turn on this behaviour, set the `responsive_design_width` to the desired
328 threshhold width in pixels. For example:
330 <script type="text/javascript">
332 responsive_design_width: 990
336 If individual result-related widgets are in use in place of the
337 all-in-one mkwsResults, then the redesigned application needs to
338 specify the locations where the termlists should appear in both
339 cases. In this case, wrap the wide-screen `mkwsTermlists` element in a
340 `mkwsTermlists-Container-wide` element; and provide an
341 `mkwsTermlists-Container-narrow` element in the place where the narrow-screen
342 termlists should appear.
345 Popup results with jQuery UI
346 ----------------------------
348 The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI)
349 can be used to construct MKWS applications in which the only widget
350 generally visible on the page is a search box, and the results appear
351 in a popup. The key part of such an application is this invocation of
352 the MKWS jQuery plugin:
354 <div class="mkwsSearch"></div>
355 <div class="mkwsPopup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
356 <div class="mkwsSwitch"></div>
357 <div class="mkwsLang"></div>
358 <div class="mkwsResults"></div>
359 <div class="mkwsTargets"></div>
360 <div class="mkwsStat"></div>
363 The necessary scaffolding can be seen in an example application,
364 http://example.indexdata.com/index-popup.html
367 Authentication and target configuration
368 ---------------------------------------
370 By default, MKWS configures itself to use a demonstration account on a
371 service hosted by mkws.indexdata.com. This account (username `demo`,
372 password `demo`) provides access to about a dozen free data
373 sources. Authentication onto this service is via an authentication URL
374 on the same MKWS server, so no explicit configuration is needed.
376 In order to search in a customised set of targets, including
377 subscription resources, it's necessary to create an account with
378 Index Data's hosted service proxy, and protect that account with
379 authentication tokens (to prevent unauthorised use of subscription
380 resources). For information on how to do this, see the next section.
383 MKWS Target Selection
384 =====================
386 MKWS accesses targets using the Pazpar2 metasearching engine. Although
387 Pazpar2 can be used directly, using a statically configured set of
388 targets, this usage is unusual. More often, Pazpar2 is fronted by the
389 Service Proxy (SP), which manages authentication, sessions, target
392 This document assumes the SP is used, and explains how to go about
393 making a set of targets (a "library") available, how to connect your
394 MKWS application to that library, and how to choose which of the
395 available targets to use.
398 Maintaining the library
399 -----------------------
401 The service proxy accesses sets of targets that are known as
402 "libraries". In general, each customer will have their own library,
403 though some standard libraries may be shared between many customers --
404 for example, a library containing all open-access academic journals.
405 A library can also contain other configuration information, including
406 the set of categories by which targets are classified for the library.
408 Libraries are maintained using MKAdmin (MasterKey
409 Admin). Specifically, those used by MKWS are generally maintained on
410 the "MKX Admin" installation at
411 <http://mkx-admin.indexdata.com/console/>
413 In general, Index Data will create a library for each customer, then
414 give the customer a username/password pair that they can use to enter
415 MKAdmin and administrate that library.
417 Once logged in, customers can select which targets to include (from
418 the list of several thousand that MKAdmin knows about), and make
419 customer-specific modifications -- e.g. overriding the titles of the
422 Most importantly, customers' administrators can add authentication
423 credentials that the Service Proxy will used on their behalf when
424 accessing subscription resources -- username/password pairs or proxies
425 to use for IP-based authentication. Note that **it is then crucial to
426 secure the library from use by unauthorised clients**, otherwise the
427 customer's paid subscriptions will be exploited.
429 Access to libraries is managed by creating one or more "User Access"
430 records in MKAdmin, under the tab of that name. Each of these records
431 provides a combination of credentials and other data that allow an
432 incoming MKWS client to be identified as having legitimate access to
433 the library. The authentication process, described below, works by
434 searching for a matching User Access record.
437 Authenticating your MWKS application onto the library
438 -----------------------------------------------------
440 Some MKWS applications will be content to use the default library with
441 its selection of targets. Most, though, will want to define their own
442 library providing a different range of available targets. An important
443 case is that of applications that authenticate onto subscription
444 resources by means of back-end site credentials stored in MKAdmin:
445 precautions must be taken so that such library accounts do not allow
448 Setting up such a library is a process of several stages.
450 ### Create the User Access account
452 Log in to MKAdmin to add a User Access account for your library:
454 * Go to <http://mkx-admin.indexdata.com/console/>
455 * Enter the adminstrative username/password
456 * Go to the User Access tab
457 * Create an end-user account
458 * Depending on what authentication method it be used, set the
459 User Access account's username and password, or referring URL, or
460 Service Proxy hostname, or IP-address range.
462 If your MWKS application runs at a well-known, permanent address --
463 <http://yourname.com/app.html>, say -- you can set the User Access
464 record so that this originating URL is recognised by setting it into
465 the "Referring URL" field.
467 If your application accesses the Service Proxy by a unique virtual
468 hostname -- yourname.sp-mkws.indexdata.com, say -- you can tie the use
469 of this hostname to your library by setting the User Access record's
470 "Host Name" field to name of the host where the SP is accessed. **Note
471 that this is not secure, as other applications can use this virtual
472 hostname to gain access to your library.**
474 Or if your application's users are coming from a well-known range of
475 IP-address space, you can enter the range in the "IP Ranges"
476 field. The format of this field is as follows: it can contain any
477 number of ranges, separated by commas; each range is either a single
478 IP address or two addresses separated by a hyphen; each IP address is
479 four small integers separated by periods. For example,
480 `80.229.143.255-80.229.143.255, 5.57.0.0-5.57.255.255, 127.0.0.1`.
482 Alternatively, your application can authenticate by username and
483 password credentials. This is a useful approach in several situations,
484 including when you need to specify the use of a different library from
485 usual one. To arrange for this, set the username and password as a
486 single string separated by a slash -- e.g. "mike/swordfish" -- into
487 the User Access record's Authentication field.
489 You can set multiple fields into a single User Access record; or
490 create multiple User Access records. For example, a single User Access
491 record can specify both a Referring URL a username/password pair that
492 can be used when running an application from a different URL. But if
493 multiple Referring URLs are needed, then each must be specified in its
494 own User Access record.
496 ### Tell the application to use the library
498 In the HTML of the application, tell MKWS to authenticate on to the
499 Service Proxy. When referer-based or IP-based authentication is used,
502 <script type="text/javascript">
503 var mkws_config = { service_proxy_auth:
504 "//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig" };
507 > TODO This should be the default setting: see **MKWS-251**.
509 And ensure that access to the MWKS application is from the correct
510 Referrer URL or IP-range.
512 ### (Optional): access by a different virtual hostname
514 When hostname-based authentication is in use, it's necessary to access
515 the Service Proxy as the correctly named virtual host. This can be
516 done by setting the `service_proxy_auth` configuration item to a
517 URL containing that hostname, such as
518 `//yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig`
520 > TODO It should be possible to change just the hostname without
521 > needing to repeat the rest of the URL (protocol, path, query): see
524 > TODO When changing the SP authentication URL, the Pazpar2 URL should
525 > in general change along with it: see **MKWS-253**.
527 ### (Optional): embed credentials for access to the library
529 When credential-based authentication is in use (username and
530 password), it's necessary to pass these credentials into the Service
531 Proxy when establishing the session. This can most simply be done just
532 by setting the `service_proxy_auth` configuration item to a URL such as
533 `//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish`
535 > TODO It should be possible to add the username and password to the
536 > configuration without needing to repeat the rest of the URL: see
539 ### (Optional): conceal credentials from HTML source
541 Using a credential-based Service-Proxy authentication URL such as the
542 one above reveals the the credentials to public view -- to anyone who
543 does View Source on the MKWS application. This may be acceptable for
544 some libraries, but is intolerable for those which provide
545 authenticated access to subscription resources.
547 In these circumstances, a more elaborate approach is necessary. The
548 idea is to make a URL local to the customer that is used for
549 authentication onto the Service Proxy, hiding the credentials in a
550 local rewrite rule. Then local mechanisms can be used to limit access
551 to that local authentication URL. Here is one way to do it when
552 Apache2 is the application's web-server, which we will call
555 Step 1: add a rewriting authentication alias to the configuration:
558 RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
560 Step 2: set the MKWS configuration item `service_proxy_auth` to
561 <http://yourname.com/spauth/>
563 Step 3: protect access to the local path <http://yourname.com/spauth/>
564 (e.g. using a `.htaccess` file).
567 Choosing targets from the library
568 ---------------------------------
570 MKWS applications can choose what subset of the library's targets to
571 use, by means of several alternative settings on individual widgets or
572 in the `mkws_config` structure:
574 * `targets` -- contains a Pazpar2 targets string, typically of the form
575 "pz:id=" or "pz:id~" followed by a pipe-separated list of low-level
577 At present, these IDs can take one of two forms, depending on the
578 configuration of the Service Proxy being used: they may be based on
579 ZURLs (so a typical value would be something like
580 `pz:id=josiah.brown.edu:210/innopac|lui.indexdata.com:8080/solr4/select?fq=database:4902`)
581 or they may be UDBs (so a typical value would be something like
582 `pz:id=brown|artstor`)
584 * `targetfilter` -- contains a CQL query which is used to find relevant
585 targets from the relvant library. For example,
590 * `target` -- contains a single UDB, that of the sole target to be
593 This is merely syntactic sugar for "targetfilter" with the query
596 For example, a `Records` widget can be limited to searching only in
597 targets that have been categorised as news sources by providing an
598 attribute as follows:
600 <div class="mkwsRecords" targetfilter='categories=news'/>
609 The configuration object `mkws_config` may be created before including
610 the MKWS JavaScript code to modify default behaviour. This structure
611 is a key-value lookup table, whose entries are described in the table
612 below. All entries are optional, but if specified must be given values
613 of the specified type. If ommitted, each setting takes the indicated
614 default value; long default values are in footnotes to keep the table
618 Element Type Default Description
619 -------- ----- --------- ------------
620 debug_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
621 datestamps, 3 = messages with datestamps and stack-traces.
623 facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
624 `xtargets`, `subject` and `author`.
626 lang string en Code of the default language to display the UI in. Supported language codes are `en` =
627 English, `de` = German, `da` = Danish, and whatever additional languages are configured
628 using `language_*` entries (see below).
630 lang_options array [] A list of the languages to offer as options. If empty (the default), then all
631 configured languages are listed.
633 language_* hash Support for any number of languages can be added by providing entries whose name is
634 `language_` followed by the code of the language. See the separate section below for
637 pazpar2_url string *Note 2* The URL used to access the metasearch middleware. This service must be configured to
638 provide search results, facets, etc. It may be either unmediated or Pazpar2 the
639 MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In
640 the latter case, `service_proxy_auth` must be provided.
642 perpage_default string 20 The initial value for the number of records to show on each page.
644 perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many
645 records are displayed on each page of results.
647 query_width int 50 The width of the query box, in characters.
649 responsive_design_width int If defined, then the facets display moves between two locations as the screen-width
650 varies, as described above. The specified number is the threshhold width, in pixels,
651 at which the facets move between their two locations.
653 service_proxy_auth url *Note 4* A URL which, when `use_service_proxy` is true, is fetched once at the beginning of each
654 session to authenticate the user and establish a session that encompasses a defined set
655 of targets to search in.
657 service_proxy_auth_domain domain Can be set to the domain for which `service_proxy_auth` proxies authentication, so
658 that cookies are rewritten to appear to be from this domain. In general, this is not
659 necessary, as this setting defaults to the domain of `pazpar2_url`.
661 show_lang bool true Indicates whether or not to display the language menu.
663 show_perpage bool true Indicates whether or not to display the perpage menu.
665 show_sort bool true Indicates whether or not to display the sort menu.
667 show_switch bool true Indicates whether or not to display the switch menu, for switching between showing
668 retrieved records and target information.
670 sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort`
673 sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list:
674 the first element of each sublist is a pazpar2 sort-expression such as `data:0` and
675 the second is a human-readable label such as `newest`.
677 use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw
681 Perhaps we should get rid of the `show_lang`, `show_perpage`,
682 `show_sort` and `show_switch` configuration items, and simply display the relevant menus
683 only when their containers are provided -- e.g. an `mkwsLang` element
684 for the language menu. But for now we retain these, as an easier route
685 to lightly customise the display than my changing providing a full HTML
690 1. ["sources", "subjects", "authors"]
692 2. /pazpar2/search.pz2
696 4. http://sp-mkws.indexdata.com/service-proxy-auth
698 5. http://sp-mkws.indexdata.com/service-proxy/
700 6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]
703 Language specification
704 ----------------------
706 Support for another UI language can be added by providing an entry in
707 the `mkws_config` object whose name is `language_` followed by the
708 name of the language: for example, `language_French` to support
709 French. Then value of this entry must be a key-value lookup table,
710 mapping the English-language strings of the UI into their equivalents
711 in the specified language. For example:
715 "Authors": "Auteurs",
716 "Subjects": "Sujets",
717 // ... and others ...
721 The following strings occurring in the UI can be translated:
737 In addition, facet names can be translated:
743 Finally, the names of fields in the full-record display can be
744 translated. These include, but may not be limited to:
754 jQuery UI popup invocation
755 --------------------------
757 The MasterKey Widget Set can be invoked in a popup window on top of the page.
759 Note that when using the `popup` layout, facilities from the jQuery UI
760 toolkit are used, so it's necessary to include both CSS and JavaScript
761 from that toolkit. The relevant lines are:
763 <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
764 <link rel="stylesheet" type="text/css"
765 href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
767 <div class="mkwsSearch"></div>
768 <div class="mkwsPopup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
769 <div class="mkwsSwitch"></div>
770 <div class="mkwsLang"></div>
771 <div class="mkwsResults"></div>
772 <div class="mkwsTargets"></div>
773 <div class="mkwsStat"></div>
777 Element Type Default Description
778 -------- ----- ------- ------------
779 popup_width string 880 Width of the popup window (if used), in
782 popup_height string 760 Height of the popup window (if used), in
785 popup_button string `input.mkwsButton` (Never change this.)
787 popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1
789 popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1
794 The structure of the HTML generated by the MKWS widgets
795 -------------------------------------------------------
797 In order to override the default CSS styles provided by the MasterKey Widget
798 Set, it's necessary to understand that structure of the HTML elements that are
799 generated within the widgets. This knowledge make it possible, for example,
800 to style each `<div>` with class `term` but only when it occurs inside an
801 element with ID `#mkwsTermlists`, so as to avoid inadvertently styling other
802 elements using the same class in the non-MKWS parts of the page.
804 The HTML structure is as follows. As in CSS, #ID indicates a unique identifier
805 and .CLASS indicates an instance of a class.
815 input#mkwsQuery type=text
816 input#mkwsButton type=submit
819 (no contents -- used only for masking)
840 span (for sequence number)
842 span (for other information such as author)
843 div.details (sometimes)
866 Copyright (C) 2013-2014 Index Data ApS. <http://indexdata.com>