From 48c6fed7006336f607d90f58a5c2b9fdb0369686 Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Thu, 30 Oct 2014 15:33:19 +0000 Subject: [PATCH] Document several individual widgets. --- doc/mkws-manual.markdown | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 46f507c..7c0dd06 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -659,22 +659,45 @@ Name Description widget be subclassed to store the generated widget definitions in more useful places. -`button` x - -`categories` x - -`config` x +`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 + is selected, searches are limited to the targets + that are part of that category. + +`config` This widget has no functionality of its own, but its + configuration is copied up into its team, allowing + it to affect other widgets in the team. This is the + only way to set configuration items at the team + level. `console-builder` Like the `builder` widget, but emits the generated HTML on the JavaScript console. This exists to provide an example of how to subclass the `builder` widget. -`cover-art` x - -`details` x - -`done` x +`cover-art` Displays cover art for a book by searching in + Amazon. Often used with an `autosearch` attribute to + indicate what book to display. For example, + `
` + displays cover art for _All Yesterdays: Unique and + Speculative Views of Dinosaurs and Other Prehistoric + Animals_. + For this widget to work, a library that includes the + AmazonBooks target must be used. For example, the + "DEMO AmazonBooks for MKWS" account, which can be + selected with `sp_auth_credentials="mkws-amazon/mkws"`. + +`details` This widget is generated by the toolkit itself to + hold the full details of records that are initially + listed in summary form. + +`done` Initially empty, this widget is set to display + "Search complete: found _n_ records" when all + targets have completed their work, either returning + a hit-count or an error. The message displayed can + be changed by overriding the `done` template using + `