MKWS: the MasterKey Widget Set

This site contains tools, not content:

• mkws.js -- JavaScript code that powers the MasterKey Widget Set
• /libjs-pz2/pz2api.1.js -- Low-level JavaScript library for access to the MasterKey web service.
• mkws-complete.js -- A single large JavaScript file containing everything needed for MKWS to work: the widget-set itself, the API library, and any additional prerequisites such as jQuery.
• mkwsStyle.css -- A stylesheet which styles only MasterKey widgets, and does not otherwise interfere with application-site's styles.

For examples of how to use the widget-set, see:

• A very simple application at http://somesite.indexdata.com/. It's worth viewing the source to see how small it is.
• The jQuery plugin version, consisting of a single line of JavaScript code.
• An application that uses lower-level MKWS components rather than the all-in-one #mkwsResults division, allowing it to use a rather different layout.
• An existing web-site, The Self-Appointed Grammar Police, which has been fitted with an MKWS searching widget. (See also the MKWS-widget customisations in that site's stylesheet.)
• Another existing web-site, The Zthes specifications, which has been fitted with a popup MKWS search-box.

The set of targets can be maintained:

• Use the main MasterKey Admin Console, and act as the "MK Demo" library administrator.

Documentation is as yet in short supply:

• The README (which may not be fully up to date).
• The structure of the HTML generated by the MKWS widgets, which can be used to guide the customisation of its CSS styles.