X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=1e767d0667e41e499e53bba9bcc6bc0655933308;hb=b52d4da9dce5b77e52f41b22e8b82d87c1a400e0;hp=7d9ce92d63f5bc016acc10b6b1991a3bc90d54f5;hpb=ef3882ce648112f358210e63ebef354380116b16;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 7d9ce92..1e767d0 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -54,14 +54,15 @@ can be embedded: search-boxes, results areas, target information, etc. Simple Example ============== -The following is a complete MKWS-based searching application: +The following is +[a complete MKWS-based searching application](//example.indexdata.com/simple.html): MKWS demo client - - + +
@@ -83,7 +84,7 @@ you: the `` element at the top level contains a `` and a page, you can add MKWS elements. These fall into two categories. First, the prerequisites in the HTML -header, which are loaded from the tool site mkws.indexdata.com: +header, which are loaded from the tool site `mkws.indexdata.com`: * `mkws-complete.js` contains all the JavaScript needed by the widget-set. @@ -94,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. @@ -104,9 +105,8 @@ results area. But more are supported. The main `
`s are: paging for large results sets, facets for refining a search, sorting facilities, etc. -* `mkwsLang` -- provides links to switch between one of several - different UI languages. By default, English, Danish and German are - provided. +* `mkwsStat` --provides a status line summarising the statistics of + the various targets. * `mkwsSwitch` -- provides links to switch between a view of the result records and of the targets that provide them. Only @@ -116,8 +116,9 @@ results area. But more are supported. The main `
`s are: when selected by the link in the `mkwsSwitch` area. Of interest mostly for fault diagnosis rather than for end-users. -* `mkwsStat` --provides a status line summarising the statistics of - the various targets. +* `mkwsLang` -- provides links to switch between one of several + different UI languages. By default, English, Danish and German are + provided. To see all of these working together, just put them all into the HTML `` like so: @@ -129,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 @@ -344,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: @@ -794,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 `
` 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.