----
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
-facet_caption_* facet
+facet_caption_* facet string
-facet_max_* facet
+facet_max_* facet int
facets _team_ array *Note 1* Ordered list of names of facets to display. Supported facet names are
`xtargets`, `subject` and `author`.
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.
6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]
+### Indirect settings
+
+FIXME !query!q, !path!2, etc.
Language specification
----------------------