From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 22 Aug 2007 08:02:30 +0000 (+0000)
Subject: A little more on snippet support
X-Git-Tag: ZEBRA.2.0.16~17
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=7f49e3326f7cf483c6d99393fef0816627544a2e;p=idzebra-moved-to-github.git

A little more on snippet support
---

diff --git a/doc/architecture.xml b/doc/architecture.xml
index aaafe2c..d9b5934 100644
--- a/doc/architecture.xml
+++ b/doc/architecture.xml
@@ -1,5 +1,5 @@
  <chapter id="architecture">
-  <!-- $Id: architecture.xml,v 1.23 2007-08-21 11:06:46 adam Exp $ -->
+  <!-- $Id: architecture.xml,v 1.24 2007-08-22 08:02:30 adam Exp $ -->
   <title>Overview of &zebra; Architecture</title>
 
   <section id="architecture-representation">
@@ -501,7 +501,12 @@
 	<literal>zebra::snippet</literal>
        </entry>
        <entry>
-	Get snippet for record.
+	Get snippet for record. This includes a phrase from the original
+	record at the point where a match occurs (for a query). By default
+	give terms before - and after are included in the snippet. The
+	matching terms are enclosed within element
+	<literal>&lt;s&gt;</literal>. The snippet facility requires
+	Zebra 2.0.16 or later.
        </entry>
        <entry>&acro.xml;</entry>
       </row>