`query` The input area for a query. Usually generated a `search`
widget.
-`ranking` Provides a dropdown allowing the user to choose how
- the displayed records should be sorted. The
- available set of sort criteria can be set as the
- `sort_options` configuration item, whose value is
- an array of two-element arrays. The first item of
- each sub-array is a pazpar2 sort-expression such as
- `data:0` and the second is a human-readable label
- such as `newest`. The initial selected
- value can be set by the `sort_default` configuration
- item.
+`ranking` The result-ranking area, consisting of a `sort`
+ widget and a `per-page` widget. These may instead
+ be specified separately if preferred.
`record` A detailed display of a single record, usually
appearing when the user clicks on a summary
on a summary record make it pop up as a detailed
record.)
-`reference` x
-
-`results` x
-
-`search-form` x
-
-`search` x
+`reference` A short summary about a subject specified by the
+ `autosearch` configuration item. This is created by
+ drawing a picture and a paragraph of text from
+ Wikipedia. To work correctly, this widget must be
+ used in a library that provides the
+ `wikimedia_wikipedia_single_result` target.
-`sort` x
+`results` A large compound widget used to provide the most
+ important results-oriented widgets in a pre-packaged
+ framework: `facets`, `ranking`, `pager`, `navi` and
+ `records`.
-`stat` x
+`search-form` The search form, containing the query area and the
+ button. Usually generated a `search` widget.
-`summary` x
+`search` The search box, consisting of a form containing a
+ query area and a button.
-`switch` x
+`sort` Provides a dropdown allowing the user to choose how
+ the displayed records should be sorted. The
+ available set of sort criteria can be set as the
+ `sort_options` configuration item, whose value is
+ an array of two-element arrays. The first item of
+ each sub-array is a pazpar2 sort-expression such as
+ `data:0` and the second is a human-readable label
+ such as `newest`. The initial selected
+ value can be set by the `sort_default` configuration
+ item.
-`targets` x
+`stat` A summary line stating how many targets remain
+ active, how many records have been found, and how
+ many of them have been retrieved for display. For
+ most purposes, the `progress` widget may be
+ preferable.
+
+`summary` A short record, included in the list shown when a
+ search is run. When clicked, this generally pops up
+ a detailed `record` widget. This widget is generated
+ by the toolkit in response to search results.
+
+`switch` A pair of buttons allowing the user to switch
+ between viewing the search results (the usual case)
+ or the target list.
+
+`targets` A list of all targets in the present library,
+ showing their ID, the number of records they have
+ found for the current search, any diagnostics they
+ have returned, the number of records that have been
+ returned for display, and the connection state.
----
----
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.
+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`.
`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
+
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.
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.
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
+
+sp_auth_path
+
+sp_auth_query
+
+target
+
+targetfilter
+
+targets
+
+template
+
+text
+
use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw
Pazpar2.
----
projects / mkws-moved-to-github.git / blobdiff