X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=d0cb8c433073eda270814a71ff73a9a48092777f;hb=1df9e4858bdc8707ab4e58a7d520e24c85614ba8;hp=5a0727bb63d548ae8d855788b31a3df12c9b4a15;hpb=0c89d53214ae11af36e7ce08b3d2c99cc8521a53;p=mkws-moved-to-github.git
diff --git a/doc/index.markdown b/doc/index.markdown
index 5a0727b..d0cb8c4 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,21 +38,58 @@ 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.
+Configuring a client (short version)
+------------------------------------
+
+The application's HTML must contains the following elements as well as
+whatever makes up the application itself:
+
+Prerequisites:
+
+~~~
+
+
+~~~
+
+Then the following special `
`s can be added (with no content), and
+will be filled in by MKWS:
+
+* `` -- switch between record and target views
+* ` ` -- switch between English, Danish and German
+* `` -- search box and button
+* `` -- result list, including pager/sorting
+* `` -- target list, including status
+* `` -- summary statistics
+
+You can configure and control the client by creating an `mkws_config`
+object before loading the widget-set. Here is an example showing how
+to use options to offer a choice between English and German UI
+languages, and to default to sorting by title ascending:
+
+~~~
+
+~~~
+
+For much more detail, see:
+[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
+
Documentation
-------------
* This file.
[PDF version]
-* The README -- mostly technical details.
- [PDF version]
* The MKWS manual, including a reference section.
[PDF version]
* The MKWS developers' guide.
@@ -72,8 +127,7 @@ 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,