MKWS demo client

`s with well-known MKWS classes in any HTML page, the various components of an application can be embedded: search-boxes, results areas, target information, etc. -Simple Example +Simple example ============== -The following is a complete MKWS-based searching application: - - - - - MKWS demo client - - - - -

- - +The following is +[a complete MKWS-based searching application](//example.indexdata.com/simple.html): + + + + + MKWS demo client + + + + +

+ + Go ahead, try it! Simply put the above in a file (e.g index.html), -drop it into a folder accessible with an ordinary web-server (e.g Apache) -and load it in your web browser (and no, usually, you can't just load the file -directly from disk as some browsers, e.g Chrome, won't allow storing cookies). -Just like that, you have working metasearching. +drop it into a folder accessible with an ordinary web-server (e.g +Apache) and load it in your web browser. Just like that, you have +working metasearching. How the example works --------------------- @@ -77,110 +84,189 @@ 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. + contains all the JavaScript needed by the widget-set, including a + copy of the jQuery library. * `mkws.css` provides the default CSS styling Second, within the HTML body, `

` elements with special IDs that -begin `mkws` can be provided. These are filled in by the MKWS code, +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. -* `mkwsSearch` -- provides the search box and button. +Defining widget elements +======================== -* `mkwsResults` -- provides the results area, including a list of +Widget type +----------- + +An HTML element is made an MKWS widget by including an MKWS +class-name. These names begin `mkws-`: what follows that prefix +specifies the type of the widget. The type can be any sequence of +alphanumeric characters and hyphens _except_ something beginning +`team` -- see below. + +The main widgets are: + +* `mkws-search` -- provides the search box and button. + +* `mkws-results` -- provides the results area, including a list of brief records (which open out into full versions when clicked), 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. +* `mkws-progress` -- shows a progress bar indicating how many of the + targets have responded to the search request. -* `mkwsSwitch` -- provides links to switch between a view of the +* `mkws-stat` -- provides a status line summarising the statistics of + the various targets. + +* `mkws-switch` -- provides links to switch between a view of the result records and of the targets that provide them. Only - meaningful when `mkwsTargets` is also provided. + meaningful when `mkws-targets` is also provided. -* `mkwsTargets` -- the area where per-target information will appear - when selected by the link in the `mkwsSwitch` area. Of interest +* `mkws-targets` -- the area where per-target information will appear + when selected by the link in the `mkws-switch` area. Of interest mostly for fault diagnosis rather than for end-users. -* `mkwsStat` --provides a status line summarising the statistics of - the various targets. +* `mkws-lang` -- 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: -

+ +The full set of supported widgets is described in the +reference guide +[below](#widgets). + +Widget team +----------- +In general a set of widgets work together in a team: in the example +above, the search-term that the user enters in the `mkws-search` +widget is used to generate the set of records that are displayed in +the `mkws-results` widget. -Configuration -============= +Sometimes, it's desirable to have multiple teams in a single page. A +widget can be placed in a named team by giving it (in addition to its +main class) a class that begins with `mkws-team-`: what follows that +prefix specifies the team that the widget is part of. For example, +`

