X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fwhitepaper.markdown;h=64e4d857538ae10b77562cb2a431b7c2cc30b03c;hb=4738159cb5fdd23fc701f68c20aa7ca7e1459169;hp=5f0724cf868b4f3a0ad7ef859ef81fc4cbe5b71f;hpb=1aaea31df2c1f8f70f83c0cb1bf8045506add67a;p=mkws-moved-to-github.git
diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown
index 5f0724c..64e4d85 100644
--- a/tools/htdocs/whitepaper.markdown
+++ b/tools/htdocs/whitepaper.markdown
@@ -51,8 +51,8 @@ The following is a complete MKWS-based searching application:
MKWS demo client
-
+
@@ -67,8 +67,8 @@ say -- and point your web-browser at it:
metasearching.
-Explanation
------------
+How the example works
+---------------------
If you know any HTML, the structure of the file will be familar to
you: the `` element at the top level contains a `` and a
@@ -93,18 +93,24 @@ are supported. The main `
`s are:
* `mkwsSearch` -- provides the search box and button.
* `mkwsResults` -- provides the results area, including a list of
- brief records (which open out into full versions when clicked),
- paging for large results sets, facets for refining a search, sorting
- facilities, etc.
+ brief records (which open out into full versions when clicked),
+ paging for large results sets, facets for refining a search,
+ sorting facilities, etc.
* `mkwsLang` -- provides links to switch between one of several
different UI languages. By default, English, Danish and German are
provided.
-* `mkwsSwitch` --
+* `mkwsSwitch` -- provides links to switch between a view of the
+ result records and of the targets that provide them. Only
+ meaningful when `mkwsTargets` is also provided.
+
+* `mkwsTargets` -- the area where per-target information will appear
+ when selected by the link in the `mkwsSwitch` area. Of interest
+ mostly for fault diagnosis rather than for end-users.
-* `mkwsTargets` --
-* `mkwsStat` --
+* `mkwsStat` --provides a status line summarising the statistics of
+ the various targets.
### different HTML structure