debug function uses mkws.log rather than old mkws.debug.

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

diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown
index 7ae655d..376da7a 100644 (file)
--- a/tools/htdocs/whitepaper.markdown
+++ b/tools/htdocs/whitepaper.markdown
@@ -200,25 +200,25 @@ Refinements
 Some applications might like to open with content in the area that
 will subsequently be filled with result-records -- a message of the
 day, a welcome message or a help page. This can be done by placing an
 Some applications might like to open with content in the area that
 will subsequently be filled with result-records -- a message of the
 day, a welcome message or a help page. This can be done by placing an

-`mkwsMOTDContainer` division on the page next to `mkwsResults` or
-`mkwsRecords`. The contents of this element are initially displayed,
-but will be hidden when a search is made.
+`mkwsMOTD` division anywhere on the page. It will be moved into the
+`mkwsResults` area and initially displayed, but will be hidden when a
+search is made.

 
 
 ### Customised display using Handlebars templates
 
 Certain aspects of the widget-set's display can be customised by
 
 
 ### Customised display using Handlebars templates
 
 Certain aspects of the widget-set's display can be customised by

-providing Handlebars templates with well-known IDs that begin with the
-string `mkwsTemplate`. At present, the supported templates are:
+providing Handlebars templates with well-known classes that begin with
+the string `mkwsTemplate_`. At present, the supported templates are:

 
 

-* `mkwsTemplateSummary` -- used for each summary record in a list of
+* `mkwsTemplate_Summary` -- used for each summary record in a list of

   results.
 
   results.
 

-* `mkwsTemplateRecord` -- used when displaying a full record.
+* `mkwsTemplate_Record` -- used when displaying a full record.

 
 For both of these the metadata record is passed in, and its fields can
 be referenced in the template. As well as the metadata fields
 
 For both of these the metadata record is passed in, and its fields can
 be referenced in the template. As well as the metadata fields

-(`md-*`), two special fields are provided to the `mkwsTemplateSummary`
+(`md-*`), two special fields are provided to the `mkwsTemplate_Summary`

 template, for creating popup links for full records. These are `_id`,
 which must be provided as the `id` attribute of a link tag, and
 `_onclick`, which must be provided as the `onclick` attribute.
 template, for creating popup links for full records. These are `_id`,
 which must be provided as the `id` attribute of a link tag, and
 `_onclick`, which must be provided as the `onclick` attribute.

@@ -226,7 +226,7 @@ which must be provided as the `id` attribute of a link tag, and
 For example, an application can install a simple author+title summary
 record in place of the usual one providing the following template:
 
 For example, an application can install a simple author+title summary
 record in place of the usual one providing the following template:
 

-        <script id="mkwsTemplateSummary" type="text/x-handlebars-template">
+        <script class="mkwsTemplate_Summary" type="text/x-handlebars-template">

           {{#if md-author}}
             <span>{{md-author}}</span>
           {{/if}}
           {{#if md-author}}
             <span>{{md-author}}</span>
           {{/if}}

@@ -351,7 +351,7 @@ debug_level               int     1         Level of debugging output to emit. 0
                                             datestamps, 3 = messages with datestamps and stack-traces.
 
 facets                    array   *Note 1*  Ordered list of names of facets to display. Supported facet names are 
                                             datestamps, 3 = messages with datestamps and stack-traces.
 
 facets                    array   *Note 1*  Ordered list of names of facets to display. Supported facet names are 

-                                            `sources`, `subjects` and `authors`.
+                                            `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
 
 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

@@ -384,7 +384,7 @@ 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.
 
                                             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 authenticationm, so
+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`.
 
                                             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`.