----
Element Widget Type Default Description
-------- ------ ----- --------- ------------
-auth_hostname _global_
+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 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
+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
+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 _team_ 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 _team_ 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 lang array [] A list of the languages to offer as options. If empty (the default), then all
configured languages are listed.
name is `language_` followed by the code of the language. See the separate
section below for details.
-limit facet,
- facets,
- record,
+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 _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 facet,
+maxrecs facet, int
facets,
record,
records,
results
-paragraphs reference
+paragraphs reference int
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
an underlying Pazpar2 instance. In the latter case, `service_proxy_auth` must
be provided.
-perpage facet,
+perpage facet, int
facets,
record,
records,
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_hostname _global_
+pp2_hostname _global_ string
-pp2_path _global_
+pp2_path _global_ string
query_width _search_ int 50 The width of the query box, in characters.
threshhold width, in pixels, at which the facets move between their two
locations.
-scan_all_nodes _global_
+scan_all_nodes _global_ bool
-sentences reference
+sentences reference int
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
show_switch switch bool true Indicates whether or not to display the switch menu, for switching between
showing retrieved records and target information.
-sort facet,
+sort facet, string
facets,
record,
records,
sort-expression such as `data:0` and the second is a human-readable label
such as `newest`.
-sp_auth_credentials _global_
+sp_auth_credentials _global_ string
-sp_auth_path _global_
+sp_auth_path _global_ string
-sp_auth_query _global_
+sp_auth_query _global_ string
-target facet,
+target facet, string
facets,
record,
records,
results
-targetfilter facet,
+targetfilter facet, string
facets,
record,
records,
results
-targets facet,
+targets facet, string
facets,
record,
records,
results
-template details,
+template details, string
done,
facet,
facets,
switch,
targets
-text builder
+text builder string
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
6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]
+### Indirect settings
+
+FIXME !query!q, !path!2, etc.
Language specification
----------------------
projects / mkws-moved-to-github.git / blobdiff