MKWS demo client

` elements with special IDs that @@ -128,7 +128,7 @@ Configuration ------------- Many aspects of the behaviour of MKWS can be modified by setting -parameters into the `mkws_config` hash. **This must be done *before* +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: @@ -137,7 +137,7 @@ this: var mkws_config = { lang: "da", sort_default: "title", - query_width: 60, + query_width: 60 }; @@ -180,7 +180,7 @@ 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 `mkwsStyle.css` and overridden in any +styles can be inspected in `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. @@ -205,6 +205,40 @@ day, a welcome message or a help page. This can be done by placing an but will be hidden when a search is made. +### Customised display using Handlebars templates + +Certain aspects of the widget-set's display can be customised by +providing Handlebars templates with well-known IDs that begin with the +string `mkwsTemplate`. At present, the supported templates are: + +* `mkwsTemplateSummary` -- used for each summary record in a list of + results. + +* `mkwsTemplateRecord` -- used when displaying a full record. + +For both of these the metadata record is passed in, and its fields can +be referenced in the template. As well as the metadata fields +(`md-*`), two special fields are provided to the `mkwsTemplateSummary` +template, for creating popup links for full records. These are `_id`, +which must be provided as the `id` attribute of a link tag, and +`_onclick`, which must be provided as the `onclick` attribute. + +For example, an application can install a simple author+title summary +record in place of the usual one providing the following template: + + + +For details of Handlebars template syntax, see +[the online documentation](http://handlebarsjs.com/). + + ### Responsive design Metasearching applications may need to appear differently on @@ -269,15 +303,16 @@ Reference Guide The configuration object `mkws_config` may be created before including the MKWS JavaScript code to modify default behaviour. This structure -is a hash, whose entries are described in the table below. All entries -are options, but if specified must be given values of the specified -type. If ommitted, each setting takes the indicated default value; -long default values are in footnotes to keep the table reasonably narrow. +is a key-value lookup table, whose entries are described in the table +below. All entries are options, but if specified must be given values +of the specified type. If ommitted, each setting takes the indicated +default value; long default values are in footnotes to keep the table +reasonably narrow. --- Element Type Default Description -------- ----- --------- ------------ -debug int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with +debug_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with datestamps, 3 = messages with datestamps and stack-traces. facets array *Note 1* Ordered list of names of facets to display. Supported facet names are @@ -290,8 +325,6 @@ lang string en Code of the default language to displ lang_options array [] A list of the languages to offer as options. If empty (the default), then all configured languages are listed. -show_lang bool true Indicates whether or not to display the language menu. - language_* hash Support for any number of languages can be added by providing entries whose name is `language_` followed by the code of the language. See the separate section below for details. @@ -301,12 +334,10 @@ pazpar2_url string *Note 2* The URL used to access the metasearch MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In the latter case, `service_proxy_auth` must be provided. -perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many - records are displayed on each page of results. - perpage_default string 20 The initial value for the number of records to show on each page. -show_perpage bool true Indicates whether or not to display the perpage menu. +perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many + records are displayed on each page of results. query_width int 50 The width of the query box, in characters. @@ -318,19 +349,21 @@ service_proxy_auth url *Note 4* A URL which, when `use_service_proxy` session to authenticate the user and establish a session that encompasses a defined set of targets to search in. -sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list: - the first element of each sublist is a pazpar2 sort-expression such as `data:0` and - the second is a human-readable label such as `newest`. +show_lang bool true Indicates whether or not to display the language menu. + +show_perpage bool true Indicates whether or not to display the perpage menu. + +show_sort bool true Indicates whether or not to display the sort menu. sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort` array. -show_sort bool true Indicates whether or not to display the sort menu. +sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list: + the first element of each sublist is a pazpar2 sort-expression such as `data:0` and + the second is a human-readable label such as `newest`. use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw - Pazpar2. ### Do we even need this? Can't we just assume that the Service Proxy is in - use when and only when `service_proxy_auth` is defined? Alternatively, retain this, but - use the same entry to specify the URL in either case. + Pazpar2. --- Perhaps we should get rid of the `show_lang`, `show_perpage` and @@ -358,16 +391,16 @@ structure. ### Language specification Support for another UI language can be added by providing an entry in -the `mkws_config` hash whose name is `language_` followed by the name -of the language: for example, `language_Arabic` to support -Arabic. Then value of this entry must be a hash, mapping the -English-language strings of the UI into their equivalents in the -specified language. For example: +the `mkws_config` object whose name is `language_` followed by the +name of the language: for example, `language_French` to support +French. Then value of this entry must be a key-value lookup table, +mapping the English-language strings of the UI into their equivalents +in the specified language. For example: var mkws_config = { - language_Arabic: { - "Authors": "Ø§ÙÙØªØ§Ø¨", - "Subjects": "Ø§ÙÙÙØ§Ø¶ÙØ¹", + language_French: { + "Authors": "Auteurs", + "Subjects": "Sujets", // ... and others ... } } @@ -416,9 +449,9 @@ the invocation is a single line of JavaScript: This code should be inserted in the page at the position where the metasearch should occur. -When invoking this plugin, a hash of named options may be passed in to -modify the default behaviour, as in the exaple above. The available -options are as follows: +When invoking this plugin, a key-value lookup table of named options +may be passed in to modify the default behaviour, as in the exaple +above. The available options are as follows: --- Element Type Default Description