Remove trailing whitespace.

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

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index 6cd4cb8..429e8ce 100644 (file)
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -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
 
 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:
 
 by providing the `sp_auth_credentials` configuration setting as a string
 containing the username and password separated by a slash:
 

@@ -842,11 +842,6 @@ default values are in footnotes to keep the table reasonably narrow.
 ----
 Element                   Widget    Type    Default   Description
 --------                  ------    -----   --------- ------------
 ----
 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,
 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,

@@ -870,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.
 
 
 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).
 
                                                       language codes are `en` = English, `de` = German, `da` = Danish, and whatever
                                                       additional languages are configured using `language_*` entries (see below).
 

@@ -937,8 +932,8 @@ sentences                 reference int               Limits the number of sente
 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
 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
+                                                      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.
 
                                                       `sp_auth_credentials`. See the [Assembling Pazpar2
                                                       URLs](#assembling-pazpar2-urls) section below.
 

@@ -974,10 +969,15 @@ sp_auth_credentials       _global_  string            If defined, this must be a
                                                       initialisation. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls)
                                                       section below.
 
                                                       initialisation. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls)
                                                       section below.
 

-sp_auth_path              _global_  string  *Note 6*  Part of the URL used for authentication. See the [Assembling Pazpar2
+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_path              _global_  string            Part of the URL used for authentication. See the [Assembling Pazpar2

                                                       URLs](#assembling-pazpar2-urls) section below.
 
                                                       URLs](#assembling-pazpar2-urls) section below.
 

-sp_auth_query             _global_  string  *Note 7*  Part of the URL used for authentication. See the [Assembling Pazpar2
+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
                                                       URLs](#assembling-pazpar2-urls) section below.
 
 target                    facet,    string            One of three ways to select which targets an auto-searching widgets uses. See

@@ -1038,9 +1038,7 @@ customise the display than by providing a full HTML structure.
 
 5. The default for `sort_options` is `[["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]`
 
 
 5. The default for `sort_options` is `[["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]`
 

-6. The default for `sp_auth_path` is `"service-proxy/"`
-
-7. The default for `sp_auth_query` is `"command=auth&action=perconfig"`
+6. The default for `sp_auth_query` is `"command=auth&action=perconfig"`

 
 ### Indirect settings
 
 
 ### Indirect settings
 

@@ -1074,10 +1072,14 @@ assembled from the two configuration sessings `pp2_hostname` and `pp2_path`. How
 endpoint must be used, that endpoint can be specified in the `pazpar2_url` setting, and that will be used instead.
 
 In the common case where Pazpar2 is accessed via the Service Proxy, an authentication call is made during initialisation. The call
 endpoint must be used, that endpoint can be specified in the `pazpar2_url` setting, and that will be used instead.
 
 In the common case where Pazpar2 is accessed via the Service Proxy, an authentication call is made during initialisation. The call

-is generally made to the same endpoint as the other requests. However, 
+is generally made to the same endpoint as the other requests. However, the hostname used for authentication may if necessary be
+overridden using the `sp_auth_hostname` setting, and the path overridden by `sp_auth_path`. In any case, the value of
+`sp_auth_query` is appended; and if `sp_auth_credentials` is set, then it is used to add username and password parameters.

 
 

-and how `service_proxy_auth` is assembled from
-`auth_hostname` or `pp2_hostname`, `sp_auth_path`, `sp_auth_query` and `sp_auth_credentials`.
+So in the absence of any configuration added by an application, the Service Proxy authentication URL is made up of `pp2_hostname`
+(sp-mkws.indexdata.com) since `sp_auth_hostname` is undefined; and `pp2_path` (service-proxy/) since `sp_auth_path` is undefined;
+and `sp_auth_query` (command=auth&action=perconfig); and no credentials, since `sp_auth_credentials` is undefined. Therefore the
+URL `http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig` is generated.

 
 Language specification
 ----------------------
 
 Language specification
 ----------------------

@@ -1098,37 +1100,55 @@ in the specified language. For example:
        }
 
 The following strings occurring in the UI can be translated:
        }
 
 The following strings occurring in the UI can be translated:

-`Displaying`,
-`Next`,
-`Prev`,
-`Records`,
-`Search`,
-`Sort by`,
-`Targets`,
-`Facets`,
-`and show`,
-`found`,
-`of`,
-`per page`
-and
-`to`.
+
+* `Search complete: found`
+* `records`
+* `Displaying`
+* `to`
+* `of`
+* `found`
+* `Prev`
+* `Next`
+* `Sort by`
+* `and show`
+* `per page`
+* `Search`
+* `Active clients`
+* `Retrieved records`
+* `Records`
+* `Targets`
+* `Target ID`
+* `Hits`
+* `Diags`
+* `Records`
+* `State`

 
 In addition, facet names can be translated:
 
 In addition, facet names can be translated:

-`Authors`,
-`Sources`
-and
-`Subjects`.
+
+* `Authors`
+* `Sources`
+* `Subjects`
+
+and whatever field captions are defined by `facet_caption_*` settings.
+
+And sort-orders:
+
+* `relevance`
+* `title`
+* `newest`
+* `oldest`
+
+and whatever sort-orders are defined by the `sort_options` setting.

 
 Finally, the names of fields in the full-record display can be
 translated. These include, but may not be limited to:
 
 Finally, the names of fields in the full-record display can be
 translated. These include, but may not be limited to:

-`Author`,
-`Date`,
-`Location`,
-`Subject`
-and
-`Title`.
-

 
 

+* `Title`
+* `Date`
+* `Author`
+* `Links`
+* `Subject`
+* `Locations`

 
 jQuery UI popup invocation
 --------------------------
 
 jQuery UI popup invocation
 --------------------------

@@ -1170,7 +1190,7 @@ popup_autoOpen  string  1                   Open popup window on load. Valid val
 
 ----
 
 
 ----
 

-You can have more than one mkws-popup widgets on a page. Please use a different 
+You can have more than one mkws-popup widgets on a page. Please use a different

 popup_button value to address the right ones.
 
 The structure of the HTML generated by the MKWS widgets
 popup_button value to address the right ones.
 
 The structure of the HTML generated by the MKWS widgets

@@ -1188,18 +1208,18 @@ and .CLASS indicates an instance of a class.
 
        #mkwsSwitch
          a*
 
        #mkwsSwitch
          a*

-       
+

        #mkwsLang
          ( a | span )*
        #mkwsLang
          ( a | span )*

-       
+

        #mkwsSearch
          form
            input#mkwsQuery type=text
            input#mkwsButton type=submit
        #mkwsSearch
          form
            input#mkwsQuery type=text
            input#mkwsButton type=submit

-       
+

        #mkwsBlanket
          (no contents -- used only for masking)
        #mkwsBlanket
          (no contents -- used only for masking)

-       
+

        #mkwsResults
          table
            tbody
        #mkwsResults
          table
            tbody

@@ -1237,7 +1257,7 @@ and .CLASS indicates an instance of a class.
              tbody
                tr*
                  td*
              tbody
                tr*
                  td*

-       
+

        #mkwsStat
          span.head
          span.clients
        #mkwsStat
          span.head
          span.clients