X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Findex.html;h=96a8c2429ff02a13e7adb645fa57faac2972e736;hb=049fa40f6cc7f7cf5f6b1617098c803b2f4c5bdc;hp=69595784b155fe2bff97074f95e2110eedac373d;hpb=a2ae6d355ae5a762cd7660f3b477963678d8a6e8;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/index.html b/tools/htdocs/index.html
index 6959578..96a8c24 100644
--- a/tools/htdocs/index.html
+++ b/tools/htdocs/index.html
@@ -6,10 +6,18 @@
body {
font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
}
- h1 { color: #606060 }
+ h1 { font-weight: normal; color: #606060 }
h2 { font-size: 100% }
- .pane { background: #eee; border-radius: 1em;
- padding: 0.25em 1em; margin: 0.75em; }
+ .pane { padding: 0em 1em; margin: 0.75em;
+ border: 0.5em solid #eee;
+ border-radius: 1em;
+ background-image: url('images/mkws-logo-48x48-light.png');
+ background-repeat: no-repeat;
+ background-position: right top;
+ background-color: #eee;
+ }
+ .nologo { background-image: none }
+ pre { background: #ddd; padding: 0.5em; }
@@ -17,8 +25,58 @@
style="float:right; margin: 1.5em"/>
MKWS: the MasterKey Widget Set
+
+
Add metasearching to your web-site painlessly
+
+ The MasterKey Widget Set provides the easiest possible way to
+ enhance an existing web-site with customised searching across
+ multiple sources, ranking and merging the results.
+
+
+ All you need to do is pull in our JavaScript and optional
+ stylesheet, then add <div>s to your page that
+ have special id attributes. We do the rest.
+
+
+
Example
+
+ Here is a completely functional (though ugly) MKWS-based
+ searching application:
+
+
+
+<script type="text/javascript"
+ src="http://mkws.indexdata.com/mkws-complete.js"></script>
+<div id="mkwsSearch"></div>
+<div id="mkwsResults"></div>
+
+
+ That's it. A complete metasearching application. Everything
+ else is refinement.
+
+
-
This site contains tools, not content:
+
Tools
+
+ Here are the files that this web-site provides:
+
-
mkws.js
@@ -26,18 +84,26 @@
JavaScript code that powers the MasterKey Widget Set
-
- /pazpar2/js/pz2.js
+ pazpar2/js/pz2.js
--
Low-level JavaScript library for access to the MasterKey web
service.
-
+ handlebars-v1.1.2.js
+ --
+ A local copy of
+ the Handlebars templating library,
+ since it doesn't like to be hotlinked.
+
+ -
mkws-complete.js
--
A single large JavaScript file containing everything needed for
- MKWS to work: the widget-set itself, the API library, and any
- additional prerequisites such as jQuery.
+ MKWS to work: the widget-set itself, the API library, and
+ the prerequisites jQuery and Handlebars.
-
mkws.css
@@ -46,16 +112,34 @@
otherwise interfere with application-site's styles.
+
+ (This domain also hosts two web-service endpoints that are used by
+ running MKWS-based applications:
+ /service-proxy-auth
+ is used to authenticate new sessions and
+ /service-proxy/
+ is the main endpoint for searching and retrieval. But there is
+ no need to use these directly: the widgets take care of that.)
+
+
-
For examples of how to use the widget-set, see:
+
Examples using the widget-set
+
+ It's worth viewing the source of these to see how small they
+ are and how various things are done.
+
-
The set of targets can be maintained:
-
+
Target maintainance
+
+ The set of targets provided by MKWS by default can be
+ maintained using
+ MKAdmin
+ by users with appropriate credentials.
+ Go to
+ the main console
+ and act as the "MK Demo" library administrator.
+
+ Copyright © 2013 IndexData ApS.
+ http://indexdata.com
+