1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <title>MKWS: the MasterKey Widget Set</title>
6 <style type="text/css">
8 font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
10 h1, h3 { font-weight: normal; color: #606060 }
11 h2 { margin-top: 0.5em }
12 .pane { padding: 0em 1em; margin: 0.75em;
13 border: 0.5em solid #eee;
15 background-image: url('images/mkws-logo-48x48-light.png');
16 background-repeat: no-repeat;
17 background-position: right top;
18 background-color: #eee;
20 .nologo { background-image: none }
21 pre { background: #ddd; padding: 0.5em; }
25 <img src="images/mkws-logo-300px.png" alt="MKWS logo"
26 style="float:right; margin: 1.5em"/>
27 <h1>MKWS: the MasterKey Widget Set</h1>
29 <div class="pane nologo">
30 <h2>Add metasearching to your web-site painlessly</h2>
32 The MasterKey Widget Set provides the easiest possible way to
33 enhance an existing web-site with customised searching across
34 multiple sources, ranking and merging the results.
37 All you need to do is pull in our JavaScript and optional
38 stylesheet, then add <tt><div></tt>s to your page that
39 have special <tt>id</tt> attributes. We do the rest.
44 <h2>A minimal example</h2>
46 Here is a completely functional (though ugly) MKWS-based
47 searching application:
51 <script type="text/javascript"
52 src="http://mkws.indexdata.com/mkws-complete.js"></script>
53 <div id="mkwsSearch"></div>
54 <div id="mkwsResults"></div></pre>
57 That's it. A complete metasearching application. Everything
63 <h2>Documentation</h2>
66 The <a href="README.html">README</a> -- mostly technical details.
69 The <a href="mkws-manual.html">MKWS manual, including a
70 reference section.</a>
71 This is a much better introduction.
79 Here are the files that this web-site provides:
83 <a href="mkws.js">mkws.js</a>
85 JavaScript code that powers the MasterKey Widget Set
88 <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a>
90 Low-level JavaScript library for access to the MasterKey web
94 <a href="handlebars-v1.1.2.js">handlebars-v1.1.2.js</a>
97 <a href="http://handlebarsjs.com/"
98 >the Handlebars templating library</a>,
99 since it doesn't like to be hotlinked.
102 <a href="mkws-complete.js"
103 >mkws-complete.js</a>
105 A single large JavaScript file containing everything needed for
106 MKWS to work: the widget-set itself, the API library, and
107 the prerequisites jQuery and Handlebars.
110 <a href="mkws.css">mkws.css</a>
112 A stylesheet which styles only MasterKey widgets, and does not
113 otherwise interfere with application-site's styles.
117 Minified versions of the MKWS JavaScript files are also available:
121 <a href="mkws.min.js">mkws.min.js</a>
124 <a href="mkws-complete.min.js">mkws-complete.min.js</a>
128 (This domain also hosts two web-service endpoints that are used by
129 running MKWS-based applications:
130 <tt>/service-proxy-auth</tt>
131 is used to authenticate new sessions and
132 <code>/service-proxy/</code>
133 is the main endpoint for searching and retrieval. But there is
134 no need to use these directly: the widgets take care of that.)
142 The links above to the various forms of the widget-set JavaScript
143 (<a href="mkws.js">mkws.js</a>,
144 <a href="mkws-complete.js">mkws-complete.js</a>,
145 <a href="mkws.min.js">mkws.min.js</a>
147 <a href="mkws-complete.min.js">mkws-complete.min.js</a>)
148 are always to the current versions of those
149 files. Applications that rely on a particular version can
150 instead use the specific numbered versions in
151 <a href="releases/">the releases area</a>,
153 <a href="releases/mkws-0.9.1.js">releases/mkws-0.9.1.js</a>.
156 The current version number is always in
157 <a href="VERSION">the VERSION file</a>.
160 Version history is in
161 <a href="NEWS">the NEWS file</a>.
166 <h2>Examples using the widget-set</h2>
168 It's worth viewing the source of these to see how small they
169 are and how various things are done.
171 <h3>Simple examples</h3>
174 A very simple application at
175 <a href="//example.indexdata.com/simple.html"
176 >//example.indexdata.com/simple.html</a>.
179 <a href="//example.indexdata.com/minimal.html"
180 >The absolutely minimal application</a>
184 <a href="//example.indexdata.com/language.html"
185 >A more detailed version</a>
186 that contains a configuration structure instead of accepting
187 the defaults. Includes a custom translation option to present
188 the application in Arabic.
191 <a href="//example.indexdata.com/mobile.html"
192 >A version suitable for mobile devices</a>,
193 with a responsive design that moves components around
194 depending on the screen size.
198 <h3>Advanced examples</h3>
202 <a href="//example.indexdata.com/lowlevel.html"
203 >uses lower-level MKWS components</a>
204 rather than the all-in-one <tt>#mkwsResults</tt> division,
205 allowing it to use a rather different layout.
208 An application that specifies how to display brief and full records
209 <a href="//example.indexdata.com/templates.html"
210 >using Handlebar templates</a>.
212 <a href="http://handlebarsjs.com/"
213 >the templating language</a>.)
217 <a href="http://example.indexdata.com/images.html?q=portrait"
218 >displays thumbnail images</a>.
221 <a href="//example.indexdata.com/localauth.html"
222 >An application that uses a local authentication regime</a>,
223 and the corresponding
224 <a href="//example.indexdata.com/apache-config.txt"
225 >Apache2 configuration stanza</a>.
228 <a href="//example.indexdata.com/popup.html"
229 >A version that uses a jQuery popup</a>.
233 <h3>Non-standard interfaces</h3>
236 <a href="//example.indexdata.com/dict.html"
237 >An application that uses MKWS to find dictionary
238 definitions of words when you highlight them</a>.
241 <a href="//example.indexdata.com/auto.html"
242 >An application that runs an automatic search on load</a>.
245 An existing web-site,
246 <a href="http://sagp.miketaylor.org.uk/"
247 >The Self-Appointed Grammar Police</a>,
248 which has been fitted with an MKWS searching widget.
249 (See also the MKWS-widget customisations in
250 <a href="http://sagp.miketaylor.org.uk/style.css"
251 >that site's stylesheet</a>.)
255 Another existing web-site,
256 <a href="http://zthes.z3950.org/"
257 >The Zthes specifications</a>,
258 which has been fitted with a popup MKWS search-box.
265 <h2>Target selection</h2>
267 MKWS comes pre-configured to search in a set of a dozen or so
268 open-access targets, as a proof of concept. But you'll want
269 to use it to search your own selection of targets -- some open
270 access, some subscription.
273 We can set that up for you: email us on
274 <a href="mailto:info@indexdata.com"
275 >info@indexdata.com</a>.
279 <p style="text-align: right; font-size: small">
280 Copyright (©) 2013-2014 Index Data ApS.
281 <a href="http://indexdata.com"><code>http://indexdata.com</code></a>