Ignore idzebra.pdf

[idzebra-moved-to-github.git] / doc / architecture.xml

diff --git a/doc/architecture.xml b/doc/architecture.xml
index dca8925..5b3a27e 100644 (file)
--- a/doc/architecture.xml
+++ b/doc/architecture.xml
@@ -1,5 +1,4 @@
  <chapter id="architecture">
-  <!-- $Id: architecture.xml,v 1.22 2007-05-24 13:44:09 adam Exp $ -->
   <title>Overview of &zebra; Architecture</title>
 
   <section id="architecture-representation">
@@ -170,9 +169,9 @@
     <para>
      In addition to &acro.z3950; requests, the &yaz; server frontend acts
      as HTTP server, honoring
-      <ulink url="&url.srw;">&acro.sru; &acro.soap;</ulink> 
+      <ulink url="&url.sru;">&acro.sru; &acro.soap;</ulink> 
      requests, and  
-     <ulink url="&url.sru;">&acro.sru; &acro.rest;</ulink> 
+     &acro.sru; &acro.rest;
      requests. Moreover, it can
      translate incoming 
      <ulink url="&url.cql;">&acro.cql;</ulink>
@@ -221,7 +220,7 @@
     </para>
     <para>
       The internal &acro.dom; &acro.xml; representation can be fed into four
-      different pipelines, consisting of arbitraily many sucessive
+      different pipelines, consisting of arbitrarily many successive
       &acro.xslt; transformations; these are for  
      <itemizedlist>
        <listitem><para>input parsing and initial
@@ -292,8 +291,8 @@
       static ranks. This imposes no overhead at all, both
       search and indexing perform still 
       <emphasis>O(1)</emphasis> irrespectively of document
-      collection size. This feature resembles Googles pre-ranking using
-      their Pagerank algorithm.
+      collection size. This feature resembles Google's pre-ranking using
+      their PageRank algorithm.
     </para>
     <para>
       Details on the experimental Alvis &acro.xslt; filter are found in 
@@ -443,7 +442,7 @@
     &zebra;'s internal index structure/data for a record.
     In particular, the regular record filters are not invoked when
     these are in use.
-    This can in some cases make the retrival faster than regular
+    This can in some cases make the retrieval faster than regular
     retrieval operations (for &acro.marc;, &acro.xml; etc).
    </para>
    <table id="special-retrieval-types">
@@ -496,6 +495,34 @@
        </entry>
        <entry>&acro.xml; and &acro.sutrs;</entry>
       </row>
+      <row>
+       <entry>
+       <literal>zebra::snippet</literal>
+       </entry>
+       <entry>
+       Get snippet for record for one or more indexes (f1,f2,..).
+       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; and &acro.sutrs;</entry>
+      </row>
+      <row>
+       <entry>
+       <literal>zebra::facet::</literal><replaceable>f1</replaceable>:<replaceable>t1</replaceable>,<replaceable>f2</replaceable>:<replaceable>t2</replaceable>,..
+       </entry>
+       <entry>
+       Get facet of a result set. The facet result is returned
+       as if it was a normal record, while in reality is a 
+       recap of most "important" terms in a result set for the fields 
+       given.
+       The facet facility first appeared in Zebra 2.0.20.
+       </entry>
+       <entry>&acro.xml;</entry>
+      </row>
      </tbody>
     </tgroup>
    </table>
@@ -537,7 +564,7 @@
       Z> elements zebra::meta
       Z> s 1+1
     </screen> 
-    displays all available metadata on the record. These include sytem
+    displays all available metadata on the record. These include system
     number, database name,  indexed filename,  filter used for indexing,
     score and static ranking information and finally bytesize of record.
    </para>