MKWS demo client

`s with well-known identifiers in any HTML page, the various components of an application can be embedded: search-boxes, results areas, target information, etc. Simple Example -------------- The following is a complete MKWS-based searching application: MKWS demo client

Go ahead, try it! You don't even need a web-server. Just copy and paste this HTML into a file on your computer -- `/tmp/magic.html`, say -- and point your web-browser at it: `file:///tmp/magic.html`. Just like that, you have working metasearching. How the example works --------------------- If you know any HTML, the structure of the file will be familar to you: the `` element at the top level contains a `` and a ``. In addition to whatever else you might want to put on your page, you can add MKWS elements. These fall into two categories. First, the prerequisites in the HTML header, which are loaded from the tool site mkws.indexdata.com: * `mkws-complete.js` contains all the JavaScript needed by the widget-set. * `mkwsStyle.css` provides the default CSS styling Second, within the HTML body, `

` elements with special IDs that begin `mkws` can be provided. These are filled in by the MKWS code, and provide the components of the searching UI. The very simple application above has only two such components: a search box and a results area. But more are supported. The main `

`s are: * `mkwsSearch` -- provides the search box and button. * `mkwsResults` -- provides the results area, including a list of brief records (which open out into full versions when clicked), paging for large results sets, facets for refining a search, sorting facilities, etc. * `mkwsLang` -- provides links to switch between one of several different UI languages. By default, English, Danish and German are provided. * `mkwsSwitch` -- provides links to switch between a view of the result records and of the targets that provide them. Only meaningful when `mkwsTargets` is also provided. * `mkwsTargets` -- the area where per-target information will appear when selected by the link in the `mkwsSwitch` area. Of interest mostly for fault diagnosis rather than for end-users. * `mkwsStat` --provides a status line summarising the statistics of the various targets. To see all of these working together, just put them all into the HTML `` like so:

Configuration ------------- Many aspects of the behaviour of MKWS can be modified by setting parameters into the `mkws_config` hash. **This must be done *before* including the MKWS JavaScript** so that when that code is executed it can refer to the configuration values. So the HTML header looks like this: This configuration sets the UI language to Danish (rather than the default of English), initially sorts search results by title rather than relevance (though as always this can be changed in the UI) and makes the search box a bit wider than the default. The full set of supported configuration items is described in the reference guide below. Control over HTML and CSS ------------------------- More sophisticated applications will not simply place the `

`s together, but position them carefully within an existing page framework -- such as a Drupal template, an OPAC or a SharePoint page. While it's convenient for simple applications to use a monolithic `mkwsResults` area which contains record, facets, sorting options, etc., customised layouts may wish to treat each of these components separately. In this case, `mkwsResults` can be omitted, and the following lower-level components provided instead: * `mkwsTermlists` -- provides the facets * `mkwsRanking` -- provides the options for how records are sorted and how many are included on each page of results. * `mkwsPager` -- provides the links for navigating back and forth through the pages of records. * `mkwsNavi` -- when a search result has been narrowed by one or more facets, this area shows the names of those facets, and allows the selected values to be clicked in order to remove them. * `mkwsRecords` -- lists the actual result records. Customisation of MKWS searching widgets can also be achieved by overriding the styles set in the toolkit's CSS stylesheet. The default styles can be inspected in `mkwsStyle.css` and overridden in any styles that appears later in the HTML than that file. At the simplest level, this might just mean changing fonts, sizes and colours, but more fundamental changes are also possible. To properly apply styles, it's necessary to understand how the HTML is structured, e.g. which elements are nested within which containers. The structures used by the widget-set are described in the reference guide below. Message of the day ------------------ \ \ Responsive design ----------------- responsive_design: true responsive_design_width: 500

Popup results with jQuery UI ---------------------------- TODO Authentication and target configuration --------------------------------------- TODO Reference Guide --------------- ### Configuration object TODO ### jQuery plugin invocation TODO ### The structure of the HTML generated by the MKWS widgets TODO - - - Copyright (C) 2013 by IndexData ApS,