popup.html needs a q= parameter to run, MKWS-297

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

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index a0415b8..1e767d0 100644 (file)
--- 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, `<div>` 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 `<div>`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
         <div id="mkwsTargets"></div>
         <div id="mkwsStat"></div>
 
+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:
 
         <script type="text/javascript">
           var mkws_config = {
@@ -169,7 +170,7 @@ While it's convenient for simple applications to use a monolithic
 `mkwsResults` area which contains record, facets, sorting options,
 etc., customised layouts may wish to treat each of these components
 separately. In this case, `mkwsResults` can be omitted, and the
-following lower-level components provided instead:
+following lower-level widgets provided instead:
 
 * `mkwsTermlists` -- provides the facets
 
@@ -187,7 +188,8 @@ following lower-level components provided instead:
 
 Customisation of MKWS searching widgets can also be achieved by
 overriding the styles set in the toolkit's CSS stylesheet. The default
-styles can be inspected in `mkws.css` and overridden in any
+styles can be inspected in [mkws.css](mkws.css)
+and overridden in any
 styles that appears later in the HTML than that file. At the simplest
 level, this might just mean changing fonts, sizes and colours, but
 more fundamental changes are also possible.
@@ -332,7 +334,7 @@ threshhold width in pixels. For example:
             };
         </script>
 
-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 +347,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 +797,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 `<div>` 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.