X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=e69fbaee4da3b038a08fa862b814bce968948d9d;hb=64badc9ed1e07c9ab3d00802cf10d867b6965816;hp=b8a0ab1a7280b50079de6669903a1f38475985f2;hpb=2b3681ab03441fd5465f90b12b18fd847c3731d2;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index b8a0ab1..e69fbae 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -10,9 +10,27 @@ 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 `class` 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. + +Supported Browsers +------------------ + +Any modern browser will work fine. JavaScript must be enabled. + +* IE8 or later +* Firefox 17 or later +* Google Chrome 27 or later +* Safari 6 or later +* Opera 12 or later +* iOS 6.x (iPhone, iPad) +* Android 4.x + +Not supported: IE6, IE7 A minimal example ----------------- @@ -20,8 +38,7 @@ A minimal example Here is a completely functional (though ugly) MKWS-based searching application: - +
@@ -31,9 +48,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 ----- @@ -49,8 +71,8 @@ Here are the files that this web-site provides: 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` +* 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 @@ -58,23 +80,16 @@ 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 --------- +### Specific versions The links above to the various forms of the widget-set JavaScript (mkws.js,