Complete the widget list.
authorMike Taylor <mike@indexdata.com>
Tue, 4 Nov 2014 12:50:46 +0000 (12:50 +0000)
committerMike Taylor <mike@indexdata.com>
Tue, 4 Nov 2014 12:50:46 +0000 (12:50 +0000)
doc/mkws-manual.markdown

index 888e65b..9abebd5 100644 (file)
@@ -776,16 +776,9 @@ Name              Description
 `query`           The input area for a query. Usually generated a `search`
                   widget.
 
-`ranking`         Provides a dropdown allowing the user to choose how
-                  the displayed records should be sorted. The
-                  available set of sort criteria can be set as the
-                  `sort_options` configuration item, whose value is
-                  an array of two-element arrays. The first item of
-                  each sub-array is a pazpar2 sort-expression such as
-                  `data:0` and the second is a human-readable label
-                  such as `newest`. The initial selected
-                  value can be set by the `sort_default` configuration
-                  item.
+`ranking`         The result-ranking area, consisting of a `sort`
+                  widget and a `per-page` widget. These may instead
+                  be specified separately if preferred.
 
 `record`          A detailed display of a single record, usually
                   appearing when the user clicks on a summary
@@ -795,23 +788,55 @@ Name              Description
                   on a summary record make it pop up as a detailed
                   record.)
 
-`reference`       x
-
-`results`         x
-
-`search-form`     x
+`reference`       A short summary about a subject specified by the
+                  `autosearch` configuration item. This is created by
+                  drawing a picture and a paragraph of text from
+                  Wikipedia. To work correctly, this widget must be
+                  used in a library that provides the
+                  `wikimedia_wikipedia_single_result` target.
 
-`search`          x
+`results`         A large compound widget used to provide the most
+                  important results-oriented widgets in a pre-packaged
+                  framework: `facets`, `ranking`, `pager`, `navi` and
+                  `records`.
 
-`sort`            x
+`search-form`     The search form, containing the query area and the
+                  button. Usually generated a `search` widget.
 
-`stat`            x
+`search`          The search box, consisting of a form containing a
+                  query area and a button.
 
-`summary`         x
-
-`switch`          x
+`sort`            Provides a dropdown allowing the user to choose how
+                  the displayed records should be sorted. The
+                  available set of sort criteria can be set as the
+                  `sort_options` configuration item, whose value is
+                  an array of two-element arrays. The first item of
+                  each sub-array is a pazpar2 sort-expression such as
+                  `data:0` and the second is a human-readable label
+                  such as `newest`. The initial selected
+                  value can be set by the `sort_default` configuration
+                  item.
 
-`targets`         x
+`stat`            A summary line stating how many targets remain
+                  active, how many records have been found, and how
+                  many of them have been retrieved for display. For
+                  most purposes, the `progress` widget may be
+                  preferable.
+
+`summary`         A short record, included in the list shown when a
+                  search is run. When clicked, this generally pops up
+                  a detailed `record` widget. This widget is generated
+                  by the toolkit in response to search results.
+
+`switch`          A pair of buttons allowing the user to switch
+                  between viewing the search results (the usual case)
+                  or the target list.
+
+`targets`         A list of all targets in the present library,
+                  showing their ID, the number of records they have
+                  found for the current search, any diagnostics they
+                  have returned, the number of records that have been
+                  returned for display, and the connection state.
 ----