From: Jason Skomorowski <jason@indexdata.com>
Date: Fri, 17 Oct 2014 14:44:01 +0000 (-0400)
Subject: Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
X-Git-Tag: 1.0.0~159^2~1
X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=a56766976a02622656c19c32b5bbbcda25a2571a;hp=4e1675fa47595979321f6ae8b7588bc61f24ff79

Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
---

diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index 1e767d0..4326b4a 100644
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -252,8 +252,7 @@ Inspecting metadata for templating
 MKWS makes requests to Service Proxy or Pazpar2 that perform the actual
 searching. Depending on how these are configured and what is available from the
 targets you are searching there may be more data available than what is
-presented by the default templates. In this case, you can redefine the
-`Record` template to include more fields in the full-record popup.
+presented by the default templates.
 
 Handlebars offers a convenient log helper that will output the contents of a
 variable for you to inspect. This lets you look at exactly what is being
diff --git a/src/mkws.templates/Image.handlebars b/src/mkws.templates/Image.handlebars
index abee587..f74f174 100644
--- a/src/mkws.templates/Image.handlebars
+++ b/src/mkws.templates/Image.handlebars
@@ -1,8 +1,11 @@
 {{!
 Records presented as images.
 
+The non-metadata keys enable an optional link to display an AJAX popup that
+fetches additional record detail.
+
 hits:
-  containerClass - class  attribute for same
+  containerClass - partial class attribute for element containing a record
   detailLinkId - id for the element triggering detail display
   detailClick - a click event handler for details
   renderedDetails - active record details rendered from the Record template
diff --git a/src/mkws.templates/Ranking.handlebars b/src/mkws.templates/Ranking.handlebars
index 1c823bb..c016dc5 100644
--- a/src/mkws.templates/Ranking.handlebars
+++ b/src/mkws.templates/Ranking.handlebars
@@ -2,8 +2,8 @@
 Ranking -- widget to select sort ordering and number of records to display
 
 team - team for this widget
-showSort
-showPerPage
+showSort - set if sort control is to be displayed
+showPerPage - set if per-page control is to be displayed
 sort
   key - machine readable value for this sort option
   label - text to display for this sort option
diff --git a/src/mkws.templates/Record.handlebars b/src/mkws.templates/Record.handlebars
index f8bf951..9e8184e 100644
--- a/src/mkws.templates/Record.handlebars
+++ b/src/mkws.templates/Record.handlebars
@@ -1,5 +1,7 @@
 {{!
 Full record display.
+
+Top level object is metadata from Service Proxy / Pazpar2
 }}
 <table>
   <tr>
diff --git a/src/mkws.templates/Records.handlebars b/src/mkws.templates/Records.handlebars
index 03ba9a2..3e1b3a7 100644
--- a/src/mkws.templates/Records.handlebars
+++ b/src/mkws.templates/Records.handlebars
@@ -1,8 +1,11 @@
 {{!
 Records from a search.
 
+The non-metadata keys enable an optional link to display an AJAX popup that
+fetches additional record detail.
+
 hits:
-  containerClass - class  attribute for same
+  containerClass - partial class attribute for element containing a record
   detailLinkId - id for the element triggering detail display
   detailClick - a click event handler for details
   renderedDetails - active record details rendered from the Record template