Removed all mention of users from setting system.

[pazpar2-moved-to-github.git] / doc / pazpar2_conf.xml

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index b3a7068..3785042 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -8,7 +8,7 @@
      <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>
      <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>

-<!-- $Id: pazpar2_conf.xml,v 1.12 2007-04-03 03:59:10 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.18 2007-04-11 02:23:21 quinn Exp $ -->

 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>

@@ -121,9 +121,7 @@
            <para>
              This nested element controls the behavior of pazpar2 with
              respect to your data model. In pazpar2, incoming records are
            <para>
              This nested element controls the behavior of pazpar2 with
              respect to your data model. In pazpar2, incoming records are

-             normalized, using XSLT, into an internal representation (see
-             the <link
-             linkend="config-retrievalprofile">retrievalprofile</link> secion.
+             normalized, using XSLT, into an internal representation.

              The 'service' section controls the further processing and
              extraction of data from the internal representation, primarily
              through the 'metdata' sub-element.
              The 'service' section controls the further processing and
              extraction of data from the internal representation, primarily
              through the 'metdata' sub-element.

@@ -244,91 +242,6 @@
       </variablelist>           <!-- Data elements in server directive -->
     </refsect2>
 
       </variablelist>           <!-- Data elements in server directive -->
     </refsect2>
 

-    <refsect2 id="config-queryprofile"><title>queryprofile</title>
-      <para>
-        At the moment, this directive is ignored; there is one global
-       CCL-mapping file which governs the mapping of queries to Z39.50
-       type-1. This file is located in etc/default.bib. This will change
-       shortly.
-      </para>
-    </refsect2>
-
-    <refsect2 id="config_retrievalprofile"><title>retrievalprofile</title>
-      <para>
-       Note: In the present version, there is a single retrieval
-       profile. However, in a future release, it will be possible to
-       associate unique retrieval profiles with different targets, or to
-       generate retrieval profiles using XSLT from the ZeeRex description of
-       a target.
-      </para>
-      
-      <para>
-        The following data elements are recognized for the retrievalprofile
-       directive:
-      </para>
-      
-      <variablelist>
-        <varlistentry><term>requestsyntax</term>
-         <listitem>
-           <para>
-             This element specifies the request syntax to be used in queries. It only
-             makes sense for Z39.50-type targets.
-           </para>
-         </listitem>
-       </varlistentry>
-
-       <varlistentry><term>nativesyntax</term>
-         <listitem>
-           <para>
-             This element specifies the native syntax and encoding of the
-             result records. The default is XML. The following attributes
-             are defined:
-           </para>
-           <variablelist>
-             <varlistentry><term>name</term>
-               <listitem>
-                 <para>
-                   The name of the syntax. Currently recognized values are
-                   'iso2709' (MARC), and 'xml'.
-                 </para>
-               </listitem>
-             </varlistentry>
-
-             <varlistentry><term>format</term>
-               <listitem>
-                 <para>
-                   The format, or schema, to be expected. Default is
-                   'marc21'.
-                 </para>
-               </listitem>
-             </varlistentry>
-
-             <varlistentry><term>encoding</term>
-               <listitem>
-                 <para>
-                   The encoding of the response record. Typical values for
-                   MARC records are 'marc8' (general MARC-8), 'marc8s'
-                   (MARC-8, but maps to precomposed UTF-8 characters, more
-                   suitable for use in web browsers), 'latin1'.
-                 </para>
-               </listitem>
-             </varlistentry>
-
-             <varlistentry><term>mapto</term>
-               <listitem>
-                 <para>
-                   Specifies the flavor of MARCXML to map results to.
-                   Default is 'marcxml'. 'marcxchange' is also possible, and
-                   useful for Danish DANMARC records.
-                 </para>
-               </listitem>
-             </varlistentry>
-           </variablelist> <!-- parameters to nativesyntax directive -->
-         </listitem>
-       </varlistentry>
-      </variablelist> <!-- sub-elements in retrievalprofile -->
-    </refsect2>
-

   </refsect1>
  
  <refsect1><title>EXAMPLE</title>
   </refsect1>
  
  <refsect1><title>EXAMPLE</title>

@@ -356,15 +269,6 @@
   </service>
 </server>
 
   </service>
 </server>
 

-<queryprofile/>  <!-- Like a CCL profile++ . Can optionally refer to XSLT to 
-       convert ZeeRex into queryprofile. Multiple profiles can exist.  -->
-
-<retrievalprofile>
-  <requestsyntax>marc21</requestsyntax>
-  <nativesyntax name="iso2709" format="marc21" encoding="marc8s" mapto="marcxml"/>
-  <map type="xslt" stylesheet="marc21.xsl"/>
-</retrievalprofile>
-

 </pazpar2>
 ]]></screen>
    </para>
 </pazpar2>
 ]]></screen>
    </para>

