From: Mike Taylor <mike@indexdata.com>
Date: Wed, 29 Oct 2014 11:56:08 +0000 (+0000)
Subject: Document auth-name and builder widgets.
X-Git-Tag: 1.0.0~75^2~4
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=fc6dc0499a3e9911e516ce1345e2293616bb4234;p=mkws-moved-to-github.git

Document auth-name and builder widgets.
---

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index b35e967..46f507c 100644
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -647,9 +647,17 @@ added: see the [MKWS developers' guide](mkws-developer.html).)
 ----
 Name              Description
 ----              -----------
-`auth-name`       x
-
-`builder`         x
+`auth-name`       Initially empty, it updates itself to shows the name
+                  of the library that the application is logged in as
+                  when authentication is complete.
+
+`builder`         A button which, when pressed, analyses the current
+                  settings of the team that it is a part of, and
+                  generates the HTML for an auto-searching element
+                  that will replicate the present search. This HTML is
+                  displayed in an alert box: it is intended that this
+                  widget be subclassed to store the generated widget
+                  definitions in more useful places.
 
 `button`          x
 
@@ -657,7 +665,10 @@ Name              Description
 
 `config`          x
 
-`console-builder` x
+`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