Remove expandValue from the documentation: it's not actually exposed

[mkws-moved-to-github.git] / doc / mkws-developer.markdown

diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown
index 6bbe48a..f672f89 100644 (file)
--- a/doc/mkws-developer.markdown
+++ b/doc/mkws-developer.markdown
@@ -180,7 +180,8 @@ that is passed into `registerWidgetType`'s callback function, and can
 be used by the derived widget.
 
 * `String this.type` --
 be used by the derived widget.
 
 * `String this.type` --

-       A string containing the type of the widget.
+       A string containing the type of the widget (`search`,
+       `switch`, etc.)

 
 * `Team this.team` --
        The team object to which this widget belongs. The team has
 
 * `Team this.team` --
        The team object to which this widget belongs. The team has

@@ -188,7 +189,8 @@ be used by the derived widget.
        below.
 
 * `DOMElement this.node` --
        below.
 
 * `DOMElement this.node` --

-       The DOM element of the widget
+       The DOM element of the widget. Most often used for inserting
+       HTML into the widget element.

 
 * `Hash this.config` --
        A table of configuration values for the widget. This table
 
 * `Hash this.config` --
        A table of configuration values for the widget. This table

@@ -197,7 +199,7 @@ be used by the derived widget.
        inherits from the default configuration. Instances of widgets
        in HTML can set configuration items as HTML attributes: for
        example, the HTML element
        inherits from the default configuration. Instances of widgets
        in HTML can set configuration items as HTML attributes: for
        example, the HTML element

-       `<div class="mkwsRecords" maxrecs="10">`.
+       `<div class="mkwsRecords" maxrecs="10">`

        creates a widget for which `this.config.maxrecs` is set to 10.
 
 * `String this.toString()` --
        creates a widget for which `this.config.maxrecs` is set to 10.
 
 * `String this.toString()` --

@@ -219,16 +221,6 @@ be used by the derived widget.
        widgets such as `Records` and `Facet` that display some part
        of a search result.
 
        widgets such as `Records` and `Facet` that display some part
        of a search result.
 

-* `VOID hideWhenNarrow()` --
-       Registers that this widget should hide itself when the page
-       becomes "narrow" -- that is, fewer pixels in width that the
-       threshhold value specified by the top-level configuration item
-       `responsive_design_width`. Should be used for "unimportant"
-       widgets that can be omitted from the mobile version of a site.
-
-* `expandValue()` --
-       TODO: either document this or remove it from the API.
-

 * `subwidget(type, overrides, defaults)` --
        Returns the HTML of a subwidget of the specified type, which
        can then be inserted into the widget using the
 * `subwidget(type, overrides, defaults)` --
        Returns the HTML of a subwidget of the specified type, which
        can then be inserted into the widget using the

@@ -242,7 +234,7 @@ be used by the derived widget.
        See for example the `Credo` widget defined in the example
        area's `mkws-widget-credo.js` file. This uses several
        invocations of `subwidget` to create a complex compound widget
        See for example the `Credo` widget defined in the example
        area's `mkws-widget-credo.js` file. This uses several
        invocations of `subwidget` to create a complex compound widget

-       with numerous text, facet and image panes. TODO: rename this
+       with numerous text, facet and image panes. FIXME: rename this

        widget and everything related to it.
 
 In addition to these properties and methods of the bare widget object,
        widget and everything related to it.
 
 In addition to these properties and methods of the bare widget object,

@@ -331,7 +323,7 @@ API should get simpler.
 Events
 ------
 
 Events
 ------
 

-TODO: list of events that can be usefully subscribed to.
+FIXME: list of events that can be usefully subscribed to.

 
 
 - - -
 
 
 - - -