MKWS demo client

From 71831432127752e2036154e2b309086fc777f6e0 Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Fri, 26 Jul 2013 14:42:08 +0100 Subject: [PATCH] Rolling --- tools/htdocs/whitepaper.markdown | 74 +++++++++++++++++++++++++++++++++++++- 1 file changed, 73 insertions(+), 1 deletion(-) diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown index c913a20..6998d08 100644 --- a/tools/htdocs/whitepaper.markdown +++ b/tools/htdocs/whitepaper.markdown @@ -1 +1,73 @@ -whatevs. +% Using the MasterKey Widget Set to embed metasearching functionality in any web-site +% Mike Taylor +% 26 July 2013 + +Introduction +------------ + +There are lots of practical problems in building resource discovery +solutions. One of the biggest, and most ubiquitous is incorporating +metasearching functionality into existing web-sites -- for example, +content-management systems, library catalogues or intranets. In +general, even when access to metasearching is provided by simple +web-services such as [Pazpar2](http://www.indexdata.com/pazpar2), +integration work is seen as a major part of most projects. + +Index Data provides several different toolkits for communicating with +its metasearching middleware, trading off varying degrees of +flexibility against convenience: + +* libpz2.js -- a low-level JavaScript library for interrogating the + Service Proxy and Pazpar2. It allows the HTML/JavaScript programmer + to implement simple JavaScript functions to display facets, records, + etc. + +* masterkey-ui-core -- a higher-level, complex JavaScript library that + uses libpz2.js to provide the pieces needed for building a + full-featured JavaScript application. + +* MasterKey Demo UI -- an example of a searching application built on + top of masterkey-ui-core. Available as a public demo at + http://mk2.indexdata.com/ + +* MKDru -- a toolkit for embedding MasterKey-like searching into + Drupal sites. + +All of these approaches require programming to a greater or lesser +extent. Against this backdrop, we introduced MKWS (the MasterKey +Widget Set) -- a set of simple, very high-level HTML+CSS+JavaScript +components that can be incorporated into any web-site to provide +MasterKey searching facilities. By placing `

`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 + + + + +

+ + + +More sophisticated applications will not simply place the `