Definitive documented list of config params.

[mkws-moved-to-github.git] / tools / htdocs / whitepaper.markdown

diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown
index bc9ebd3..220e9c9 100644 (file)
--- a/tools/htdocs/whitepaper.markdown
+++ b/tools/htdocs/whitepaper.markdown
@@ -215,7 +215,14 @@ the bottom on narrow screens and to the sidebar on wide screens.
 
 To turn on this behaviour, set the `responsive_design` configuration
 element to `true`, and `responsive_design_width` to the desired
-threshhold width in pixels.
+threshhold width in pixels. For example:
+
+        <script type="text/javascript">
+            var mkws_config = {
+                responsive_design: true,
+                responsive_design_width: 990
+            };
+        </script>
 
 If individual result-related components are in use in place of the
 all-in-one mkwsResults, then the redesigned application needs to
@@ -228,12 +235,33 @@ termlists should appear.
 
 ### Popup results with jQuery UI
 
-TODO
+The [jQuery UI library](http://en.wikipedia.org/wiki/JQuery_UI)
+can be used to construct MKWS applications in which the only component
+generally visible on the page is a search box, and the results appear
+in a popup. The key part of such an application is this invocation of
+the MKWS jQuery plugin:
+
+        <script type="text/javascript">
+          jQuery.pazpar2({ "layout":"popup", width:800, height:500 });
+        </script>
+
+The necessary scaffolding can be seen in an example application,
+http://example.indexdata.com/index-popup.html
 
 
 ### Authentication and target configuration
 
-TODO
+By default, MKWS configures itself to use a demo account on a service
+hosted by mkws.indexdata.com. This demo account provides access to
+about a dozen free data sources. Authentication onto this service is
+via an authentication URL on the same server, which MKWS uses by
+default so no configuration is needed.
+
+Access to a customised set of resources (including resources that
+require authentication) can be provided. In this case, a
+customer-specific authentication URL is used to gain access to these
+rather than the default set. Contact Index Data on info@indexdata.com
+for details.
 
 
 Reference Guide
@@ -241,7 +269,27 @@ Reference Guide
 
 ### Configuration object
 
-TODO
+       debug: int [1]
+       facets: array 
+       lang: string
+       lang_display: array
+       lang_menu: bool
+ADD    language_*: hash
+       pazpar2_url: string [/pazpar2/search.pz2]
+ADD    perpage: array
+       perpage_default: string
+       perpage_menu: bool [true]
+       query_width: int
+       responsive_design: bool
+ADD    responsive_design_width: int [980]
+       service_proxy_auth: url
+       service_proxy_url: string [http://mkws.indexdata.com/service-proxy/]
+ADD    sort: array
+       sort_default: string
+       sort_menu: bool [true]
+       use_service_proxy: bool [true]
+
+TODO add default values, describe
 
 ### jQuery plugin invocation