X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=e69fbaee4da3b038a08fa862b814bce968948d9d;hb=64badc9ed1e07c9ab3d00802cf10d867b6965816;hp=7690717057e05dff9e1d470c491cf0fcea0b8f9e;hpb=acdba3a0827204a32aa0e29f8cc4e194073ea4a5;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index 7690717..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,10 +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 ----- @@ -59,15 +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 -Versions --------- +### Specific versions The links above to the various forms of the widget-set JavaScript (mkws.js,