From 7ae78a6010d5215affd619829644d01d43ce2936 Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Mon, 3 Nov 2014 17:41:00 +0000 Subject: [PATCH] More widgets. --- doc/mkws-manual.markdown | 47 ++++++++++++++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 88a13bd..888e65b 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -659,6 +659,9 @@ Name Description widget be subclassed to store the generated widget definitions in more useful places. +`button` The search button. Usually generated a `search` + widget. + `categories` Obtains from the Service Proxy a list of the target categories associated with the library in use, and displays them in a drop-down list. When a category @@ -754,21 +757,43 @@ Name Description search is run. It can be used to provide a "message of the day". -`navi` x - -`pager` x +`navi` Shows a list of the facets that have been selected, + and allows them to be deselected. -`per-page` x +`pager` Shows a list of the available pages of results, and + allows the user to navigate to a selected page. -`progress` x +`per-page` Provides a dropdown allowing the user to choose how + many records should appear on each page. The + available set of page-sizes can be set as the + `perpage_options` configuration item, whose value is + an array of integers. The initial selected value can + be set by the `perpage_default` configuration item. -`query` x +`progress` Shows a progress bar which indicates how many of the + targets have responded to the search. -`ranking` x - -`record` x +`query` The input area for a query. Usually generated a `search` + widget. -`records` x +`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. + +`record` A detailed display of a single record, usually + appearing when the user clicks on a summary + record. This is generated by the `records` widget. + +`records` The area in which summary records appear. (Clicking + on a summary record make it pop up as a detailed + record.) `reference` x @@ -782,6 +807,8 @@ Name Description `stat` x +`summary` x + `switch` x `targets` x -- 1.7.10.4