X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=864b56fc61704f0006123b91852145b68973c675;hb=ef234764b8959f8cf0d73ed1a3d950c847e01d2c;hp=e4b81d118c67c25e568c604107d1031d69356339;hpb=dfef0d6f251444f898064a1608832f24235c36f9;p=mkws-moved-to-github.git
diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index e4b81d1..864b56f 100644
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -590,7 +590,8 @@ yourname.com`:
Step 1: add a rewriting authentication alias to the configuration:
RewriteEngine on
- RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
+ RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/\
+ ?command=auth&action=check,login&username=U&password=PW [P]
Step 2: set the MKWS configuration item `service_proxy_auth` to
`http://yourname.com/spauth/`.
@@ -867,16 +868,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
@@ -887,17 +888,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
@@ -907,21 +908,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.
@@ -929,17 +930,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
@@ -957,8 +959,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`,
@@ -1048,7 +1050,7 @@ from that toolkit. The relevant lines are:
href="http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css" />
-