X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=tools%2Fhtdocs%2Findex.html;h=9835c661b8df01cc84c0c38b94de67640c4b5125;hp=61fe17b6c99f04ca8be1ccf43229015a8cb1f2de;hb=3b37b7798cab326907f2e48223371ff1737b94fb;hpb=6de2b7eb50eb03025dec13adbde99f786468cd75 diff --git a/tools/htdocs/index.html b/tools/htdocs/index.html index 61fe17b..9835c66 100644 --- a/tools/htdocs/index.html +++ b/tools/htdocs/index.html @@ -6,130 +6,278 @@ body { font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif; } - h1 { color: #606060 } - p { font-weight: bold } + h1, h3 { font-weight: normal; color: #606060 } + h2 { margin-top: 0.5em } + .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; } + MKWS logo

MKWS: the MasterKey Widget Set

-

- This site contains tools, not content: + +

+ +
+

A minimal 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. +

+
+ +
+

Documentation

+ +
+ +
+

Tools

+

+ Here are the files that this web-site provides: +

+ +

+ Minified versions of the MKWS JavaScript files are also available: +

+

+

+ (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.) + + +

+ +
+

Versions

+

+ The links above to the various forms of the widget-set JavaScript + (mkws.js, + mkws-complete.js, + mkws.min.js + and + mkws-complete.min.js) + are always to the current versions of those + files. Applications that rely on a particular version can + instead use the specific numbered versions in + the releases area, + for example + releases/mkws-0.9.1.js. +

+

+ The current version number is always in + the VERSION file. +

+

+ Version history is in + the NEWS file. +

+
+ +
+

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. +

+

Simple examples

+ + +

Advanced examples

+ + +

Non-standard interfaces

+ +
+ +
+

Target selection

+

+ MKWS comes pre-configured to search in a set of a dozen or so + open-access targets, as a proof of concept. But you'll want + to use it to search your own selection of targets -- some open + access, some subscription. +

+

+ We can set that up for you: email us on + info@indexdata.com. +

+
+ +

+ Copyright (©) 2013-2014 IndexData ApS. + http://indexdata.com

- -

- For examples of how to use the widget-set, see: -

- -

- The set of targets can be maintained: -

- -

- Documentation is as yet in short supply: -

-