X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fwhitepaper.markdown;h=dce4f3029b7f9204ccc61cc0022c564f8aeb0bfe;hb=ab3d4029734a3feee084b31ef0af3c97b9109d85;hp=6998d08d11fcbd3db300f917579dadae65f390c6;hpb=71831432127752e2036154e2b309086fc777f6e0;p=mkws-moved-to-github.git diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown index 6998d08..dce4f30 100644 --- a/tools/htdocs/whitepaper.markdown +++ b/tools/htdocs/whitepaper.markdown @@ -1,6 +1,7 @@ -% Using the MasterKey Widget Set to embed metasearching functionality in any web-site +% Embedded metasearching with the MasterKey Widget Set % Mike Taylor -% 26 July 2013 +% July-September 2013 + Introduction ------------ @@ -9,21 +10,22 @@ 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. +general, even when access to core metasearching functionality 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 +* pz2.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. + to create JavaScript applications display facets, records, etc. that + are fetched from the metasearching middleware. * masterkey-ui-core -- a higher-level, complex JavaScript library that - uses libpz2.js to provide the pieces needed for building a + uses pz2.js to provide the pieces needed for building a full-featured JavaScript application. * MasterKey Demo UI -- an example of a searching application built on @@ -51,23 +53,469 @@ The following is a complete MKWS-based searching application: