X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=14e88170ed1dd92bcd0f84d975ec8b658ff65003;hb=833f9a57fb5bf157a433804597caf8aa59ac48eb;hp=f346691a7f3d0df1df56a11623b3679d0d2bc783;hpb=31bdce743947c17a8ed1e2e9bcd3dfc247d35fce;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index f346691..14e8817 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -860,124 +860,181 @@ default values are in footnotes to keep the table reasonably narrow. ---- Element Widget Type Default Description -------- ------ ----- --------- ------------ -auth_hostname +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, - facets, +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, records, results -facet +facet facet string For a `facet` widget, this setting is mandatory, and indicates which field to + list terms for. Three fields are supported: `subject`, `author` and + `xtargets` -- the latter a special case which treats the target providing a + record as a facet. Any other field may also be used, but the default caption + and maximum term-count may not be appropriate, needing to be overridden by + `facet_caption_*` and `facet_max_*` settings. -facet_caption_* +facet_caption_* facet string Specifies what on-screen caption is to be used for the named facet: for + example, if a `date` facet is generated, then `facet_caption_date` can be + used to set the caption to "Year". -facet_max_* +facet_max_* facet int Specifies how many terms are to be displayed for the named facet: for + example, if a `publisher` facet is generated, then `facet_max_publisher` can + be used to limit the list to the top six. -facets array *Note 1* Ordered list of names of facets to display. Supported facet names are - `xtargets`, `subject` and `author`. +facets _team_ array *Note 1* Ordered list of names of facets to display. -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 _team_ string en Two-letter ISO 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 +lang_options lang 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 +language_* _global_ 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 +limit facet, string ### See the Search section in + facets, [the Protocol chapter of the Pazpar2 manual + record, ](http://www.indexdata.com/pazpar2/doc/pazpar2_protocol.html) + records, + results -log_level int 1 Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with +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. -maxrecs - -paragraphs +maxrecs facet, int + facets, + record, + records, + results -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. +paragraphs reference int -perpage +pazpar2_url _global_ 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_default string 20 The initial value for the number of records to show on each page. +perpage facet, int + facets, + record, + records, + 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. +perpage_default _team_ string 20 The initial value for the number of records to show on each page. -pp2_hostname +perpage_options ranking 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_path +pp2_hostname _global_ string -query +pp2_path _global_ string -query_width int 50 The width of the query box, in characters. +query_width _search_ 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 _global_ 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 +scan_all_nodes _global_ bool -sentences +sentences reference int -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 _global_ 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 _global_ 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. +show_lang lang bool true Indicates whether or not to display the language menu. -show_perpage 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 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 bool true Indicates whether or not to display the switch menu, for switching between +show_switch switch bool true Indicates whether or not to display the switch menu, for switching between showing retrieved records and target information. -sort +sort facet, string + facets, + record, + records, + results -sort_default string relevance The label of the default sort criterion to use. Must be one of those in the +sort_default _team_ 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 +sort_options ranking 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-expression such as `data:0` and the second is a human-readable label + such as `newest`. -sp_auth_credentials +sp_auth_credentials _global_ string -sp_auth_path +sp_auth_path _global_ string -sp_auth_query +sp_auth_query _global_ string -target +target facet, string + facets, + record, + records, + results -targetfilter +targetfilter facet, string + facets, + record, + records, + results -targets +targets facet, string + facets, + record, + records, + results -template +template details, string + done, + facet, + facets, + images, + lang, + navi, + pager, + progress, + ranking, + record, + records, + reference, + results, + search, + stat, + switch, + targets -text +text builder string -use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than - raw Pazpar2. +use_service_proxy _global_ 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`, +(Perhaps we should get rid of the `show_lang`, `show_perpage`, `show_sort` and `show_switch` configuration settings, as we display the relevant menus only when their containers are provided -- e.g. an `mkws-lang` element for the language menu. But for now we retain these, as an easier route to lightly customise the display than by providing a full HTML -structure. +structure.) ### Notes @@ -993,6 +1050,9 @@ structure. 6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]] +### Indirect settings + +FIXME !query!q, !path!2, etc. Language specification ----------------------