MKWS demo client

From fda7da00419e8b5fdd051505c1073affa9690ae2 Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Wed, 29 Oct 2014 10:56:20 +0000 Subject: [PATCH] Consistently use a single tab to indent all code-samples. --- doc/mkws-manual.markdown | 246 +++++++++++++++++++++++----------------------- 1 file changed, 123 insertions(+), 123 deletions(-) diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 4a17798..a315a22 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -57,18 +57,18 @@ Simple example The following is [a complete MKWS-based searching application](//example.indexdata.com/simple.html): - - - - MKWS demo client - - - - -

- - + + + + 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 @@ -141,13 +141,13 @@ The main widgets are: 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. @@ -196,15 +196,15 @@ Many aspects of the behaviour of MKWS can be modified by setting 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 @@ -322,9 +322,9 @@ Inline Handlebars templates are distinguished from Javascript via a `type="text/x-handlebars-template"` attribute. For example, to override the pager template you would include this in your document: - + 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. @@ -359,7 +359,7 @@ 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 -------------------- @@ -376,17 +376,17 @@ 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 @@ -418,10 +418,10 @@ 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, [popup.html](http://example.indexdata.com/popup.html). @@ -561,9 +561,9 @@ 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 is done by setting the `sp_auth_credentials` configuration item to a string -containing the username, a slash, and the password: +containing the username and password separated by a slash: - mkws_config = { sp_auth_credentials: "mike/swordfish" }; + mkws_config = { sp_auth_credentials: "mike/swordfish" }; ### (Optional): conceal credentials from HTML source @@ -739,13 +739,13 @@ 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`, @@ -789,18 +789,18 @@ 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: - - + + -

- +

+ ---- Element Type Default Description @@ -836,62 +836,62 @@ 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 + #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 - - - -- 1.7.10.4