Move 'configuring a client (short version) README.markdown to index.markdown
authorMike Taylor <mike@indexdata.com>
Wed, 15 Oct 2014 11:27:12 +0000 (12:27 +0100)
committerMike Taylor <mike@indexdata.com>
Wed, 15 Oct 2014 11:27:12 +0000 (12:27 +0100)
doc/README.markdown
doc/index.markdown

index 9732fff..c2533f7 100644 (file)
@@ -3,46 +3,6 @@
 % 28 July 2014
 
 
-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)
-
 
 - - -
 
index e69fbae..f9b0734 100644 (file)
@@ -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
 -------------