@@ -381,8 +285,8 @@
      search against a given target, or it can associate arbitrary name=value
      pairs with groups of targets -- for instance, if you would like to
      place all commercial full-text bases in one group for selection
      search against a given target, or it can associate arbitrary name=value
      pairs with groups of targets -- for instance, if you would like to
      place all commercial full-text bases in one group for selection

-     purposes, or you would like to control what targets are accessible to a
-     given user.
+     purposes, or you would like to control what targets are accessible
+     to users by default.

    </para>
 
    <para>
    </para>
 
    <para>

@@ -426,17 +330,6 @@
            </para>
         </listitem>
        </varlistentry>
            </para>
         </listitem>
        </varlistentry>

-       <varlistentry>
-         <term>user</term>
-        <listitem>
-          <para>
-            This specifies the user ID to which this setting applies. A
-            given setting may have values for any number of users, or it
-            may have a 'default' value which is applied when no user is
-            specified, or when no user-specific value is available.
-           </para>
-         </listitem>
-       </varlistentry>

        <varlistentry>
          <term>name</term>
          <listitem>
        <varlistentry>
          <term>name</term>
          <listitem>

@@ -475,7 +368,7 @@
       </variablelist>
 
       <para>
       </variablelist>
 
       <para>

-        By setting defaults for user, target, name, or value in the root
+        By setting defaults for target, name, or value in the root

        settings node, you can use the settings files in many different
        ways. For instance, you can use a single file to set defaults for
        many different settings, like search fields, retrieval syntaxes,
        settings node, you can use the settings files in many different
        ways. For instance, you can use a single file to set defaults for
        many different settings, like search fields, retrieval syntaxes,

@@ -513,11 +406,12 @@
          </listitem>
        </varlistentry>
        <varlistentry>
          </listitem>
        </varlistentry>
        <varlistentry>

-         <term>pz:syntax</term>
+         <term>pz:requestsyntax</term>

          <listitem>
            <para>
              This specifies the record syntax to use when requesting
          <listitem>
            <para>
              This specifies the record syntax to use when requesting

-             records from a given server.
+             records from a given server. The value can be a symbolic name like
+             marc21 or xml, or it can be a Z39.50-style dot-separated OID.

            </para>
          </listitem>
        </varlistentry>
            </para>
          </listitem>
        </varlistentry>

@@ -543,6 +437,65 @@
            </para>
          </listitem>
        </varlistentry>
            </para>
          </listitem>
        </varlistentry>

+       <varlistentry>
+         <term>pz:nativesyntax</term>
+         <listitem>
+           <para>
+             The representation of the retrieval records. Currently
+             recognized values are iso2709 and xml.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:encoding</term>
+         <listitem>
+           <para>
+             The native encoding of retrieval records. Can be anything
+             recognized by conv, but typical values are marc8 and latin1.
+             The default is UTF-8.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:xslt</term>
+         <listitem>
+           <para>
+             Provides the path of an XSLT stylesheet which will be used to
+             map incoming records to the internal representation.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:authentication</term>
+         <listitem>
+           <para>
+             Sets an authentication string for a given server. See the section on
+             authorization and authentication for discussion.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:allow</term>
+         <listitem>
+           <para>
+             Allows or denies access to the resources it is applied to. Possible
+             values are '0' and '1'. The default is '1' (allow access to this resource).
+             See the manual section on authorization and authentication for discussion
+             about how to use this setting.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:id</term>
+         <listitem>
+           <para>
+             This setting can't be 'set' -- it contains the ID (normally
+             ZURL) for a given target, and is useful for filtering --
+             specifically when you want to select one or more specific
+             targets in the search command.
+           </para>
+         </listitem>
+       </varlistentry>

       </variablelist>
     </refsect2>
 
       </variablelist>
     </refsect2>