X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=03e408c22e29cd5a223b3937422a2036fc76cd88;hb=e4bbbd984b9aebc440d066da6258a8cfd4feb3ec;hp=3bda698ef07fb615d46d328f2af7ad6c714e59c3;hpb=157f9842962f1b51d2a937bdb10d397cb697be26;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 3bda698..03e408c 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -841,16 +841,21 @@ Name Description ---- -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 Widget Type Default Description @@ -868,16 +873,16 @@ 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 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. +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 @@ -888,17 +893,17 @@ 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. +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. +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 @@ -908,21 +913,21 @@ 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. +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 -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. +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. -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`. +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`. show_lang bool true Indicates whether or not to display the language menu. @@ -930,17 +935,18 @@ show_perpage bool true Indicates whether or not to show_sort bool true Indicates whether or not to display the sort menu. -show_switch bool true Indicates whether or not to display the switch menu, for switching between showing - retrieved records and target information. +show_switch bool true Indicates whether or not to display the switch menu, for switching between + showing retrieved records and target information. sort -sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort` - array. +sort_default string relevance The label of the default sort criterion to use. Must be one of those in the + `sort` array. -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`. +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`. sp_auth_credentials @@ -958,8 +964,8 @@ template 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`,