X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=f9b0734a28724f5790dc9230befaab7d793160d0;hb=4ec099efd0efc4c74a940028342013fc4dfdf2a4;hp=e69fbaee4da3b038a08fa862b814bce968948d9d;hpb=374f3fd0652039090a55ade533d405c6a8c441af;p=mkws-moved-to-github.git

diff --git a/doc/index.markdown b/doc/index.markdown
index e69fbae..f9b0734 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -45,6 +45,46 @@ 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:
+
+~~~
+	<link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
+	<script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
+~~~
+
+Then the following special `<div>`s can be added (with no content), and
+will be filled in by MKWS:
+
+* `<div id="mkwsSwitch"></div>` -- switch between record and target views
+* `<div id="mkwsLang"></div>  ` -- switch between English, Danish and German
+* `<div id="mkwsSearch"></div>` -- search box and button
+* `<div id="mkwsResults"></div>` -- result list, including pager/sorting
+* `<div id="mkwsTargets"></div>` -- target list, including status
+* `<div id="mkwsStat"></div>` -- 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:
+
+~~~
+    <script type="text/javascript">
+      var mkws_config = {
+        lang_options: ["en", "de" ],
+        sort_default: "title:1"
+      };
+    </script>
+~~~
+
+For much more detail, see:
+[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
+
 Documentation
 -------------