Fix very error-prone MarkDown table alignment.

[mkws-moved-to-github.git] / doc / mkws-manual.markdown

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index d33dc7c..41fc31f 100644 (file)
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -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.
                   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 <http://mkws.indexdata.com/progress.gif> unless overridden with the `src` configuration
+                  item, which is initially invisible, appears when a search is submitted, and disappears when the search is
+                  complete.
+

 ----
 
 
 ----
 
 

@@ -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.
 
 
 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).
 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).

@@ -946,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.
 
                                                       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`
 
 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`

@@ -984,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.
 
 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.
 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.