Spare comma.
[mkws-moved-to-github.git] / tools / htdocs / whitepaper.markdown
index 7a07fed..fdc663b 100644 (file)
@@ -54,7 +54,7 @@ The following is a complete MKWS-based searching application:
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         <title>MKWS demo client</title>
         <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
-        <link rel="stylesheet" href="http://mkws.indexdata.com/mkwsStyle.css" />
+        <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
       </head>
       <body>
         <div id="mkwsSearch"></div>
@@ -83,7 +83,7 @@ header, which are loaded from the tool site mkws.indexdata.com:
 * `mkws-complete.js`
   contains all the JavaScript needed by the widget-set.
 
-* `mkwsStyle.css`
+* `mkws.css`
   provides the default CSS styling 
 
 Second, within the HTML body, `<div>` elements with special IDs that
@@ -137,7 +137,7 @@ this:
           var mkws_config = {
             lang: "da",
             sort_default: "title",
-            query_width: 60,
+            query_width: 60
           };
         </script>
         <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
@@ -180,7 +180,7 @@ following lower-level components provided instead:
 
 Customisation of MKWS searching widgets can also be achieved by
 overriding the styles set in the toolkit's CSS stylesheet. The default
-styles can be inspected in `mkwsStyle.css` and overridden in any
+styles can be inspected in `mkws.css` and overridden in any
 styles that appears later in the HTML than that file. At the simplest
 level, this might just mean changing fonts, sizes and colours, but
 more fundamental changes are also possible.
@@ -277,7 +277,7 @@ long default values are in footnotes to keep the table reasonably narrow.
 ---
 Element                  Type    Default   Description
 --------                 -----   --------- ------------
-debug                    int     1         Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
+debug_level              int     1         Level of debugging output to emit. 0 = none, 1 = messages, 2 = messages with
                                            datestamps, 3 = messages with datestamps and stack-traces.
 
 facets                   array   *Note 1*  Ordered list of names of facets to display. Supported facet names are 
@@ -290,8 +290,6 @@ lang                     string  en        Code of the default language to displ
 lang_options             array   []        A list of the languages to offer as options. If empty (the default), then all
                                            configured languages are listed.
 
-show_lang                bool    true      Indicates whether or not to display the language menu.
-
 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.
@@ -301,12 +299,10 @@ pazpar2_url              string  *Note 2*  The URL used to access the metasearch
                                            MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In
                                            the latter case, `service_proxy_auth` must be provided.
 
-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          string  20        The initial value for the number of records to show on each page.
 
-show_perpage             bool    true      Indicates whether or not to display the perpage menu.
+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.
 
 query_width              int     50        The width of the query box, in characters.
 
@@ -318,19 +314,21 @@ service_proxy_auth       url     *Note 4*  A URL which, when `use_service_proxy`
                                            session to authenticate the user and establish a session that encompasses a defined set
                                            of targets to search in.
 
-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`.
+show_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_sort                bool    true      Indicates whether or not to display the sort menu.
 
 sort_default             string  relevance The label of the default sort criterion to use. Must be one of those in the `sort`
                                            array.
 
-show_sort                bool    true      Indicates whether or not to display the sort menu.
+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`.
 
 use_service_proxy        bool    true      If true, then a Service Proxy is used to deliver searching services rather than raw
-                                           Pazpar2. ### Do we even need this? Can't we just assume that the Service Proxy is in
-                                           use when and only when `service_proxy_auth` is defined? Alternatively, retain this, but
-                                           use the same entry to specify the URL in either case.
+                                           Pazpar2.
 ---
 
 Perhaps we should get rid of the `show_lang`, `show_perpage` and