From: Mike Taylor Date: Wed, 15 Oct 2014 11:27:12 +0000 (+0100) Subject: Move 'configuring a client (short version) README.markdown to index.markdown X-Git-Tag: 1.0.0~198^2~5 X-Git-Url: http://jsfdemo.indexdata.com/cgi-bin?a=commitdiff_plain;h=4ec099efd0efc4c74a940028342013fc4dfdf2a4;p=mkws-moved-to-github.git Move 'configuring a client (short version) README.markdown to index.markdown --- diff --git a/doc/README.markdown b/doc/README.markdown index 9732fff..c2533f7 100644 --- a/doc/README.markdown +++ b/doc/README.markdown @@ -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: - -~~~ - - -~~~ - -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) - - - - 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: + +~~~ + + +~~~ + +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 -------------