Changes in authentication description.

[mkws-moved-to-github.git] / doc / mkws-manual.markdown

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index ef0666e..5c0916d 100644 (file)
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -371,24 +371,21 @@ output locale specific text via the mkws-translate helper like so:
 Example
 -------
 
-Rather than use the included AJAX helpers to render record details inline,
-here's a Records template that will link directly to the source via the address
-provided in the metadata as the first element of `md-electronic-url`:
-
-    <script class="mkws-template-records" type="text/x-handlebars-template">
-      {{#each hits}}
-        <div class="{{containerClass}}">
-          <a href="{{md-electronic-url.[0]}}">
-            <b>{{md-title}}</b>
-          </a>
-          {{#if md-title-remainder}}
-            <span>{{md-title-remainder}}</span>
-          {{/if}}
-          {{#if md-title-responsibility}}
-            <span><i>{{md-title-responsibility}}</i></span>
-          {{/if}}
-        </div>
-      {{/each}}
+Rather than use the toolkit's included AJAX helpers to render record
+details inline, here's a summary template that will link directly to
+the source via the address provided in the metadata as the first
+element of `md-electronic-url`:
+
+    <script class="mkws-template-summary" type="text/x-handlebars-template">
+      <a href="{{md-electronic-url.[0]}}">
+        <b>{{md-title}}</b>
+      </a>
+      {{#if md-title-remainder}}
+        <span>{{md-title-remainder}}</span>
+      {{/if}}
+      {{#if md-title-responsibility}}
+        <span><i>{{md-title-responsibility}}</i></span>
+      {{/if}}
     </script>
 
 For a more involved example where markup for multiple widgets is decorated with
@@ -397,8 +394,8 @@ employed, take a look at the source of
 [topic.html](http://example.indexdata.com/topic.html?q=water).
 
 
-Refinements
-===========
+Some Refinements
+================
 
 
 Message of the day
@@ -407,9 +404,9 @@ Message of the day
 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
-`mkws-motd` division anywhere on the page. It will be moved into the
-`mkws-results` area and initially displayed, but will be hidden when a
-search is made.
+`mkws-motd` division anywhere on the page. It will initially be moved
+into the `mkws-results` area and displayed, but will be hidden as soon
+as the first search is made.
 
 
 Popup results with jQuery UI
@@ -422,23 +419,28 @@ in a popup. The key part of such an application is this invocation of
 the MKWS jQuery plugin:
 
         <div class="mkws-search"></div>
-        <div class="mkws-popup" popup_width="1024" popup_height="650" popup_modal="0" popup_autoOpen="0" popup_button="input.mkwsButton">
-          <div class="mkws-switch"></div>
-          <div class="mkws-lang"></div>
+        <div class="mkws-popup" popup_width="1024" popup_height="650">
           <div class="mkws-results"></div>
-          <div class="mkws-targets"></div>
-          <div class="mkws-stat"></div>
         </div>
 
 The necessary scaffolding can be seen in an example application,
-http://example.indexdata.com/index-popup.html
+[popup.html](http://example.indexdata.com/popup.html).
+
+The relevant properties (`popup_width`, etc.) are documented
+[below](#jquery-ui-popup-invocation)
+in the reference section.
 
 
 Authentication and target configuration
 ---------------------------------------
 
-By default, MKWS configures itself to use a demonstration account on a
-service hosted by mkws.indexdata.com. This account (username `demo`,
+MKWS configures itself to use an account on a service hosted by
+`sp-mkws.indexdata.com`. By default, it sends no authentication
+credentials, allowing the appropriate account to be selected on the
+basis of referring URL or IP address.
+
+TODO REWRITE
+This account (username `demo`,
 password `demo`) provides access to about a dozen free data
 sources. Authentication onto this service is via an authentication URL
 on the same MKWS server, so no explicit configuration is needed.
@@ -852,7 +854,8 @@ popup_width     string  880                 Width of the popup window (if used),
 popup_height    string  760                 Height of the popup window (if used), in
                                             pixels.
 
-popup_button    string  `input.mkwsButton`  (Never change this.)
+popup_button    string  `input.mkwsButton`  A click on this selector will trigger the
+                                           popup to open
 
 popup_modal     string  0                   Modal confirmation mode. Valid values are 0 or 1
 
@@ -860,6 +863,8 @@ popup_autoOpen  string  1                   Open popup window on load. Valid val
 
 ----
 
+You can have more than one mkws-popup widgets on a page. Please use a different 
+popup_button value to address the right ones.
 
 The structure of the HTML generated by the MKWS widgets
 -------------------------------------------------------