X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=1066f63fadbff802bb0157b2a2edaf04ee3b2944;hb=948c00ce0f5621e9fda178f24e053b4a608b5561;hp=95ade1330c44052b82449bb9d8d9ad07ae970489;hpb=7920871bcf1a3763bb50e795ad973b6c6c8ce882;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 95ade13..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 @@ -542,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: @@ -882,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. @@ -1155,9 +1155,9 @@ 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 -------- ----- ------- ------------ -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` A click on this selector will trigger the - popup to open +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. ---- -You can have more than one mkws-popup widgets on a page. Please use a different -popup_button value to address the right ones. +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 widgets. This knowledge make it possible, for example, -to style each `