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;
9 h1 { font-weight: normal; color: #606060 }
10 .pane { padding: 0em 1em; margin: 0.75em;
11 border: 0.5em solid #eee;
13 background-image: url('images/mkws-logo-48x48-light.png');
14 background-repeat: no-repeat;
15 background-position: right top;
16 background-color: #eee;
18 .nologo { background-image: none }
19 pre { background: #ddd; padding: 0.5em; }
23 <img src="images/mkws-logo-300px.png" alt="MKWS logo" =
24 style="float:right; margin: 1.5em"/>
25 <h1>MKWS: the MasterKey Widget Set</h1>
27 <div class="pane nologo">
28 <h2>Add metasearching to your web-site painlessly</h2>
30 The MasterKey Widget Set provides the easiest possible way to
31 enhance an existing web-site with customised searching across
32 multiple sources, ranking and merging the results.
35 All you need to do is pull in our JavaScript and optional
36 stylesheet, then add <tt><div></tt>s to your page that
37 have special <tt>id</tt> attributes. We do the rest.
44 Here is a completely functional (though ugly) MKWS-based
45 searching application:
49 <script type="text/javascript"
50 src="http://mkws.indexdata.com/mkws-complete.js"></script>
51 <div id="mkwsSearch"></div>
52 <div id="mkwsResults"></div></pre>
55 That's it. A complete metasearching application. Everything
61 <h2>Documentation</h2>
64 The <a href="README.html">README</a> -- mostly technical details.
67 The <a href="whitepaper.html">whitepaper, including a
68 reference section.</a>
69 This is a much better introduction.
77 Here are the files that this web-site provides:
81 <a href="mkws.js">mkws.js</a>
83 JavaScript code that powers the MasterKey Widget Set
86 <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a>
88 Low-level JavaScript library for access to the MasterKey web
92 <a href="handlebars-v1.1.2.js">handlebars-v1.1.2.js</a>
95 <a href="http://handlebarsjs.com/"
96 >the Handlebars templating library</a>,
97 since it doesn't like to be hotlinked.
100 <a href="mkws-complete.js"
101 >mkws-complete.js</a>
103 A single large JavaScript file containing everything needed for
104 MKWS to work: the widget-set itself, the API library, and
105 the prerequisites jQuery and Handlebars.
108 <a href="mkws.css">mkws.css</a>
110 A stylesheet which styles only MasterKey widgets, and does not
111 otherwise interfere with application-site's styles.
115 (This domain also hosts two web-service endpoints that are used by
116 running MKWS-based applications:
117 <tt>/service-proxy-auth</tt>
118 is used to authenticate new sessions and
119 <code>/service-proxy/</code>
120 is the main endpoint for searching and retrieval. But there is
121 no need to use these directly: the widgets take care of that.)
127 <h2>Examples using the widget-set</h2>
129 It's worth viewing the source of these to see how small they
130 are and how various things are done.
132 <h3>Simple examples</h3>
135 A very simple application at
136 <a href="http://example.indexdata.com/"
137 >http://example.indexdata.com/</a>.
140 <a href="http://example.indexdata.com/minimal.html"
141 >The absolutely minimal application</a>
145 <a href="http://example.indexdata.com/language.html"
146 >A more detailed version</a>
147 that contains a configuration structure instead of accepting
148 the defaults. Includes a custom translation option to present
149 the application in Arabic.
152 <a href="http://example.indexdata.com/mobile.html"
153 >A version suitable for mobile devices</a>,
154 with a responsive design that moves components around
155 depending on the screen size.
159 <h3>Intermediate examples</h3>
163 <a href="http://example.indexdata.com/jquery.html"
165 version, consisting of a single JavaScript statement.
169 <a href="http://example.indexdata.com/lowlevel.html"
170 >uses lower-level MKWS components</a>
171 rather than the all-in-one <tt>#mkwsResults</tt> division,
172 allowing it to use a rather different layout.
175 An application that specifies how to display brief and full records
176 <a href="http://example.indexdata.com/templates.html"
177 >using Handlebar templates</a>.
179 <a href="http://handlebarsjs.com/"
180 >the templating language</a>.)
183 <a href="http://example.indexdata.com/popup.html"
184 >A version that uses a jQuery popup</a>.
187 <a href="http://example.indexdata.com/dict.html"
188 >An application that uses MKWS to find dictionary
189 definitions of words when you highlight them</a>.
192 <a href="http://example.indexdata.com/auto.html"
193 >An application that runs an automatic search on load</a>.
196 <a href="http://example.indexdata.com/localauth.html"
197 >An application that uses a local authentication regime</a>,
198 and the corresponding
199 <a href="http://example.indexdata.com/apache-config.txt"
200 >Apache2 configuration stanza</a>.
203 An existing web-site,
204 <a href="http://sagp.miketaylor.org.uk/"
205 >The Self-Appointed Grammar Police</a>,
206 which has been fitted with an MKWS searching widget.
207 (See also the MKWS-widget customisations in
208 <a href="http://sagp.miketaylor.org.uk/style.css"
209 >that site's stylesheet</a>.)
212 Another existing web-site,
213 <a href="http://zthes.z3950.org/"
214 >The Zthes specifications</a>,
215 which has been fitted with a popup MKWS search-box.
221 <h2>Target selection</h2>
223 MKWS comes pre-configured to search in a set of a dozen or so
224 open-access targets, as a proof of concept. But you'll want
225 to use it to search your own selection of targets -- some open
226 access, some subscription.
229 We can set that up for you: email us on
230 <a href="mailto:info@indexdata.com"
231 >info@indexdata.com</a>.
235 <p style="text-align: right; font-size: small">
236 Copyright © 2013 IndexData ApS.
237 <a href="http://indexdata.com"><code>http://indexdata.com</code></a>