X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=2060dda2fc807abb3bb068052d48448438e100b9;hb=f6ab13587b58fba947e4257e7ff1091bbaffcb64;hp=549177584c005415d9f783cd64e1e0800b0c4229;hpb=575eb21a11e18aeabab795f21b3019bd0a2cc07b;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 5491775..2060dda 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -65,8 +65,10 @@ The following is -
-
+
+
+
+
@@ -188,7 +190,8 @@ following lower-level widgets 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. @@ -211,7 +214,7 @@ the system. For details of Handlebars template syntax, see [the online documentation](http://handlebarsjs.com/). The templates used by the core widgets can be viewed in [our git -repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/mkws.templates;). +repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/templates;). Parameters are documented in a comment at the top of each template so you can see what's going where. If all you want to do is add a CSS class to something or change a `span` to a `div` it's easy to just copy the existing @@ -221,24 +224,24 @@ Overriding templates -------------------- To override the template for a widget, include it inline in the document -as a ` 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 @@ -251,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 @@ -278,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 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 -`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 ----------------------------