` creates a search widget that +is part of the `aux` team. + +Widgets that do not have a team specified (as in the examples above) +are placed in the team called `AUTO`. + +Configuring widgets +=================== + +Global 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: - - - - -This configuration sets the UI language to Danish (rather than the -default of English), initially sorts search results by title rather -than relevance (though as always this can be changed in the UI) and -makes the search box a bit wider than the default. - -The full set of supported configuration items is described in the +parameters into the `mkws_config` object. So the HTML header looks +like this: + + + + +This configuration restricts the set of available UI languages English +and Danish (omitting German), sets the default to Danish (rather than +the English), and initially sorts search results by title rather than +relevance (though as always this can be changed in the UI). + +The full set of supported configuration settings is described in the reference guide below. +Per-widget configuration +------------------------ + +In addition to the global configuration provided by the `mkws_config` +object, individual widgets' behaviour can be configured by providing +configuration settings as attributes on their HTML elements. For example, +a `records` widget might be restricted to displaying no more than +three records by setting the `numrecs` parameter as follows: + +

+ +Although this works well, HTML validators will consider this element +acceptable, since the `maxrecs` attribute is not part of the HTML +schema. However, attributes beginning `data-` are always accepted as +HTML extensions, much like email headers beginning with +`X-`. Therefore, the widget set also recognises configuration +attributes prefixed with `data-mkws-`, so: + +

+ +For first form is more convenient; the second is more correct. + +Because some configuration settings take structured values rather than +simple strings, they cannot be directly provided by inline +attributes. To allow for this, the special attribute +`data-mkws-config`, if provided, is parsed as JSON and its key-value +pairs used as configuration settings for the widget in question. For +example, the value of `lang_options` is an array of strings specifying +which of the supported UI languages should be made available. The +following invocation will limit this list to only English and Danish +(omitting German): + +

+ +(Note that, as JSON requires double quotes around all strings, single +quotes must be used to contain the entire attribute value.) + Control over HTML and CSS ========================= -More sophisticated applications will not simply place the `

