From: Mike Taylor <mike@indexdata.com>
Date: Fri, 17 Oct 2014 09:57:52 +0000 (+0100)
Subject: MKWS-279. Add documentation for the template parameters Jason asked about
X-Git-Tag: 1.0.0~159^2~5
X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=commitdiff_plain;h=78895440fc2748d7d4c5a8a0c88aef7c5f1b4989

MKWS-279. Add documentation for the template parameters Jason asked about
---

diff --git a/src/mkws.templates/Facet.handlebars b/src/mkws.templates/Facet.handlebars
index 621c9c1..cf697ed 100644
--- a/src/mkws.templates/Facet.handlebars
+++ b/src/mkws.templates/Facet.handlebars
@@ -7,6 +7,7 @@ terms:
   term - term name
   count - count of items matching in the current search for this team
   linkdata - attributes to add to the term element including an onclick handler
+  field - for the xtargets facet ONLY, the opaque identifier of the target
 }}
 
 <div class="mkwsFacetTitle">{{caption}}</div>
diff --git a/src/mkws.templates/Targets.handlebars b/src/mkws.templates/Targets.handlebars
index 99ed801..fd74d20 100644
--- a/src/mkws.templates/Targets.handlebars
+++ b/src/mkws.templates/Targets.handlebars
@@ -2,10 +2,10 @@
 Target detail
 
 data:
-  id - target id
-  hits - number of hits for this target
-  diagnostic - 
-  records - 
+  id - target id, an opaque identifier
+  hits - number of hits for this target, or "Error" if an error has occurred
+  diagnostic - diagnostic code returned by target, if any. May be numeric or human-readable
+  records - number of record retrieved from target
   state - target state
 }}
 <table>