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, h3 { font-weight: normal; color: #606060 }
10 h2 { margin-top: 0.5em }
11 .pane { padding: 0em 1em; margin: 0.75em;
12 border: 0.5em solid #eee;
14 background-image: url('images/mkws-logo-48x48-light.png');
15 background-repeat: no-repeat;
16 background-position: right top;
17 background-color: #eee;
19 .nologo { background-image: none }
20 pre { background: #ddd; padding: 0.5em; }
24 <img src="images/mkws-logo-300px.png" alt="MKWS logo" =
25 style="float:right; margin: 1.5em"/>
26 <h1>MKWS: the MasterKey Widget Set</h1>
28 <div class="pane nologo">
29 <h2>Add metasearching to your web-site painlessly</h2>
31 The MasterKey Widget Set provides the easiest possible way to
32 enhance an existing web-site with customised searching across
33 multiple sources, ranking and merging the results.
36 All you need to do is pull in our JavaScript and optional
37 stylesheet, then add <tt><div></tt>s to your page that
38 have special <tt>id</tt> attributes. We do the rest.
43 <h2>A minimal example</h2>
45 Here is a completely functional (though ugly) MKWS-based
46 searching application:
50 <script type="text/javascript"
51 src="http://mkws.indexdata.com/mkws-complete.js"></script>
52 <div id="mkwsSearch"></div>
53 <div id="mkwsResults"></div></pre>
56 That's it. A complete metasearching application. Everything
62 <h2>Documentation</h2>
65 The <a href="README.html">README</a> -- mostly technical details.
68 The <a href="mkws-manual.html">MKWS manual, including a
69 reference section.</a>
70 This is a much better introduction.
78 Here are the files that this web-site provides:
82 <a href="mkws.js">mkws.js</a>
84 JavaScript code that powers the MasterKey Widget Set
87 <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a>
89 Low-level JavaScript library for access to the MasterKey web
93 <a href="handlebars-v1.1.2.js">handlebars-v1.1.2.js</a>
96 <a href="http://handlebarsjs.com/"
97 >the Handlebars templating library</a>,
98 since it doesn't like to be hotlinked.
101 <a href="mkws-complete.js"
102 >mkws-complete.js</a>
104 A single large JavaScript file containing everything needed for
105 MKWS to work: the widget-set itself, the API library, and
106 the prerequisites jQuery and Handlebars.
109 <a href="mkws.css">mkws.css</a>
111 A stylesheet which styles only MasterKey widgets, and does not
112 otherwise interfere with application-site's styles.
116 Minified versions of the MKWS JavaScript files are also available:
120 <a href="mkws.min.js">mkws.min.js</a>
123 <a href="mkws-complete.min.js">mkws-complete.min.js</a>
127 (This domain also hosts two web-service endpoints that are used by
128 running MKWS-based applications:
129 <tt>/service-proxy-auth</tt>
130 is used to authenticate new sessions and
131 <code>/service-proxy/</code>
132 is the main endpoint for searching and retrieval. But there is
133 no need to use these directly: the widgets take care of that.)
141 The links above to the various forms of the widget-set JavaScript
142 (<a href="mkws.js">mkws.js</a>,
143 <a href="mkws-complete.js">mkws-complete.js</a>,
144 <a href="mkws.min.js">mkws.min.js</a>
146 <a href="mkws-complete.min.js">mkws-complete.min.js</a>)
147 are always to the current versions of those
148 files. Applications that rely on a particular version can
149 instead use the specific numbered versions in
150 <a href="releases/">the releases area</a>,
152 <a href="releases/mkws-0.9.1.js">releases/mkws-0.9.1.js</a>.
155 The current version number is always in
156 <a href="VERSION">the VERSION file</a>.
159 Version history is in
160 <a href="NEWS">the NEWS file</a>.
165 <h2>Examples using the widget-set</h2>
167 It's worth viewing the source of these to see how small they
168 are and how various things are done.
170 <h3>Simple examples</h3>
173 A very simple application at
174 <a href="//example.indexdata.com/simple.html"
175 >//example.indexdata.com/simple.html</a>.
178 <a href="//example.indexdata.com/minimal.html"
179 >The absolutely minimal application</a>
183 <a href="//example.indexdata.com/language.html"
184 >A more detailed version</a>
185 that contains a configuration structure instead of accepting
186 the defaults. Includes a custom translation option to present
187 the application in Arabic.
190 <a href="//example.indexdata.com/mobile.html"
191 >A version suitable for mobile devices</a>,
192 with a responsive design that moves components around
193 depending on the screen size.
197 <h3>Advanced examples</h3>
201 <a href="//example.indexdata.com/lowlevel.html"
202 >uses lower-level MKWS components</a>
203 rather than the all-in-one <tt>#mkwsResults</tt> division,
204 allowing it to use a rather different layout.
207 An application that specifies how to display brief and full records
208 <a href="//example.indexdata.com/templates.html"
209 >using Handlebar templates</a>.
211 <a href="http://handlebarsjs.com/"
212 >the templating language</a>.)
216 <a href="http://example.indexdata.com/images.html?q=portrait"
217 >displays thumbnail images</a>.
220 <a href="//example.indexdata.com/localauth.html"
221 >An application that uses a local authentication regime</a>,
222 and the corresponding
223 <a href="//example.indexdata.com/apache-config.txt"
224 >Apache2 configuration stanza</a>.
227 <a href="//example.indexdata.com/popup.html"
228 >A version that uses a jQuery popup</a>.
232 <h3>Non-standard interfaces</h3>
235 <a href="//example.indexdata.com/dict.html"
236 >An application that uses MKWS to find dictionary
237 definitions of words when you highlight them</a>.
240 <a href="//example.indexdata.com/auto.html"
241 >An application that runs an automatic search on load</a>.
244 An existing web-site,
245 <a href="http://sagp.miketaylor.org.uk/"
246 >The Self-Appointed Grammar Police</a>,
247 which has been fitted with an MKWS searching widget.
248 (See also the MKWS-widget customisations in
249 <a href="http://sagp.miketaylor.org.uk/style.css"
250 >that site's stylesheet</a>.)
254 Another existing web-site,
255 <a href="http://zthes.z3950.org/"
256 >The Zthes specifications</a>,
257 which has been fitted with a popup MKWS search-box.
264 <h2>Target selection</h2>
266 MKWS comes pre-configured to search in a set of a dozen or so
267 open-access targets, as a proof of concept. But you'll want
268 to use it to search your own selection of targets -- some open
269 access, some subscription.
272 We can set that up for you: email us on
273 <a href="mailto:info@indexdata.com"
274 >info@indexdata.com</a>.
278 <p style="text-align: right; font-size: small">
279 Copyright (©) 2013-2014 IndexData ApS.
280 <a href="http://indexdata.com"><code>http://indexdata.com</code></a>