X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=d0cb8c433073eda270814a71ff73a9a48092777f;hb=d8748a0afe2f674734f5d2a1995b6059a613dd7c;hp=00a9dcb22e4db5347ec0a11f1d5ae87cb4dd6a9e;hpb=3762249c688c55aa491c2adf5cbd5518bfc54d14;p=mkws-moved-to-github.git
diff --git a/doc/index.markdown b/doc/index.markdown
index 00a9dcb..d0cb8c4 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -45,13 +45,51 @@ 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.
@@ -89,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,