X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=1066f63fadbff802bb0157b2a2edaf04ee3b2944;hb=aee13a01ec7a7ab15d571e63e5f8671ce599b05e;hp=b44b7b4928e65868b116ed476f14340a79e9af04;hpb=bf917b385268ea7e45f9416042201d852b435827;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index b44b7b4..1066f63 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -1,6 +1,6 @@ % The MKWS manual: embedded metasearching with the MasterKey Widget Set % Mike Taylor -% October 2014 +% November 2014 Introduction @@ -41,7 +41,7 @@ flexibility against convenience: [Drupal](https://www.drupal.org/) sites. -All of these approaches require programming to a greater or lesser +All but the last of these approaches require programming to a greater or lesser extent. Against this backdrop, we introduced [MKWS (the MasterKey Widget Set)](http://mkws.indexdata.com/) -- a set of simple, very high-level HTML+CSS+JavaScript @@ -171,22 +171,6 @@ 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`. -Old and new-style class-names ------------------------------ - -**NOTE.** Versions of MKWS before v1.0 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. - Configuring widgets =================== @@ -202,16 +186,14 @@ like this: lang_options: [ "en", "da" ] lang: "da", sort_default: "title", - query_width: 60 }; This configuration restricts the set of available UI languages English and Danish (omitting German), sets the default to Danish (rather than -the 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 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. @@ -560,7 +542,7 @@ its own User Access record. 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 +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: @@ -860,11 +842,6 @@ default values are in footnotes to keep the table reasonably narrow. ---- Element Widget Type Default Description -------- ------ ----- --------- ------------ -auth_hostname _global_ string If provided, overrides the `pp2_hostname` setting when constructing the - Service Proxy authentication URL. This need only be used when authentication - is performed on a different host from the remaining operations (search, - retrieve, etc.) - autosearch facet, string If provided, this setting contains a query which is immediately run on behalf facets, of the team. Often used with an [indirect setting](#indirect-settings). record, @@ -888,7 +865,7 @@ facet_max_* facet int Specifies how many terms a facets _team_ array *Note 1* Ordered list of names of facets to display. -lang _team_ string Two-letter ISO code of the default language to display the UI in. Supported +lang _team_ string The code of the default language to display the UI in. Supported language codes are `en` = English, `de` = German, `da` = Danish, and whatever additional languages are configured using `language_*` entries (see below). @@ -905,8 +882,8 @@ limit facet, string Allows a partial search to records, chapter of the Pazpar2 manual results ](http://www.indexdata.com/pazpar2/doc/pazpar2_protocol.html) -log_level _global_ int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with - datestamps, 3 = messages with datestamps and stack-traces. +log_level _global_ string info The lowest level of logging output to emit. Acceptable values are + `trace`, `debug`, `info`, `warn`, `error` and `fatal`. maxrecs facet, int Limits the metasearching middleware to retrieving no more than the specified facets, number of records from each target. @@ -914,7 +891,8 @@ maxrecs facet, int Limits the metasearching m records, results -paragraphs reference int Limits the number of paragraphs rendered to the specified number. +paragraphs reference int Limits the number of paragraphs rendered to the specified number. If + omitted, there is no limit. pazpar2_url _global_ string If specified, this is the URL used to access the metasearch middleware. This service must be configured to provide search results, facets, etc. It may be @@ -925,47 +903,44 @@ pazpar2_url _global_ string If specified, this is the perpage facet, int Specifies the number of records to show per page in an auto-executing facets, widget. Contrast with `perpage_default`, which is used to prime the dropdown - record, which which a user chooses the page-size in an interactive session. + record, with which a user chooses the page-size in an interactive session. records, results perpage_default _team_ string 20 The initial value for the number of records to show on each page. -perpage_options ranking array *Note 3* A list of candidate page sizes. Users can choose between these to determine +perpage_options ranking array *Note 2* A list of candidate page sizes. Users can choose between these to determine how many records are displayed on each page of results. -pp2_hostname _global_ string *Note 7* Unless overridden by the `pazpar2_url` setting, this is used together with +pp2_hostname _global_ string *Note 3* Unless overridden by the `pazpar2_url` setting, this is used together with `pp2_path` to construct the URL to the Pazpar2 service (or Service Proxy). Set this to connect to a service on a different host from the default. -pp2_path _global_ string *Note 8* Unless overridden by the `pazpar2_url` setting, this is used together with +pp2_path _global_ string *Note 4* Unless overridden by the `pazpar2_url` setting, this is used together with `pp2_hostname` to construct the URL to the Pazpar2 service (or Service Proxy). Set this to connect to a service on a different host from the default. -query_width _search_ int 50 The width of the query box, in characters. - -responsive_design_width _global_ int If defined, then the facets display moves between two locations as the - screen-width varies, as described above. The specified number is the - threshhold width, in pixels, at which the facets move between their two - locations. +scan_all_nodes _global_ bool false An internal setting that changes how MKWS scans the HTML documen to discover + widgets. If set to true, a different approach is used which may be faster + under some circumstances. -scan_all_nodes _global_ bool - -sentences reference int Limits the number of paragraphs rendered to the specified number. +sentences reference int Limits the number of sentences rendered to the specified number. If + omitted, there is no limit. service_proxy_auth _global_ url If defined, this is the URL which, when `use_service_proxy` is true, is fetched once at the beginning of each session to authenticate the user and establish a session that encompasses a defined set of targets to search - in. When not defined, the URL is assembled from `auth_hostname` or - `pp2_hostname`, `sp_auth_path`, `sp_auth_query` and - `sp_auth_credentials`. See *Note 4* for details. + in. When not defined, the URL is assembled from `sp_auth_hostname` or + `pp2_hostname`, `pp2_path` or `sp_auth_path`, `sp_auth_query` and + `sp_auth_credentials`. See the [Assembling Pazpar2 + URLs](#assembling-pazpar2-urls) section below. -service_proxy_auth_domain _global_ domain Can be set to the domain for which `service_proxy_auth` proxies - authentication, so that cookies are rewritten to appear to be from this - domain. In general, this is not necessary, as this setting defaults to the - domain of `pazpar2_url`. +service_proxy_auth_domain _global_ domain When the server used for authentication -- e.g. the one identified by the + `service_proxy_auth` URL -- proxies for different server, this can be set to + the domain of the server that it proxies for, so that cookies are rewritten + to appear to be from this domain. show_lang lang bool true Indicates whether or not to display the language menu. @@ -973,58 +948,66 @@ show_perpage ranking bool true Indicates whether or not t show_sort ranking bool true Indicates whether or not to display the sort menu. -show_switch switch bool true Indicates whether or not to display the switch menu, for switching between - showing retrieved records and target information. +show_switch switch bool true Indicates whether or not to display the switch menu. -sort facet, string - facets, - record, - records, +sort facet, string Specifies the order in which to sort the records retrieved by an + facets, auto-executing widget. Must be one of those in the `sort_options` + record, array. Contrast with `sort_default`, which is used to prime the dropdown + records, with which a user chooses the sortorder in an interactive session. results -sort_default _team_ string relevance The label of the default sort criterion to use. Must be one of those in the - `sort` array. +sort_default _team_ string relevance The default sort criterion to use. Must be one of those in the + `sort_options` array. -sort_options ranking array *Note 6* List of supported sort criteria. Each element of the list is itself a +sort_options ranking array *Note 5* 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`. -sp_auth_credentials _global_ string +sp_auth_credentials _global_ string If defined, this must be a slash-separated combination of username and + password, which is sent as the authentication credentials on session + initialisation. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) + section below. -sp_auth_path _global_ string *Note 9* +sp_auth_hostname _global_ string If provided, overrides the `pp2_hostname` setting when constructing the + Service Proxy authentication URL. This need only be used when authentication + is performed on a different host from the remaining operations (search, + retrieve, etc.) -sp_auth_query _global_ string *Note 10* +sp_auth_path _global_ string Part of the URL used for authentication. See the [Assembling Pazpar2 + URLs](#assembling-pazpar2-urls) section below. -target facet, string - facets, - record, +sp_auth_query _global_ string *Note 6* Part of the URL used for authentication. See the [Assembling Pazpar2 + URLs](#assembling-pazpar2-urls) section below. + +target facet, string One of three ways to select which targets an auto-searching widgets uses. See + facets, the [Choosing targets from the library](#choosing-targets-from-the-library) + record, section above. records, results -targetfilter facet, string - facets, - record, +targetfilter facet, string One of three ways to select which targets an auto-searching widgets uses. See + facets, the [Choosing targets from the library](#choosing-targets-from-the-library) + record, section above. records, results -targets facet, string - facets, - record, +targets facet, string One of three ways to select which targets an auto-searching widgets uses. See + facets, the [Choosing targets from the library](#choosing-targets-from-the-library) + record, section above. records, results -template details, string - done, - facet, - facets, - images, - lang, +template details, string Numerous widgets use Handlebars templates to render HTML. In general, each + done, of these by default uses a template with the same name as the widget + facet, itself. Individual widgets can be customised to use a template of a + facets, different name by means of their `template` setting. The `records` widget + images, (and `record`, an equivalent that shows only a single record) use the + lang, `summary` template as well as the `records` template. navi, pager, progress, ranking, - record, records, reference, results, @@ -1033,49 +1016,70 @@ template details, string switch, targets -text builder string +text builder string "Build!" Specifies what text to use for the Builder button. use_service_proxy _global_ bool true If true, then a Service Proxy is used to deliver searching services rather - than raw Pazpar2. + than raw Pazpar2. An authentication phase is run during initialisation. ---- -(Perhaps we should get rid of the `show_lang`, `show_perpage`, -`show_sort` and `show_switch` configuration settings, as we display the relevant menus -only when their containers are provided -- e.g. an `mkws-lang` element -for the language menu. But for now we retain these, as an easier route -to lightly customise the display than by providing a full HTML -structure.) +The `show_lang`, `show_perpage`, `show_sort` and `show_switch` configuration settings are technically redundant, as the relevant +widgets, like all widgets, are displayed only when they are provided. But they are retained as an easier route to lightly +customise the display than by providing a full HTML structure. ### Notes -1. ["xtargets", "subject", "author"] +1. The default for `facets` is `["xtargets", "subject", "author"]` + +2. The default for `perpage_options` is `[10, 20, 30, 50]` -2. ### unused +3. The default for `pp2_hostname` is `"sp-mkws.indexdata.com"` -3. [10, 20, 30, 50] +4. The default for `pp2_path` is `"service-proxy/"` -4. ### unused +5. The default for `sort_options` is `[["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]` -5. "http://sp-mkws.indexdata.com/service-proxy/" +6. The default for `sp_auth_query` is `"command=auth&action=perconfig"` -6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]] +### Indirect settings -7. "sp-mkws.indexdata.com" +The values of any setting are generally interpreted literally. However, it is possible to specify a value indirectly -- for +example, by reference to a query parameter -- and this is often useful in contexts such as specifying an autosearch +query. Settings of this kind have values beginning with an exclamation mark, and take the form `!`_type_`!`_value_. -8. "service-proxy" +The currently supported types are: -9. The default for `sp_auth_path` is `"service-proxy/"`. +* `param` -- uses the value of the specified query parameter for the URL. For example +`