MKWS: the MasterKey Widget Set

X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=experiments%2Fspclient%2Findex-mkws.html;h=570f42eebd97908d0452bd285cab8cefbed7817a;hb=5892f41b7ff37f6017d0e2baf7ce8db5d9266bd3;hp=0e94ddb941b5118dfe5b240f1db539e566a93907;hpb=3e94ca8d902a63c8f3df09261bbe1cbf9d6618b6;p=mkws-moved-to-github.git diff --git a/experiments/spclient/index-mkws.html b/experiments/spclient/index-mkws.html index 0e94ddb..570f42e 100644 --- a/experiments/spclient/index-mkws.html +++ b/experiments/spclient/index-mkws.html @@ -1,53 +1,135 @@ -

- There is no content on the MKWS site, just tools: -

- 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. -
- Note. This is not yet quite true: the stylesheet needs tweaking - to make it more specific to only the MKWS components. At present - it spills over into styling parts of the containing site, too. + + + + MKWS: the MasterKey Widget Set + + + +
MKWS: the MasterKey Widget Set
+
+ This site contains tools, not content:
-

- For a very simple application that uses these, see - http://somesite.indexdata.com/. - It's worth viewing the source to see how small it is! - - There is even a smaller version with one JavaScript file included and - no configuration and a - jQuery plugin - with a single line of JavaScript code. -

- See also the README (which may not be fully up - to date). -

- +

+ 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. +
+ A more detailed version + that contains a configuration structure instead of accepting + the defaults. Includes a custom translation option to present + the application in Arabic. +
+ 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. +
+ A version suitable for mobile devices, + with a responsive design that moves components around + depending on the screen size. +
+ A version that uses a jQuery popup. +
+ 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. +

+ +