X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-developer.markdown;h=edc25664f068d34c92be47e6b1b760b1f859cc46;hb=81ed4f1429a0f6171891d10b384aaace9ef12ec6;hp=ffa831bce1bbc5882d4614bd8b428a3e6288beed;hpb=f15742ce1adcc967c50fb03b71bad68a55628c63;p=mkws-moved-to-github.git diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown index ffa831b..edc2566 100644 --- a/doc/mkws-developer.markdown +++ b/doc/mkws-developer.markdown @@ -145,13 +145,13 @@ Widget specialisation (inheritance) ----------------------------------- Many widgets are simple specialisations of existing widgets. For -example, the `Record` widget is the same as the `Records` widget -except that it defaults to displaying a single record. It's defined as -follows: +example, the `images` widget is the same as the `records` widget +except that it defaults to using the `images` template for displaying +its result list. It's defined as follows: - mkws.registerWidgetType('Record', function() { - mkws.promotionFunction('Records').call(this); - if (!this.config.maxrecs) this.config.maxrecs = 1; + mkws.registerWidgetType('images', function() { + mkws.promotionFunction('records').call(this); + if (!this.config.template) this.config.template = 'images'; }); Remember that when a promotion function is called, it's passed a base @@ -161,11 +161,11 @@ that you want to specialise from -- in this case, `Records` -- using the promotion function that's been registered for that type. Once this has been done, the specialisations can be introduced. In -this case, it's a very simple matter of changing the `maxrecs` -configuration setting to 1 unless it's already been given an explicit -value. (That would occur if the HTML used an element like `
`, though it's not obvious why anyone -would do that.) +this case, it's a very simple matter of changing the `template` +configuration setting to `'images'` unless it's already been given an +explicit value. (That would occur if the HTML used an element like +`
` to use a customised +template. Reference Guide @@ -227,7 +227,7 @@ be used by the derived widget. widgets that can be omitted from the mobile version of a site. * `expandValue()` -- - TODO: either document this or remove it from the API. + FIXME: either document this or remove it from the API. * `subwidget(type, overrides, defaults)` -- Returns the HTML of a subwidget of the specified type, which @@ -242,7 +242,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 - 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, @@ -331,7 +331,7 @@ API should get simpler. Events ------ -TODO: list of events that can be usefully subscribed to. +FIXME: list of events that can be usefully subscribed to. - - -