`s +More sophisticated applications will not simply place the widgets together, but position them carefully within an existing page framework -- such as a Drupal template, an OPAC or a SharePoint page. While it's convenient for simple applications to use a monolithic -`mkwsResults` area which contains record, facets, sorting options, +`mkws-results` area which contains record, facets, sorting options, etc., customised layouts may wish to treat each of these components -separately. In this case, `mkwsResults` can be omitted, and the -following lower-level components provided instead: +separately. In this case, `mkws-results` can be omitted, and the +following lower-level widgets provided instead: -* `mkwsTermlists` -- provides the facets +* `mkws-facets` -- provides the facets -* `mkwsRanking` -- provides the options for how records are sorted and +* `mkws-ranking` -- provides the options for how records are sorted and how many are included on each page of results. -* `mkwsPager` -- provides the links for navigating back and forth +* `mkws-pager` -- provides the links for navigating back and forth through the pages of records. -* `mkwsNavi` -- when a search result has been narrowed by one or more +* `mkws-navi` -- when a search result has been narrowed by one or more facets, this area shows the names of those facets, and allows the selected values to be clicked in order to remove them. -* `mkwsRecords` -- lists the actual result records. +* `mkws-records` -- lists the actual result records. 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. @@ -191,140 +277,179 @@ containers. The structures used by the widget-set are described in the reference guide below. -Refinements -=========== - - -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 -`mkwsMOTD` division anywhere on the page. It will be moved into the -`mkwsResults` area and initially displayed, 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 classes that begin with -the string `mkwsTemplate_`. At present, the supported templates are: - -* `mkwsTemplate_Summary` -- used for each summary record in a list of - results. - -* `mkwsTemplate_Record` -- used when displaying a full record. +============================================= + +A lot can be done by styling widgets in CSS and changing basic MKWS config +options. For further customisation, MKWS allows you to change the markup it +outputs for any widget. This is done by overriding the +[Handlebars](http://handlebarsjs.com/) template used to generate it. In general +these consist of `{{things in double braces}}` that are replaced by values from +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/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 +template and make your edits. + +Overriding templates +-------------------- -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 `mkwsTemplate_Summary` -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. +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`. (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 +template of the same name is found in the `Handlebars.templates` object, it +will be used instead of the default. + +Inspecting metadata for templating +---------------------------------- + +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 +returned by the back end without needing to use a Javascript debugger. For +example, you might prepend `{{log hits}}` to the Records template in order to +see what is being returned with each search result in the list. In order for +this to work you'll need to enable verbose output from Handlebars which is done +by including this line or similar: + + + +Internationalisation +-------------------- -For details of Handlebars template syntax, see -[the online documentation](http://handlebarsjs.com/). +If you would like your template to use the built in translation functionality, +output locale specific text via the mkws-translate helper like so: +`{{{mkws-translate "a few words"}}}`. + +Example +------- + +Rather than use the toolkit's included AJAX helpers to render record +details inline, here's a summary 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 +[Bootstrap](http://getbootstrap.com/) classes and a custom Handlebars helper is +employed, take a look at the source of +[topic.html](http://example.indexdata.com/topic.html?q=water). -Responsive design ------------------ -Metasearching applications may need to appear differently on -small-screened mobile devices, or change their appearance when -screen-width changes (as when a small device is rotated). To achieve -this, MKWS supports responsive design which will move the termlists to -the bottom on narrow screens and to the sidebar on wide screens. +Some Refinements +================ -To turn on this behaviour, set the `responsive_design_width` to the desired -threshhold width in pixels. For example: - +Message of the day +------------------ -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. +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 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 ---------------------------- 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: -

+ The necessary scaffolding can be seen in an example application, -http://example.indexdata.com/index-popup.html +[popup.html](http://example.indexdata.com/popup.html). +The relevant properties (`popup_width`, etc.) are documented +[below](#jquery-ui-popup-invocation) +in the reference section. -Authentication and target configuration ---------------------------------------- -By default, MKWS configures itself to use a demonstration account on a -service hosted by mkws.indexdata.com. This account (username `demo`, -password `demo`) provides access to about a dozen free data -sources. Authentication onto this service is via an authentication URL -on the same MKWS server, so no explicit configuration is needed. - -In order to search in a customised set of targets, including -subscription resources, it's necessary to create an account with -Index Data's hosted service proxy, and protect that account with -authentication tokens (to prevent unauthorised use of subscription -resources). For information on how to do this, see the next section. - - -MKWS Target Selection +MKWS target selection ===================== +Introduction +------------ + MKWS accesses targets using the Pazpar2 metasearching engine. Although Pazpar2 can be used directly, using a statically configured set of targets, this usage is unusual. More often, Pazpar2 is fronted by the Service Proxy (SP), which manages authentication, sessions, target -selection, etc. - -This document assumes the SP is used, and explains how to go about -making a set of targets (a "library") available, how to connect your -MKWS application to that library, and how to choose which of the -available targets to use. +selection, etc. This document assumes the SP is used, and explains how +to go about making a set of targets (a "library") available, how to +connect your MKWS application to that library, and how to choose which +of the available targets to use. + +By default MKWS configures itself to use an account on a service +hosted by `sp-mkws.indexdata.com`. By default, it sends no +authentication credentials, allowing the appropriate account to be +selected on the basis of referring URL or IP address. + +If no account has been set up to recognise the referring URL of the +application or the IP address of the client, then a default "MKWS +Demo" account is used. This account (which can also be explicitly +chosen by using the username `mkws`, password `mkws`) provides access +to about a dozen free data sources. +In order to search in a customised set of targets, including +subscription resources, it's necessary to create an account with +Index Data's hosted Service Proxy, and protect that account with +authentication tokens (to prevent unauthorised use of subscription +resources). Maintaining the library ----------------------- -The service proxy accesses sets of targets that are known as +The Service Proxy accesses sets of targets that are known as "libraries". In general, each customer will have their own library, though some standard libraries may be shared between many customers -- for example, a library containing all open-access academic journals. @@ -335,18 +460,17 @@ Libraries are maintained using MKAdmin (MasterKey Admin). Specifically, those used by MKWS are generally maintained on the "MKX Admin" installation at - In general, Index Data will create a library for each customer, then give the customer a username/password pair that they can use to enter MKAdmin and administrate that library. Once logged in, customers can select which targets to include (from the list of several thousand that MKAdmin knows about), and make -customer-specific modifications -- e.g. overriding the titles of the -targets. +customer-specific modifications to the target profiles -- +e.g. overriding the titles of the targets. Most importantly, customers' administrators can add authentication -credentials that the Service Proxy will used on their behalf when +credentials that the Service Proxy will use on their behalf when accessing subscription resources -- username/password pairs or proxies to use for IP-based authentication. Note that **it is then crucial to secure the library from use by unauthorised clients**, otherwise the @@ -383,19 +507,14 @@ Log in to MKAdmin to add a User Access account for your library: * Create an end-user account * Depending on what authentication method it be used, set the User Access account's username and password, or referring URL, or - Service Proxy hostname, or IP-address range. + IP-address range. If your MWKS application runs at a well-known, permanent address -- , say -- you can set the User Access record so that this originating URL is recognised by setting it into -the "Referring URL" field. - -If your application accesses the Service Proxy by a unique virtual -hostname -- yourname.sp-mkws.indexdata.com, say -- you can tie the use -of this hostname to your library by setting the User Access record's -"Host Name" field to name of the host where the SP is accessed. **Note -that this is not secure, as other applications can use this virtual -hostname to gain access to your library.** +the "Referring URL" field. Then the application will always use that +library that this User Access record is associated with (unless it +sends a username/password pair to override this default). Or if your application's users are coming from a well-known range of IP-address space, you can enter the range in the "IP Ranges" @@ -409,84 +528,57 @@ Alternatively, your application can authenticate by username and password credentials. This is a useful approach in several situations, including when you need to specify the use of a different library from usual one. To arrange for this, set the username and password as a -single string separated by a slash -- e.g. "mike/swordfish" -- into +single string separated by a slash -- e.g. `mike/swordfish` -- into the User Access record's Authentication field. You can set multiple fields into a single User Access record; or create multiple User Access records. For example, a single User Access -record can specify both a Referring URL a username/password pair that -can be used when running an application from a different URL. But if -multiple Referring URLs are needed, then each must be specified in its -own User Access record. - -### Tell the application to use the library - -In the HTML of the application, tell MKWS to authenticate on to the -Service Proxy. When referer-based or IP-based authentication is used, -this is very simple: - - - -> TODO This should be the default setting: see **MKWS-251**. - -And ensure that access to the MWKS application is from the correct -Referrer URL or IP-range. - -### (Optional): access by a different virtual hostname - -When hostname-based authentication is in use, it's necessary to access -the Service Proxy as the correctly named virtual host. This can be -done by setting the `service_proxy_auth` configuration item to a -URL containing that hostname, such as -`//yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig` - -> TODO It should be possible to change just the hostname without -> needing to repeat the rest of the URL (protocol, path, query): see -> **MKWS-252**. - -> TODO When changing the SP authentication URL, the Pazpar2 URL should -> in general change along with it: see **MKWS-253**. +record can specify both a Referring URL and a username/password pair +that can be used when running an application from a different URL. But +if multiple Referring URLs are needed, then each must be specified in +its own User Access record. ### (Optional): embed credentials for access to the library When credential-based authentication is in use (username and password), it's necessary to pass these credentials into the Service -Proxy when establishing the session. This can most simply be done just -by setting the `service_proxy_auth` configuration item to a URL such as -`//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish` +Proxy when establishing the session. This is done +by providing the `sp_auth_credentials` configuration setting as a string +containing the username and password separated by a slash: -> TODO It should be possible to add the username and password to the -> configuration without needing to repeat the rest of the URL: see -> **MKWS-254**. + mkws_config = { sp_auth_credentials: "mike/swordfish" }; ### (Optional): conceal credentials from HTML source -Using a credential-based Service-Proxy authentication URL such as the -one above reveals the the credentials to public view -- to anyone who -does View Source on the MKWS application. This may be acceptable for -some libraries, but is intolerable for those which provide -authenticated access to subscription resources. - -In these circumstances, a more elaborate approach is necessary. The -idea is to make a URL local to the customer that is used for -authentication onto the Service Proxy, hiding the credentials in a -local rewrite rule. Then local mechanisms can be used to limit access -to that local authentication URL. Here is one way to do it when +Using credential-based authentication settings such as those above +reveals the the credentials to public view -- to anyone who does View +Source on the MKWS application. This may be acceptable for some +libraries, but is intolerable for those which provide authenticated +access to subscription resources. + +In these circumstances, a different approach is +necessary. Referer-based or IP-based authentication may be +appropriate. But if these are not possible, then a more elaborate +approach can be used to hide the credentials in a web-server +configuration that is not visible to users. + +The idea is to make a Service Proxy authentication URL local to the +customer, hiding the credentials in a rewrite rule in the local +web-server's configuration. Then local mechanisms can be used to limit +access to that local authentication URL. Here is one way to do it when Apache2 is the application's web-server, which we will call -yourname.com: +yourname.com`: Step 1: add a rewriting authentication alias to the configuration: RewriteEngine on - RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P] + RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/\ + ?command=auth&action=check,login&username=U&password=PW [P] -Step 2: set the MKWS configuration item `service_proxy_auth` to - +Step 2: set the MKWS configuration setting `service_proxy_auth` to +`http://yourname.com/spauth/`. -Step 3: protect access to the local path +Step 3: protect access to the local path `http://yourname.com/spauth/` (e.g. using a `.htaccess` file). @@ -523,108 +615,489 @@ For example, a `Records` widget can be limited to searching only in targets that have been categorised as news sources by providing an attribute as follows: -

-Reference Guide +Reference guide =============== -Configuration object --------------------- +Widgets +------- -The configuration object `mkws_config` may be created before including -the MKWS JavaScript code to modify default behaviour. This structure -is a key-value lookup table, whose entries are described in the table -below. All entries are optional, 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. +The following widgets are provided in the core set. (Others can be +added: see the [MKWS developers' guide](mkws-developer.html).) ---- -Element Type Default Description --------- ----- --------- ------------ -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. +Name Description +---- ----------- +`auth-name` Initially empty, it updates itself to shows the name + of the library that the application is logged in as + when authentication is complete. + +`builder` A button which, when pressed, analyses the current + settings of the team that it is a part of, and + generates the HTML for an auto-searching element + that will replicate the present search. This HTML is + displayed in an alert box: it is intended that this + widget be subclassed to store the generated widget + definitions in more useful places. + +`button` The search button. Usually generated a `search` + widget. + +`categories` Obtains from the Service Proxy a list of the target + categories associated with the library in use, and + displays them in a drop-down list. When a category + is selected, searches are limited to the targets + that are part of that category. + +`config` This widget has no functionality of its own, but its + configuration is copied up into its team, allowing + it to affect other widgets in the team. This is the + only way to set configuration settings at the team + level. + +`console-builder` Like the `builder` widget, but emits the generated + HTML on the JavaScript console. This exists to + provide an example of how to subclass the `builder` + widget. + +`cover-art` Displays cover art for a book by searching in + Amazon. Often used with an `autosearch` attribute to + indicate what book to display. For example, + `

` + displays cover art for _All Yesterdays: Unique and + Speculative Views of Dinosaurs and Other Prehistoric + Animals_. + For this widget to work, a library that includes the + AmazonBooks target must be used. For example, the + "DEMO AmazonBooks for MKWS" account, which can be + selected with `sp_auth_credentials="mkws-amazon/mkws"`. + +`details` This widget is generated by the toolkit itself to + hold the full details of records that are initially + listed in summary form. + +`done` Initially empty, this widget is set to display + "Search complete: found _n_ records" when all + targets have completed their work, either returning + a hit-count or an error. The message displayed can + be changed by overriding the `done` template using + ` +

-4. http://sp-mkws.indexdata.com/service-proxy-auth +### Assembling Pazpar2 URLs -5. http://sp-mkws.indexdata.com/service-proxy/ +Most of MKWS's functionality is achieved by use of the Pazpar2 middleware. This is accessed on an endpoint URL which is usually +assembled from the two configuration sessings `pp2_hostname` and `pp2_path`. However, if for some reason an unusual Pazpar2 +endpoint must be used, that endpoint can be specified in the `pazpar2_url` setting, and that will be used instead. -6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]] +In the common case where Pazpar2 is accessed via the Service Proxy, an authentication call is made during initialisation. The call +is generally made to the same endpoint as the other requests. However, the hostname used for authentication may if necessary be +overridden using the `sp_auth_hostname` setting, and the path overridden by `sp_auth_path`. In any case, the value of +`sp_auth_query` is appended; and if `sp_auth_credentials` is set, then it is used to add username and password parameters. +So in the absence of any configuration added by an application, the Service Proxy authentication URL is made up of `pp2_hostname` +(sp-mkws.indexdata.com) since `sp_auth_hostname` is undefined; and `pp2_path` (service-proxy/) since `sp_auth_path` is undefined; +and `sp_auth_query` (command=auth&action=perconfig); and no credentials, since `sp_auth_credentials` is undefined. Therefore the +URL `http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig` is generated. Language specification ---------------------- @@ -636,157 +1109,209 @@ 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_French: { - "Authors": "Auteurs", - "Subjects": "Sujets", - // ... and others ... - } - } + var mkws_config = { + language_French: { + "Authors": "Auteurs", + "Subjects": "Sujets", + // ... and others ... + } + } The following strings occurring in the UI can be translated: -`Displaying`, -`Next`, -`Prev`, -`Records`, -`Search`, -`Sort by`, -`Targets`, -`Termlists`, -`and show`, -`found`, -`of`, -`per page` -and -`to`. + +* `Search complete: found` +* `records` +* `Displaying` +* `to` +* `of` +* `found` +* `Prev` +* `Next` +* `Sort by` +* `and show` +* `per page` +* `Search` +* `Active clients` +* `Retrieved records` +* `Records` +* `Targets` +* `Target ID` +* `Hits` +* `Diags` +* `Records` +* `State` In addition, facet names can be translated: -`Authors`, -`Sources` -and -`Subjects`. + +* `Authors` +* `Sources` +* `Subjects` + +and whatever field captions are defined by `facet_caption_*` settings. + +And sort-orders: + +* `relevance` +* `title` +* `newest` +* `oldest` + +and whatever sort-orders are defined by the `sort_options` setting. Finally, the names of fields in the full-record display can be translated. These include, but may not be limited to: -`Author`, -`Date`, -`Location`, -`Subject` -and -`Title`. - +* `Title` +* `Date` +* `Author` +* `Links` +* `Subject` +* `Locations` jQuery UI popup invocation -------------------------- The MasterKey Widget Set can be invoked in a popup window on top of the page. -Note that when using the `popup` layout, facilities from the jQuery UI -toolkit are used, so it's necessary to include both CSS and JavaScript -from that toolkit. The relevant lines are: +Note that the `popup` widget uses facilities from the jQuery UI, so +it's necessary to include both CSS and JavaScript from that +toolkit. The relevant lines are: - - + + -

+ + +Popup windows can contain any HTML, not just MKWS widgets. + +The properties of the `popup` widget are as follows: ---- -Element Type Default Description +Setting Type Default Description -------- ----- ------- ------------ -popup_width string 880 Width of the popup window (if used), in - pixels. +popup_width int 880 Width of the popup window, in pixels. -popup_height string 760 Height of the popup window (if used), in - pixels. +popup_height int 760 Height of the popup window, in pixels. -popup_button string `input.mkwsButton` (Never change this.) +popup_button string `input.mkwsButton` A jQuery selector identifying the element which, which clicked, pops up the window. -popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1 +popup_modal bool 0 Indicates whether the popup is modal (blocks access to the background page until + dismissed). Set to 1 if a modal popup is required. -popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1 +popup_autoOpen bool 1 Indictaes whether to pop up the window automatically when the page is loaded. ---- +Multiple `popup` widgets can co-exist on a page. In this case, different +`popup_button` values must be used for each. -The structure of the HTML generated by the MKWS widgets -------------------------------------------------------- +Structure of HTML generated by 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, -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. - -The HTML structure is as follows. As in CSS, #ID indicates a unique identifier -and .CLASS indicates an instance of a class. - - #mkwsSwitch - a* - - #mkwsLang - ( a | span )* - - #mkwsSearch - form - input#mkwsQuery type=text - input#mkwsButton type=submit - - #mkwsBlanket - (no contents -- used only for masking) - - #mkwsResults - table - tbody - tr - td - #mkwsTermlists - div.title - div.facet* - div.termtitle - ( a span br )* - td - div#mkwsRanking - form#mkwsSelect - select#mkwsSort - select#mkwsPerpage - #mkwsPager - #mkwsNavi - #mkwsRecords - div.record* - span (for sequence number) - a (for title) - span (for other information such as author) - div.details (sometimes) - table - tbody - tr* - th - td - #mkwsTargets - #mkwsBytarget - table - thead - tr* - td* - tbody - tr* - td* - - #mkwsStat - span.head - span.clients - span.records +Set, it's necessary to understand the structure of the HTML elements that are +generated within the widgets. The HTML structure is as follows. As in CSS, +_.class_ indicates an instance of a class. A trailing `*` indicates zero or +more instances; a trailing `?` indicates zero or one instance. + + .mkws-progress + span.mkws-done + span.mkws-waiting + + .mkws-search + form.mkws-search-form + input.mkws-query + input.mkws-button + + .mkws-results + table + tbody + tr + td.mkws-facets-container-wide + div.mkws-facets + div.mkws-facet* + div.mkws-facet-title + div.mkws-term* + a + span + td.mkws-motd-container + div.mkws-ranking + form + select.mkws-sort + option* + select.mkws-perpage + option* + div.mkws-pager + div + div + span.mkws-prev + span.mkws-current-page + a* + span.mkws-next + div.mkws-navi + div.mkws-records + div.mkws-summary* + div.mkws-field-data + span.mkws-field-NAME* + div.mkws-details? + table + tbody + tr* + th + td + tr + td + div.mkws-facets-container-narrow + + .mkws-targets + table + thead + tr + td* + tbody + tr* + td* + + +Appendix: compatibility roadmap +=============================== + +Wherever possible, we ensure that all functional changes in MKWS are +backwards-compatible, so that applications written against old versions of the +toolkit will continue to work when running against newer versions. + +However, a few aspects of functionality unavoidably change in backwards +incompatible ways. We ensure that **this only happens with new major +versions** -- so it should _always_ be safe to upgrade to a new minor version. +As an aid to porting old applications, we here note the specific +backwards-incompatible changes in the various major releases, and those +planned for future major releases. + + +Major version 1.x +----------------- + +Versions of MKWS before v1.0 (including the only prior release, v0.9.1) used +camel-case class-names: without hyphens and with second and subsequent words +capitalised. So instead of `mkws-search`, it used to be `mkwsSearch`. And the +classes used to specify team names used an `mkwsTeam_` prefix (with an +underscore). So instead of `mkws-team-foo`, it used to be `mkwsTeam_foo`. + +The 1.x series of MKWS releases recognise these old-style class-names +as well as the canonical ones, as a facility for backwards +compatibility. However, **these old class-names are deprecated, and +support will be removed in v2.0**. Existing applications that use them +should be upgraded to the new-style class names as soon as convenient. + - - - -Copyright (C) 2013-2014 by Index Data ApS, +Copyright (C) 2013-2014 Index Data ApS.