Update documentation of newSearch method to reflect newish "widget" parameter.
[mkws-moved-to-github.git] / doc / mkws-developer.markdown
index d944a6e..ca7486f 100644 (file)
@@ -21,8 +21,7 @@ Required development tools
 If you are building the widget set, you will need the following Debian
 packages (or their equivalents on your operating system):
 
-       $ sudo apt-get install curl git make unzip apache2 \
-           pandoc libbsd-resource-perl
+       $ sudo apt-get install curl git make unzip apache2 pandoc
 
 You also need Node.js, but unfortunately the `node-js` package is not
 available for Debian wheezy. You can either get it from
@@ -306,13 +305,14 @@ automatically).
        used to subscribe to the event (or more rarely to publish
        it). See [the section on events, below](#events).
 
-* `Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)` --
-       Starts a new search with the specified parameters. All but the
-       query may be omitted, in which case the prevailing defaults
-       are used. The meanings of the parameters are those of the
-       same-named [configuration
-       settings](mkws-manual.html#configuration-settings) described in
-       the user's manual.
+* `Void team.newSearch(widget, query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)` --
+       Starts a new search with the specified parameters, taking
+       settings from the nominated widget's configuration when not
+       specified explicitly. All but the query may be omitted. The
+       meanings of the parameters are those of the same-named
+       [configuration
+       settings](mkws-manual.html#configuration-settings) described
+       in the user's manual.
 
 * `Void team.reShow()` --
        Using the existing search, re-shows the result records after a