From: Mike Taylor Date: Mon, 11 Aug 2014 12:40:43 +0000 (+0100) Subject: Complete formatting of developer guide. X-Git-Tag: 1.0.0~39^2~7^2~4^2~31 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=dad2bae0cce47cda5df497c0eb547edba14758d9;p=mkws-moved-to-github.git Complete formatting of developer guide. --- diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown index 20ad83a..6066e05 100644 --- a/doc/mkws-developer.markdown +++ b/doc/mkws-developer.markdown @@ -148,9 +148,10 @@ properties. * `Num team.totalRecordCount()` * `Num team.currentPage();` * `String team.currentRecordId()` -* `String team.currentRecordData()` -- - Simple accessor functions that provide the ability to read - properties of the team. +* `String team.currentRecordData()` + +These are all simple accessor functions that provide the ability to +read properties of the team. * `Array team.filters()` -- Another accessor function, providing access to the array of @@ -162,15 +163,15 @@ properties. * `Bool team.targetFiltered(targetId)` -- Indicates whether the specified target has been filtered by - selection as a facet. + selection as a facet. This is used only by the `Facet` widget, + and there is probably no reason for you to use it. * `Hash team.config()` -- Access to the team's configuration settings. There is almost certainly no reason to use this: the settings that haven't been overridden are accessible via `this.config`. -* `Void team.set_sortOrder(string)` -* `Void team.set_perpage(number)` -- +* `Void team.set_sortOrder(string)`, `Void team.set_perpage(number)` -- "Setter" functions for the team's sortOrder and perpage functions. Unlikely to be needed outside of the `Sort` and `Perpage` widgets.