3 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4 <title>MKWS: the MasterKey Widget Set</title>
5 <style type="text/css">
7 font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
10 p { font-weight: bold }
14 <h1>MKWS: the MasterKey Widget Set</h1>
16 This site contains tools, not content:
20 <a href="mkws.js">mkws.js</a>
22 JavaScript code that powers the MasterKey Widget Set
25 <a href="/libjs-pz2/pz2api.1.js">/libjs-pz2/pz2api.1.js</a>
27 Low-level JavaScript library for access to the MasterKey web
31 <a href="mkws-complete.js"
34 A single large JavaScript file containing everything needed for
35 MKWS to work: the widget-set itself, the API library, and any
36 additional prerequisites such as jQuery.
39 <a href="mkws.css">mkws.css</a>
41 A stylesheet which styles only MasterKey widgets, and does not
42 otherwise interfere with application-site's styles.
44 <p style="color:darkred">
45 Note. This is not yet quite true: the stylesheet needs tweaking
46 to make it more specific to only the MKWS components. At present
47 it spills over into styling parts of the containing site, too.
53 For examples of how to use the widget-set, see:
57 A very simple application at
58 <a href="http://example.indexdata.com/"
59 >http://example.indexdata.com/</a>.
60 It's worth viewing the source to see how small it is.
63 <a href="http://example.indexdata.com/language.html"
64 >A more detailed version</a>
65 that contains a configuration structure instead of accepting
66 the defaults. Includes a custom translation option to present
67 the application in Arabic.
71 <a href="http://example.indexdata.com/jquery.html"
73 version, consisting of a single line of JavaScript code.
77 <a href="http://example.indexdata.com/lowlevel.html"
78 >uses lower-level MKWS components</a>
79 rather than the all-in-one <tt>#mkwsResults</tt> division,
80 allowing it to use a rather different layout.
83 An application that specifies how to display brief and full records
84 <a href="http://example.indexdata.com/templates.html"
85 >using Handlebar templates</a>.
87 <a href="http://handlebarsjs.com/"
88 >the templating language</a>.)
91 <a href="http://example.indexdata.com/mobile.html"
92 >A version suitable for mobile devices</a>,
93 with a responsive design that moves components around
94 depending on the screen size.
97 <a href="http://example.indexdata.com/popup.html"
98 >A version that uses a jQuery popup</a>.
101 <a href="http://example.indexdata.com/dict.html"
102 >An application that used MKWS to find dictionary
103 definitions of words when you highlight them</a>.
106 An existing web-site,
107 <a href="http://sagp.miketaylor.org.uk/"
108 >The Self-Appointed Grammar Police</a>,
109 which has been fitted with an MKWS searching widget.
110 (See also the MKWS-widget customisations in
111 <a href="http://sagp.miketaylor.org.uk/style.css"
112 >that site's stylesheet</a>.)
115 Another existing web-site,
116 <a href="http://zthes.z3950.org/"
117 >The Zthes specifications</a>,
118 which has been fitted with a popup MKWS search-box.
122 The set of targets can be maintained:
127 <a href="http://mk2.indexdata.com/console/"
128 >MasterKey Admin Console</a>,
129 and act as the "MK Demo" library administrator.
137 The <a href="whitepaper.html">The whitepaper, including a reference section.</a>
140 The <a href="README.html">README.html</a>
143 The <a href="html-structure.txt"
144 >structure of the HTML generated by the MKWS widgets</a>,
145 which can be used to guide the customisation of its CSS styles.