X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=6f39c24b07982fedbcc1856d413e91833329ce46;hb=37d00fa771d28368ac471a94974705cb814d3c32;hp=1dff908308b2dd09ab19e416bb4b29441ef0bd86;hpb=114208b19241b72ffee33029e0f6be09c306059c;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index 1dff908..6f39c24 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -10,9 +10,12 @@ 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 `
`s to your page that have special `id` attributes. We -do the rest. +As much of the searching functionality as possible is hosted on + so that very simple applications such as + can have MasterKey +searching with minimal effort. All you need to do is pull in our +JavaScript and optional stylesheet, then add `
`s to your page +that have special `class` attributes. We do the rest. A minimal example ----------------- @@ -20,10 +23,9 @@ A minimal example Here is a completely functional (though ugly) MKWS-based searching application: - -
-
+ +
+
That's it. A complete metasearching application. Everything else is refinement. @@ -31,9 +33,14 @@ else is refinement. Documentation ------------- +* This file. + [PDF version] * The README -- mostly technical details. + [PDF version] * The MKWS manual, including a reference section. - This is a much better introduction. + [PDF version] +* The MKWS developers' guide. + [PDF version] Tools ----- @@ -45,10 +52,12 @@ Here are the files that this web-site provides: * pazpar2/js/pz2.js -- Low-level JavaScript library for access to the MasterKey web service. -* handlebars-v1.1.2.js -- +* handlebars-v2.0.0.js -- A local copy of the Handlebars templating library, since it doesn't like to be hotlinked. +* Local copy of jquery-1.10.0.min.js +* Local copy of jquery.json-2.4.js * mkws-complete.js -- A single large JavaScript file containing everything needed for MKWS to work: the widget-set itself, the API library, and @@ -56,20 +65,15 @@ Here are the files that this web-site provides: * mkws.css -- A stylesheet which styles only MasterKey widgets, and does not otherwise interfere with application-site's styles. +* mkws-jquery.js -- + An experimental jQuery plugin that provides an MKWS-based + metasearching applet. Minified versions of the MKWS JavaScript files are also available: * mkws.min.js * mkws-complete.min.js -(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 --------