X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=41fc31f464fe82931fd5ea30bc42a62c060177fe;hp=8fd07e36cb48c2ba20ec37e6affb63f66772d140;hb=00204cd716f392cbde47cd5371a663241c46710d;hpb=245062e3f211edfde39f3dc3ca026b93f2bc53fb diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 8fd07e3..41fc31f 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 @@ -820,6 +820,11 @@ Name Description found for the current search, any diagnostics they have returned, the number of records that have been returned for display, and the connection state. + +`waiting` An image, defaulting to unless overridden with the `src` configuration + item, which is initially invisible, appears when a search is submitted, and disappears when the search is + complete. + ---- @@ -840,7 +845,7 @@ the relevant widgets are listed. All entries are optional, but if specified must default values are in footnotes to keep the table reasonably narrow. ---- -Element Widget Type Default Description +Setting Widget Type Default Description -------- ------ ----- --------- ------------ 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). @@ -865,6 +870,12 @@ facet_max_* facet int Specifies how many terms a facets _team_ array *Note 1* Ordered list of names of facets to display. +freeze_opacity records float If defined, a fractional value between in the range 0.0 (transparent) to 1.0 + (opaque). During the short period after a mouse-move over the records when + the display will not be updated, the widget is faded to that opacity + (reverting to full opacity when the period elapses or the mouse leaves the + area). + 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). @@ -882,8 +893,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. @@ -891,6 +902,10 @@ maxrecs facet, int Limits the metasearching m records, results +newsearch_opacity records, float If defined, a fractional value between in the range 0.0 (transparent) to 1.0 + facets (opaque). When a new search is submitted, the widget fades to that opacity + (reverting to full opacity when data arrives). + paragraphs reference int Limits the number of paragraphs rendered to the specified number. If omitted, there is no limit. @@ -942,13 +957,13 @@ service_proxy_auth_domain _global_ domain When the server used for a 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. +show_lang lang bool true Indicates whether or not to display the language menu. -show_perpage ranking bool true Indicates whether or not to display the perpage menu. +show_perpage ranking bool true Indicates whether or not to display the perpage menu. -show_sort ranking bool true Indicates whether or not to display the sort menu. +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. +show_switch switch bool true Indicates whether or not to display the switch menu. 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` @@ -980,6 +995,9 @@ sp_auth_path _global_ string Part of the URL used for a sp_auth_query _global_ string *Note 6* Part of the URL used for authentication. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) section below. +src waiting url The address of an image to use in the `waiting` widget in place of the + default spinning wheel. Used to indicate that a search is in progress. + 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. @@ -1177,7 +1195,7 @@ 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 int 880 Width of the popup window, in pixels.