From: Jason Skomorowski <jason@indexdata.com>
Date: Fri, 17 Oct 2014 14:43:22 +0000 (-0400)
Subject: Improve template comments MKWS-279
X-Git-Tag: 1.0.0~159^2~2
X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=5879554a4937b274023043809e0c9a04f4661f32

Improve template comments MKWS-279
---

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