run show_record() for sources and authors limited searches

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

index 64e4d85..8e69e83 100644 (file)
--- a/tools/htdocs/whitepaper.markdown
+++ b/tools/htdocs/whitepaper.markdown
@@ -1,7 +1,8 @@
-% Using the MasterKey Widget Set to embed metasearching functionality in any web-site
+% Embedded metasearching with the MasterKey Widget Set
  % Mike Taylor
  % 26 July 2013
  
+
  Introduction
  ------------
  
@@ -112,7 +113,28 @@ are supported. The main `<div>`s are:
  * `mkwsStat` --provides a status line summarising the statistics of
     the various targets.
  
-### different HTML structure
+To see all of these working together, just put them all into the HTML
+`<body>` like so:
+
+        <div id="mkwsSwitch"></div>
+        <div id="mkwsLang"></div>
+        <div id="mkwsSearch"></div>
+        <div id="mkwsResults"></div>
+        <div id="mkwsTargets"></div>
+        <div id="mkwsStat"></div>
+
+Configuration
+-------------
+
+TODO
+
+resposive resize
+
+
+Control over HTML and CSS
+-------------------------
+
+TODO
  
  More sophisticated applications will not simply place the `<div>`s
  together, but position them carefully within an existing page
@@ -120,25 +142,35 @@ framework -- such as a Drupal template, an OPAC or a SharePoint page.
  
  Breaking up mkwsResults
  
-### configuration object
+overriding styles
  
-resposive resize
  
-### overriding styles
+Popup results with jQuery UI
+----------------------------
+
+TODO
+
+
+Authentication and target configuration
+---------------------------------------
+
+TODO
+
  
-### use jQuery popup
+Reference Guide
+---------------
  
-### Authentication setups
+### Configuration object
  
-Configuring targets
+TODO
  
-### Reference
+### jQuery plugin invocation
  
-Configuration object
+TODO
  
-jQuery plugin invocation
+### The structure of the HTML generated by the MKWS widgets
  
-The structure of the HTML generated by the MKWS widgets
+TODO
  
  - - -