X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fadministration.xml;h=829ef7591505428863477952c443e459617edb76;hb=af90f7f836a48a8e4bf6d5c2fc15c7133bac06f3;hp=beba1663bf6b30735b2b021cecfb45a5ccace814;hpb=37dc985516f52f34fc8434cc8beb982bb0c8988f;p=idzebra-moved-to-github.git

diff --git a/doc/administration.xml b/doc/administration.xml
index beba166..829ef75 100644
--- a/doc/administration.xml
+++ b/doc/administration.xml
@@ -1,5 +1,5 @@
 <chapter id="administration">
- <!-- $Id: administration.xml,v 1.43 2006-09-03 21:37:26 adam Exp $ -->
+ <!-- $Id: administration.xml,v 1.48 2007-01-17 13:31:36 marc Exp $ -->
  <title>Administrating Zebra</title>
  <!-- ### It's a bit daft that this chapter (which describes half of
           the configuration-file formats) is separated from
@@ -281,20 +281,67 @@
       <para>
        Specifies a path of profile specification files. 
        The path is composed of one or more directories separated by
-       colon. Similar to PATH for UNIX systems.
+       colon. Similar to <literal>PATH</literal> for UNIX systems.
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+      <term>modulePath: <replaceable>path</replaceable></term>
+      <listitem>
+       <para>
+	Specifies a path of record filter modules.
+	The path is composed of one or more directories separated by
+	colon. Similar to <literal>PATH</literal> for UNIX systems.
+	The 'make install' procedure typically puts modules in
+	<filename>/usr/local/lib/idzebra-2.0/modules</filename>.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>staticrank: <replaceable>integer</replaceable></term>
+      <listitem>
+       <para>
+	Enables whether static ranking is to be enabled (1) or
+	disabled (0). If omitted, it is disabled - corresponding
+	to a value of 0.
+	Refer to <xref linkend="administration-ranking-static"/> .
+       </para>
+      </listitem>
+     </varlistentry>
+
+
+     <varlistentry>
+      <term>estimatehits:: <replaceable>integer</replaceable></term>
+      <listitem>
+       <para>
+	Controls whether Zebra should calculate approximite hit counts and
+	at which hit count it is to be enabled.
+	A value of 0 disables approximiate hit counts.
+	For a positive value approximaite hit count is enabled
+	if it is known to be larger than <replaceable>integer</replaceable>.
+       </para>
+       <para>
+	Approximate hit counts can also be triggered by a particular
+	attribute in a query.
+	Refer to <xref linkend="querymodel-zebra-global-attr-limit"/>.
+       </para>
+      </listitem>
+     </varlistentry>
+
     <varlistentry>
      <term>attset: <replaceable>filename</replaceable></term>
      <listitem>
       <para>
-       Specifies the filename(s) of attribute set files for use in
-       searching. At least the Bib-1 set should be loaded
-       (<literal>bib1.att</literal>).
-       The <literal>profilePath</literal> setting is used to look for
-       the specified files.
-       See <xref linkend="attset-files"/>
+	Specifies the filename(s) of attribute set files for use in
+	searching. In many configurations <filename>bib1.att</filename>
+	is used, but that is not required. If Classic Explain
+	attributes is to be used for searching,
+	<filename>explain.att</filename> must be given.
+	The path to att-files in general can be given using 
+	<literal>profilePath</literal> setting.
+	See also <xref linkend="attset-files"/>.
       </para>
      </listitem>
     </varlistentry>
@@ -374,7 +421,8 @@
        username, or Z39.50 anonymous style use
 	<literal>anonymous</literal>. The permstring consists of
        a sequence of characters. Include character <literal>w</literal>
-       for write/update access, <literal>r</literal> for read access.
+       for write/update access, <literal>r</literal> for read access and
+       <literal>a</literal> to allow anonymous access through this account.
       </para>
      </listitem>
     </varlistentry>
@@ -1483,6 +1531,8 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
     <screen>
      shadow: directoryname: size (e.g. 1000M)
     </screen>
+     See <xref linkend="zebra-cfg"/> for additional information on
+     these configuration options.
    </para>
    <note>
     <para>
@@ -1563,8 +1613,10 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
         <row>
          <entry><literal>recordIdNumber </literal></entry>
          <entry><literal>positive number</literal></entry>
-         <entry>Zebra's internal system number, only for update
-         actions.
+         <entry>Zebra's internal system number,
+         not allowed for  <literal>recordInsert</literal> or 
+         <literal>specialUpdate</literal> actions which result in fresh
+         record inserts.
         </entry>
         </row>
         <row>
@@ -1587,25 +1639,26 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
     <literal>recordDelete</literal> (will fail if the record does not
        exist), and
     <literal>specialUpdate</literal> (will insert or update the record
-       as needed).
+       as needed, record deletion is not possible).
    </para>
 
     <para>
-     During a  <literal>recordInsert</literal> action, the
+     During all actions, the
      usual rules for internal record ID generation apply, unless an
      optional <literal>recordIdNumber</literal> Zebra internal ID or a
     <literal>recordIdOpaque</literal> string identifier is assigned. 
      The default ID generation is
      configured using the <literal>recordId:</literal> from
-     <filename>zebra.cfg</filename>.     
+     <filename>zebra.cfg</filename>.  
+     See <xref linkend="zebra-cfg"/>.   
     </para>
 
    <para>
-    The actions <literal>recordReplace</literal> or
-    <literal>recordDelete</literal> need specification of the additional 
-    <literal>recordIdNumber</literal> parameter, which must be an
-    existing Zebra internal system ID number, or the optional 
-     <literal>recordIdOpaque</literal> string parameter.
+    Setting of the <literal>recordIdNumber</literal> parameter, 
+    which must be an existing Zebra internal system ID number, is not
+    allowed during any  <literal>recordInsert</literal> or 
+     <literal>specialUpdate</literal> action resulting in fresh record
+    inserts.
     </para>
 
     <para>
@@ -1616,11 +1669,16 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
     <literal>xmlns:id="http://www.indexdata.dk/zebra/"</literal>,
     where it can be picked up for later record updates or deletes. 
     </para>
+ 
     <para>
-     Records indexed with the <literal>alvis</literal> filter
-     have similar means to discover the internal Zebra ID.
+     A new element set for retrieval of internal record
+     data has been added, which can be used to access minimal records
+     containing only the <literal>recordIdNumber</literal> Zebra
+     internal ID, or the <literal>recordIdOpaque</literal> string
+     identifier. This works for any indexing filter used.
+     See <xref linkend="special-retrieval"/>.
     </para>
- 
+
    <para>
      The <literal>recordIdOpaque</literal> string parameter
      is an client-supplied, opaque record
@@ -1748,23 +1806,6 @@ where g = rset_count(terms[i]->rset) is the count of all documents in this speci
     </sect2>
  </sect1>
 
-
-  <sect1 id="gfs-config">
-   <title>YAZ Frontend Virtual Hosts</title>
-    <para>
-     <command>zebrasrv</command> uses the YAZ server frontend and does
-     support multiple virtual servers behind multiple listening sockets.
-    </para>
-    &zebrasrv-virtual;
- 
-   <para>
-    Section "Virtual Hosts" in the YAZ manual.
-    <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
-   </para>
- </sect1>
-
-
- 
 </chapter>
 
  <!-- Keep this comment at the end of the file