1 % MKWS: the MasterKey Widget Set
6 Add metasearching to your web-site painlessly
7 ---------------------------------------------
9 The MasterKey Widget Set provides the easiest possible way to enhance
10 an existing web-site with customised searching across multiple
11 sources, ranking and merging the results.
13 As much of the searching functionality as possible is hosted on
14 <http://mkws.indexdata.com/> so that very simple applications such as
15 <http://example.indexdata.com/simple.html> can have MasterKey
16 searching with minimal effort. All you need to do is pull in our
17 JavaScript and optional stylesheet, then add `<div>`s to your page
18 that have special `class` attributes. We do the rest.
23 Any modern browser will work fine. JavaScript must be enabled.
27 * Google Chrome 27 or later
30 * iOS 6.x (iPhone, iPad)
33 Not supported: IE6, IE7
38 Here is a completely functional (though ugly) MKWS-based
39 searching application:
41 <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
42 <div class="mkwsSearch"></div>
43 <div class="mkwsResults"></div>
45 That's it. A complete metasearching application. Everything
52 [<a href="index.pdf">PDF version</a>]
53 * The <a href="README.html">README</a> -- mostly technical details.
54 [<a href="README.pdf">PDF version</a>]
55 * The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
56 [<a href="mkws-manual.pdf">PDF version</a>]
57 * The <a href="mkws-developer.html">MKWS developers' guide.</a>
58 [<a href="mkws-developer.pdf">PDF version</a>]
63 Here are the files that this web-site provides:
65 * <a href="mkws.js">mkws.js</a> --
66 JavaScript code that powers the MasterKey Widget Set
67 * <a href="pazpar2/js/pz2.js">pazpar2/js/pz2.js</a> --
68 Low-level JavaScript library for access to the MasterKey web
70 * <a href="handlebars-v2.0.0.js">handlebars-v2.0.0.js</a> --
72 <a href="http://handlebarsjs.com/">the Handlebars templating library</a>,
73 since it doesn't like to be hotlinked.
74 * Local copy of <a href="jquery-1.10.0.min.js">jquery-1.10.0.min.js</a>
75 * Local copy of <a href="jquery.json-2.4.js">jquery.json-2.4.js</a>
76 * <a href="mkws-complete.js">mkws-complete.js</a> --
77 A single large JavaScript file containing everything needed for
78 MKWS to work: the widget-set itself, the API library, and
79 the prerequisites jQuery and Handlebars.
80 * <a href="mkws.css">mkws.css</a> --
81 A stylesheet which styles only MasterKey widgets, and does not
82 otherwise interfere with application-site's styles.
83 * <a href="mkws-jquery.js">mkws-jquery.js</a> --
84 An experimental jQuery plugin that provides an MKWS-based
87 Minified versions of the MKWS JavaScript files are also available:
89 * <a href="mkws.min.js">mkws.min.js</a>
90 * <a href="mkws-complete.min.js">mkws-complete.min.js</a>
94 The links above to the various forms of the widget-set JavaScript
95 (<a href="mkws.js">mkws.js</a>,
96 <a href="mkws-complete.js">mkws-complete.js</a>,
97 <a href="mkws.min.js">mkws.min.js</a>
99 <a href="mkws-complete.min.js">mkws-complete.min.js</a>)
100 are always to the current versions of those
101 files. Applications that rely on a particular version can
102 instead use the specific numbered versions in
103 <a href="releases/">the releases area</a>,
105 <a href="releases/mkws-0.9.1.js">releases/mkws-0.9.1.js</a>.
107 The current version number is always in
108 <a href="VERSION">the VERSION file</a>.
110 Version history is in
111 <a href="NEWS">the NEWS file</a>.
113 Examples using the widget-set
114 -----------------------------
116 It's worth viewing the source of these to see how small they
117 are and how various things are done.
121 * A very simple application at
122 <a href="//example.indexdata.com/simple.html"
123 >//example.indexdata.com/simple.html</a>.
124 * <a href="//example.indexdata.com/minimal.html"
125 >The absolutely minimal application</a>
127 * <a href="//example.indexdata.com/language.html"
128 >A more detailed version</a>
129 that contains a configuration structure instead of accepting the
130 defaults. Includes a custom translation option to present the
131 application in Arabic.
132 * <a href="//example.indexdata.com/mobile.html"
133 >A version suitable for mobile devices</a>,
134 with a responsive design that moves components around depending on
137 ### Advanced examples
139 * An application that
140 <a href="//example.indexdata.com/lowlevel.html"
141 >uses lower-level MKWS components</a>
142 rather than the all-in-one `#mkwsResults` division,
143 allowing it to use a rather different layout.
144 * An application that specifies how to display brief and full records
145 <a href="//example.indexdata.com/templates.html"
146 >using Handlebar templates</a>.
148 <a href="http://handlebarsjs.com/"
149 >the templating language</a>.)
150 * An application that
151 <a href="http://example.indexdata.com/images.html?q=portrait"
152 >displays thumbnail images</a>.
153 * <a href="//example.indexdata.com/localauth.html"
154 >An application that uses a local authentication regime</a>,
155 and the corresponding
156 <a href="//example.indexdata.com/apache-config.txt"
157 >Apache2 configuration stanza</a>.
158 * <a href="//example.indexdata.com/popup.html"
159 >A version that uses a jQuery popup</a>.
161 ### Non-standard interfaces
163 * <a href="//example.indexdata.com/dict.html"
164 >An application that uses MKWS to find dictionary
165 definitions of words when you highlight them</a>.
166 * <a href="//example.indexdata.com/auto.html"
167 >An application that runs an automatic search on load</a>.
168 * An existing web-site,
169 <a href="http://sagp.miketaylor.org.uk/"
170 >The Self-Appointed Grammar Police</a>,
171 which has been fitted with an MKWS searching widget.
172 (See also the MKWS-widget customisations in
173 <a href="http://sagp.miketaylor.org.uk/style.css"
174 >that site's stylesheet</a>.)
176 * Another existing web-site,
177 <a href="http://zthes.z3950.org/"
178 >The Zthes specifications</a>,
179 which has been fitted with a popup MKWS search-box.
185 MKWS comes pre-configured to search in a set of a dozen or so
186 open-access targets, as a proof of concept. But you'll want
187 to use it to search your own selection of targets -- some open
188 access, some subscription.
190 We can set that up for you: email us on
191 <a href="mailto:info@indexdata.com"
192 >info@indexdata.com</a>.
196 Copyright (©) 2013-2014 Index Data ApS.
197 <a href="http://indexdata.com">`http://indexdata.com`</a>