added a lot of info about attribute sets, PQF query structure, and string use attributes

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

diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml
index df73cb9..970e922 100644 (file)
--- a/doc/recordmodel-alvisxslt.xml
+++ b/doc/recordmodel-alvisxslt.xml
@@ -1,5 +1,5 @@
  <chapter id="record-model-alvisxslt">
-  <!-- $Id: recordmodel-alvisxslt.xml,v 1.3 2006-02-16 12:32:31 marc Exp $ -->
+  <!-- $Id: recordmodel-alvisxslt.xml,v 1.8 2006-06-13 13:45:08 marc Exp $ -->
   <title>ALVIS XML Record Model and Filter Module</title>
   
 
@@ -58,7 +58,7 @@
     unique, these are the literal <literal>schema</literal> or 
     <literal>element set</literal> names used in 
       <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink>,
-      <ulink url="http://www.loc.gov/standards/sru/">SRU</ulink> and
+      <ulink url="&url.sru;">SRU</ulink> and
     Z39.50 protocol queries.
     The paths in the <literal>stylesheet</literal> attributes
     are relative to zebras working directory, or absolute to file
@@ -187,9 +187,45 @@
      the same character normalization map <literal>w</literal>. 
     </para>
     <para>
+     Finally, this example configuration can be queried using PQF
+     queries, either transported by Z39.50, (here using a yaz-client) 
+     <screen>
+      <![CDATA[
+      Z> open localhost:9999
+      Z> elem dc
+      Z> form xml
+      Z>
+      Z> f @attr 1=dc:creator Kumar
+      Z> scan @attr 1=dc:creator adam
+      Z>
+      Z> f @attr 1=dc:title @attr 4=2 "proceeding congress superconductivity"
+      Z> scan @attr 1=dc:title abc
+      ]]>
+     </screen>
+     or the proprietary
+     extentions <literal>x-pquery</literal> and
+     <literal>x-pScanClause</literal> to
+     SRU, and SRW
+     <screen>
+      <![CDATA[
+      http://localhost:9999/?version=1.1&operation=searchRetrieve&x-pquery=%40attr+1%3Ddc%3Acreator+%40attr+4%3D6+%22the
+      http://localhost:9999/?version=1.1&operation=scan&x-pScanClause=@attr+1=dc:date+@attr+4=2+a
+      ]]>
+     </screen>
+     See <xref linkend="server-sru"/> for more information on SRU/SRW
+     configuration, and <xref linkend="gfs-config"/> or 
+     <ulink url="http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql">
+      the YAZ manual CQL section</ulink>
+     for the details
+     of the YAZ frontend server 
+     <ulink url="&url.cql;">CQL</ulink>
+     configuration. 
+    </para>
+    <para>
      Notice that there are no <filename>*.abs</filename>,
      <filename>*.est</filename>, <filename>*.map</filename>, or other GRS-1
-     filter configuration files involves in this process. 
+     filter configuration files involves in this process, and that the
+     literal index names are used during search and retrieval.
     </para>
    </sect2>
   </sect1>
@@ -388,6 +424,28 @@
 
   </sect2>
 
+  <sect2 id="record-model-alvisxslt-example">
+   <title>ALVIS Filter OAI Indexing Example</title>
+   <para>
+     The sourcecode tarball contains a working Alvis filter example in
+     the directory <filename>examples/alvis-oai/</filename>, which
+     should get you started.  
+    </para>
+    <para>
+     More example data can be harvested from any OAI complient server,
+     see details at the  OAI 
+     <ulink url="http://www.openarchives.org/">
+      http://www.openarchives.org/</ulink> web site, and the community
+      links at 
+     <ulink url="http://www.openarchives.org/community/index.html">
+      http://www.openarchives.org/community/index.html</ulink>.
+     There is a  tutorial
+     found at
+     <ulink url="http://www.oaforum.org/tutorial/">
+      http://www.oaforum.org/tutorial/</ulink>.
+    </para>
+   </sect2>
+
   </sect1>
 
   
@@ -433,7 +491,7 @@ c)  Main "alvis" XSLT filter config file:
   and so on.
 
 - in db/ a cql2pqf.txt yaz-client config file 
-  which is also used in the yaz-server <ulink url="http://www.loc.gov/standards/sru/cql/">CQL</ulink>-to-PQF process
+  which is also used in the yaz-server <ulink url="&url.cql;">CQL</ulink>-to-PQF process
 
    see: http://www.indexdata.com/yaz/doc/tools.tkl#tools.cql.map