From 575eb21a11e18aeabab795f21b3019bd0a2cc07b Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Thu, 16 Oct 2014 16:59:12 +0100 Subject: [PATCH] Change many instances of "component" and even "
" to "widget". --- doc/mkws-manual.markdown | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index a0415b8..5491775 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -95,8 +95,8 @@ header, which are loaded from the tool site `mkws.indexdata.com`: Second, within the HTML body, `
` elements with special IDs that begin `mkws` can be provided. These are filled in by the MKWS code, and provide the components of the searching UI. The very simple -application above has only two such components: a search box and a -results area. But more are supported. The main `
`s are: +application above has only two such widgets: a search box and a +results area. But more are supported. The main widgets are: * `mkwsSearch` -- provides the search box and button. @@ -130,15 +130,16 @@ To see all of these working together, just put them all into the HTML
+The full set of supported widgets is described in the +reference guide below. + Configuration ============= Many aspects of the behaviour of MKWS can be modified by setting -parameters into the `mkws_config` object. **This must be done *before* -including the MKWS JavaScript** so that when that code is executed it -can refer to the configuration values. So the HTML header looks like -this: +parameters into the `mkws_config` object. So the HTML header looks +like this: -If individual result-related components are in use in place of the +If individual result-related widgets are in use in place of the all-in-one mkwsResults, then the redesigned application needs to specify the locations where the termlists should appear in both cases. In this case, wrap the wide-screen `mkwsTermlists` element in a @@ -345,7 +346,7 @@ Popup results with jQuery UI ---------------------------- The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI) -can be used to construct MKWS applications in which the only component +can be used to construct MKWS applications in which the only widget generally visible on the page is a search box, and the results appear in a popup. The key part of such an application is this invocation of the MKWS jQuery plugin: @@ -795,7 +796,7 @@ The structure of the HTML generated by the MKWS widgets In order to override the default CSS styles provided by the MasterKey Widget Set, it's necessary to understand that structure of the HTML elements that are -generated within the components. This knowledge make it possible, for example, +generated within the widgets. This knowledge make it possible, for example, to style each `
` with class `term` but only when it occurs inside an element with ID `#mkwsTermlists`, so as to avoid inadvertently styling other elements using the same class in the non-MKWS parts of the page. -- 1.7.10.4