tools/htdocs/whitepaper.markdown

   1 % Embedded metasearching with the MasterKey Widget Set
   2 % Mike Taylor
   3 % July-September 2013
   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 * libpz2.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 libpz2.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 identifiers 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/mkwsStyle.css" />
  58       </head>
  59       <body>
  60         <div id="mkwsSearch"></div>
  61         <div id="mkwsResults"></div>
  62       </body>
  63     </html>
  64
  65 Go ahead, try it! You don't even need a web-server. Just copy and
  66 paste this HTML into a file on your computer -- `/tmp/magic.html`,
  67 say -- and point your web-browser at it:
  68 `file:///tmp/magic.html`. Just like that, you have working
  69 metasearching.
  70
  71
  72 How the example works
  73 ---------------------
  74
  75 If you know any HTML, the structure of the file will be familar to
  76 you: the `<html>` element at the top level contains a `<head>` and a
  77 `<body>`. In addition to whatever else you might want to put on your
  78 page, you can add MKWS elements.
  79
  80 These fall into two categories. First, the prerequisites in the HTML
  81 header, which are loaded from the tool site mkws.indexdata.com:
  82
  83 * `mkws-complete.js`
  84   contains all the JavaScript needed by the widget-set.
  85
  86 * `mkwsStyle.css`
  87   provides the default CSS styling
  88
  89 Second, within the HTML body, `<div>` elements with special IDs that
  90 begin `mkws` can be provided. These are filled in by the MKWS code,
  91 and provide the components of the searching UI. The very simple
  92 application above has only two such components: a search box and a
  93 results area. But more are supported. The main `<div>`s are:
  94
  95 * `mkwsSearch` -- provides the search box and button.
  96
  97 * `mkwsResults` -- provides the results area, including a list of
  98    brief records (which open out into full versions when clicked),
  99    paging for large results sets, facets for refining a search,
 100    sorting facilities, etc.
 101
 102 * `mkwsLang` -- provides links to switch between one of several
 103    different UI languages. By default, English, Danish and German are
 104    provided.
 105
 106 * `mkwsSwitch` -- provides links to switch between a view of the
 107    result records and of the targets that provide them. Only
 108    meaningful when `mkwsTargets` is also provided.
 109
 110 * `mkwsTargets` -- the area where per-target information will appear
 111    when selected by the link in the `mkwsSwitch` area. Of interest
 112    mostly for fault diagnosis rather than for end-users.
 113
 114 * `mkwsStat` --provides a status line summarising the statistics of
 115    the various targets.
 116
 117 To see all of these working together, just put them all into the HTML
 118 `<body>` like so:
 119
 120         <div id="mkwsSwitch"></div>
 121         <div id="mkwsLang"></div>
 122         <div id="mkwsSearch"></div>
 123         <div id="mkwsResults"></div>
 124         <div id="mkwsTargets"></div>
 125         <div id="mkwsStat"></div>
 126
 127 Configuration
 128 -------------
 129
 130 Many aspects of the behaviour of MKWS can be modified by setting
 131 parameters into the `mkws_config` hash. **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 `mkwsStyle.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 Refinements
 195 -----------
 196
 197
 198 ### Message of the day
 199
 200 Some applications might like to open with content in the area that
 201 will subsequently be filled with result-records -- a message of the
 202 day, a welcome message or a help page. This can be done by placing an
 203 `mkwsMOTDContainer` division on the page next to `mkwsResults` or
 204 `mkwsRecords`. The contents of this element are initially displayed,
 205 but will be hidden when a search is made.
 206
 207
 208 ### Responsive design
 209
 210 Metasearching applications may need to appear differently on
 211 small-screened mobile devices, or change their appearance when
 212 screen-width changes (as when a small device is rotated). To achieve
 213 this, MKWS supports responsive design which will move the termlists to
 214 the bottom on narrow screens and to the sidebar on wide screens.
 215
 216 To turn on this behaviour, set the `responsive_design` configuration
 217 element to `true`, and `responsive_design_width` to the desired
 218 threshhold width in pixels. For example:
 219
 220         <script type="text/javascript">
 221             var mkws_config = {
 222                 responsive_design: true,
 223                 responsive_design_width: 990
 224             };
 225         </script>
 226
 227 If individual result-related components are in use in place of the
 228 all-in-one mkwsResults, then the redesigned application needs to
 229 specify the locations where the termlists should appear in both
 230 cases. In this case, wrap the wide-screen `mkwsTermlists` element in a
 231 `mkwsTermlistContainer1` element; and provide an
 232 `mkwsTermlistContainer2` element in the place where the narrow-screen
 233 termlists should appear.
 234
 235
 236 ### Popup results with jQuery UI
 237
 238 The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI)
 239 can be used to construct MKWS applications in which the only component
 240 generally visible on the page is a search box, and the results appear
 241 in a popup. The key part of such an application is this invocation of
 242 the MKWS jQuery plugin:
 243
 244         <script type="text/javascript">
 245           jQuery.pazpar2({ "layout":"popup", width:800, height:500 });
 246         </script>
 247
 248 The necessary scaffolding can be seen in an example application,
 249 http://example.indexdata.com/index-popup.html
 250
 251
 252 ### Authentication and target configuration
 253
 254 By default, MKWS configures itself to use a demo account on a service
 255 hosted by mkws.indexdata.com. This demo account provides access to
 256 about a dozen free data sources. Authentication onto this service is
 257 via an authentication URL on the same server, which MKWS uses by
 258 default so no configuration is needed.
 259
 260 Access to a customised set of resources (including resources that
 261 require authentication) can be provided. In this case, a
 262 customer-specific authentication URL is used to gain access to these
 263 rather than the default set. Contact Index Data on info@indexdata.com
 264 for details.
 265
 266
 267 Reference Guide
 268 ---------------
 269
 270 ### Configuration object
 271
 272         debug: int [1]
 273         facets: array
 274         lang: string
 275         lang_display: array
 276         lang_menu: bool
 277 ADD     language_*: hash
 278         pazpar2_url: string [/pazpar2/search.pz2]
 279 ADD     perpage: array
 280         perpage_default: string
 281         perpage_menu: bool [true]
 282         query_width: int
 283         responsive_design: bool
 284 ADD     responsive_design_width: int [980]
 285         service_proxy_auth: url
 286         service_proxy_url: string [http://mkws.indexdata.com/service-proxy/]
 287 ADD     sort: array
 288         sort_default: string
 289         sort_menu: bool [true]
 290         use_service_proxy: bool [true]
 291
 292 TODO add default values, describe
 293
 294 ### jQuery plugin invocation
 295
 296 TODO
 297
 298 ### The structure of the HTML generated by the MKWS widgets
 299
 300 TODO
 301
 302 - - -
 303
 304 Copyright (C) 2013 by IndexData ApS, <http://www.indexdata.com>