Step 1: add a rewriting authentication alias to the configuration:
RewriteEngine on
- RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
+ RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/\
+ ?command=auth&action=check,login&username=U&password=PW [P]
Step 2: set the MKWS configuration item `service_proxy_auth` to
`http://yourname.com/spauth/`.
----
-Configuration object
---------------------
+Configuration settings
+----------------------
+
+Configuration settings may be provided at the level of a indiviual widget, or a team, or globally. Per-widget configuration is
+described above; per-team settings can be placed in a `config` widget belonging to the relevant team, and will be applied to that
+team as a whole; and global settings are provided in the global variable `mkws_config`. This structure is a key-value lookup
+table, and may specify the values of many settings.
+
+Some settings apply only to specific widgets; others to the behaviour of the tookit as a whole. When a widget does not itself have
+a value specified for a particular configuration setting, its team is consulted; and if that also does not have a value, the global
+settings are consulted. Only if this, too, is unspecified, is the default value used.
-The configuration object `mkws_config` may be created before including
-the MKWS JavaScript code to modify default behaviour. This structure
-is a key-value lookup table, whose entries are described in the table
-below. All entries are optional, but if specified must be given values
-of the specified type. If ommitted, each setting takes the indicated
-default value; long default values are in footnotes to keep the table
-reasonably narrow.
+The supported configuration settings are described in the table below. For those settings that apply only to particular widgets,
+the relevant widgets are listed. All entries are optional, but if specified must be given values of the specified type. Long
+default values are in footnotes to keep the table reasonably narrow.
----
-Element Type Default Description
--------- ----- --------- ------------
-log_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
- datestamps, 3 = messages with datestamps and stack-traces.
+Element Widget Type Default Description
+-------- ------ ----- --------- ------------
+auth_hostname
+
+autosearch
+
+facet
+
+facet_caption_*
+
+facet_max_*
+
+facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
+ `xtargets`, `subject` and `author`.
+
+lang string en 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_options array [] A list of the languages to offer as options. If empty (the default), then all
+ configured languages are listed.
+
+language_* hash Support for any number of languages can be added by providing entries whose
+ name is `language_` followed by the code of the language. See the separate
+ section below for details.
+
+limit
+
+log_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
+ datestamps, 3 = messages with datestamps and stack-traces.
+
+maxrecs
+
+paragraphs
+
+pazpar2_url string *Note 2* The URL used to access the metasearch middleware. This service must be
+ configured to provide search results, facets, etc. It may be either unmediated
+ or Pazpar2 the MasterKey Service Proxy, which mediates access to an underlying
+ Pazpar2 instance. In the latter case, `service_proxy_auth` must be provided.
+
+perpage
+
+perpage_default string 20 The initial value for the number of records to show on each page.
+
+perpage_options array *Note 3* 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
+
+pp2_path
+
+query
+
+query_width int 50 The width of the query box, in characters.
+
+responsive_design_width 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
+
+sentences
-facets array *Note 1* Ordered list of names of facets to display. Supported facet names are
- `xtargets`, `subject` and `author`.
+service_proxy_auth url *Note 4* A 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.
-lang string en 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).
+service_proxy_auth_domain 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`.
-lang_options array [] A list of the languages to offer as options. If empty (the default), then all
- configured languages are listed.
+show_lang bool true Indicates whether or not to display the language menu.
-language_* hash Support for any number of languages can be added by providing entries whose name is
- `language_` followed by the code of the language. See the separate section below for
- details.
+show_perpage bool true Indicates whether or not to display the perpage menu.
-pazpar2_url string *Note 2* The URL used to access the metasearch middleware. This service must be configured to
- provide search results, facets, etc. It may be either unmediated or Pazpar2 the
- MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In
- the latter case, `service_proxy_auth` must be provided.
+show_sort bool true Indicates whether or not to display the sort menu.
-perpage_default string 20 The initial value for the number of records to show on each page.
+show_switch bool true Indicates whether or not to display the switch menu, for switching between
+ showing retrieved records and target information.
-perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many
- records are displayed on each page of results.
+sort
-query_width int 50 The width of the query box, in characters.
+sort_default string relevance The label of the default sort criterion to use. Must be one of those in the
+ `sort` array.
-responsive_design_width 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.
+sort_options array *Note 6* 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`.
-service_proxy_auth url *Note 4* A 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.
+sp_auth_credentials
-service_proxy_auth_domain 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`.
+sp_auth_path
-show_lang bool true Indicates whether or not to display the language menu.
+sp_auth_query
-show_perpage bool true Indicates whether or not to display the perpage menu.
+target
-show_sort bool true Indicates whether or not to display the sort menu.
+targetfilter
-show_switch bool true Indicates whether or not to display the switch menu, for switching between showing
- retrieved records and target information.
+targets
-sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort`
- array.
+template
-sort_options array *Note 6* 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`.
+text
-use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw
- Pazpar2.
+use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than
+ raw Pazpar2.
----
Perhaps we should get rid of the `show_lang`, `show_perpage`,
href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
<div class="mkws-search"></div>
- <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
+ <div class="mkws-popup" popup_width="1024" popup_height="650" popup_autoOpen="0">
<div class="mkws-switch"></div>
<div class="mkws-lang"></div>
<div class="mkws-results"></div>
projects / mkws-moved-to-github.git / blobdiff