X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=2060dda2fc807abb3bb068052d48448438e100b9;hb=f6ab13587b58fba947e4257e7ff1091bbaffcb64;hp=a0415b806d6c2be105d05e59f86a13a19aca7d03;hpb=b5cee14f163b48d8da1bded7120dee1eb6323b72;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index a0415b8..2060dda 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -65,8 +65,10 @@ The following is -
-
+
+
+
+
@@ -95,8 +97,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 +132,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: The Facet template has a special feature where you can override it on a per-facet basis by adding a dash and the facet name as a suffix eg. -`Facet-Subjects` rather than `Facet`. (So `class="mkwsTemplate_Facet-Subjects"`) +`facet-subjects` rather than `facet`. (So `class="mkws-template-facet-subjects"`) You can also explicitly specify a different template for a particular instance of a widget by providing the name of your alternative (eg. SpecialPager) as the value of the `template` key in the MKWS config object for that widget: -for example, `
`. +for example, `
`. Templates for MKWS can also be [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled @@ -250,8 +254,7 @@ Inspecting metadata for templating MKWS makes requests to Service Proxy or Pazpar2 that perform the actual searching. Depending on how these are configured and what is available from the targets you are searching there may be more data available than what is -presented by the default templates. In this case, you can redefine the -`Record` template to include more fields in the full-record popup. +presented by the default templates. Handlebars offers a convenient log helper that will output the contents of a variable for you to inspect. This lets you look at exactly what is being @@ -277,7 +280,7 @@ Rather than use the included AJAX helpers to render record details inline, here's a Records template that will link directly to the source via the address provided in the metadata as the first element of `md-electronic-url`: - - -If individual result-related components 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 -`mkwsTermlists-Container-wide` element; and provide an -`mkwsTermlists-Container-narrow` element in the place where the narrow-screen -termlists should appear. - - 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 +771,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.