Document dynamic rank
authorAdam Dickmeiss <adam@indexdata.dk>
Thu, 23 May 2013 13:10:55 +0000 (15:10 +0200)
committerAdam Dickmeiss <adam@indexdata.dk>
Thu, 23 May 2013 13:10:55 +0000 (15:10 +0200)
doc/pazpar2_conf.xml
doc/pazpar2_protocol.xml

index 57427ca..6989939 100644 (file)
          </varlistentry>
          
          <varlistentry>
-          <term>rank</term>
+          <term id="metadata-rank">rank</term>
           <listitem>
            <para>
             Specifies that this element is to be used to
index e227354..a6fcf26 100644 (file)
@@ -288,6 +288,47 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
        </para>
       </listitem>
      </varlistentry>
+
+     <varlistentry>
+      <term>mergekey</term>
+      <listitem>
+       <para>
+       Sets mergekey for this search and rest of session, or until
+       another mergekey is given for show/search. The mergekey value is a
+       comma separated list with one or more names as they appear
+       in the service description  equivalent to
+       <literal>mergekey="optional"</literal> inside a metadata element.
+       If the empty string is given for mergekey it is disabled
+       and rest of session will use the default mergekey from service
+       or stylesheet.
+       </para>
+       <para>
+       This facility, "dynamic mergekey", appeared in Pazpar2 version
+       1.6.31.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>rank</term>
+      <listitem>
+       <para>
+       Sets rank method this search and rest of session, or until
+       another rank is given for show/search. The rank value is a
+       comma separated list of pairs field=value pairs. The
+       format is the same as
+       <xref linkend="metadata-rank">rank</xref> for a metadata element.
+       If the empty string is given for rank it is disabled
+       and rest of session will use the default rank from metadata or
+       stylesheet.
+       </para>
+       <para>
+       This facility, "dynamic ranking", appeared in Pazpar2 version
+       1.6.31.
+       </para>
+      </listitem>
+     </varlistentry>
+
     </variablelist>
 
    </para>
@@ -390,26 +431,6 @@ search.pz2?session=2044502273&command=stat
      </varlistentry>
 
      <varlistentry>
-      <term>mergekey</term>
-      <listitem>
-       <para>
-       Sets mergekey for this search and rest of session, or until
-       another mergekey is given for show/search. The mergekey value is a
-       comma separated list with one or more names as they appear
-       in the service description  equivalent to
-       <literal>mergekey="optional"</literal> inside a metadata element.
-       If the empty string is given for mergekey it is disabled
-       and rest of session will use the default mergekey from service
-       or stylesheet.
-       </para>
-       <para>
-       This facility, "dynamic mergekey", appeared in Pazpar2 version
-       1.6.31.
-       </para>
-      </listitem>
-     </varlistentry>
-
-     <varlistentry>
       <term>sort</term>
       <listitem>
        <para>
@@ -459,6 +480,26 @@ search.pz2?session=2044502273&command=stat
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+      <term>rank</term>
+      <listitem>
+       <para>
+       Sets rank method this show and rest of session, or until
+       another rank is given for show/search. The rank value is a
+       comma separated list of pairs field=value pairs. The
+       format is the same as
+       <xref linkend="metadata-rank">rank</xref> for a metadata element.
+       If the empty string is given for rank it is disabled
+       and rest of session will use the default rank from metadata or
+       stylesheet.
+       </para>
+       <para>
+       This facility, "dynamic ranking", appeared in Pazpar2 version
+       1.6.31.
+       </para>
+      </listitem>
+     </varlistentry>
+
     </variablelist>
    </para>
    <para>