X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmkws-manual.markdown;h=61b5c96c1778cdc637e6ddf5de18658058e966bb;hb=a091348aabc6efb4e000682a20c67e0042c1bd13;hp=9768da43a4972759bb6aa9a621fb876ec683dfd7;hpb=64ccc6654a9ac84f32bbd3453c4829814f56588b;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 9768da4..61b5c96 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -326,14 +326,17 @@ pager template you would include this in your document: ...new Pager template -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="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, `
`. +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`. (So `class="mkws-template-facet-subjects"`.) When +rendering a facet for which no specific template is defined, the code +falls back to using the generic facet template, just called `facet`. + +You can also explicitly specify a different template for a particular +instance of a widget by providing the name of your alternative +(eg. `special-pager`) as the value of the `template` key in the MKWS +config object for that widget: for example, ``. Templates for MKWS can also be [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled @@ -343,10 +346,10 @@ will be used instead of the default. 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. +MKWS makes requests to the 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. 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 @@ -368,24 +371,21 @@ output locale specific text via the mkws-translate helper like so: Example ------- -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`: - - For a more involved example where markup for multiple widgets is decorated with @@ -394,8 +394,8 @@ employed, take a look at the source of [topic.html](http://example.indexdata.com/topic.html?q=water). -Refinements -=========== +Some Refinements +================ Message of the day @@ -404,9 +404,9 @@ Message of the day Some applications might like to open with content in the area that will subsequently be filled with result-records -- a message of the day, a welcome message or a help page. This can be done by placing an -`mkws-motd` division anywhere on the page. It will be moved into the -`mkws-results` area and initially displayed, but will be hidden when a -search is made. +`mkws-motd` division anywhere on the page. It will initially be moved +into the `mkws-results` area and displayed, but will be hidden as soon +as the first search is made. Popup results with jQuery UI @@ -419,53 +419,54 @@ in a popup. The key part of such an application is this invocation of the MKWS jQuery plugin: -