From 99a01bfd1ece0adaa2d307ae00cfcc5de29e7a9c Mon Sep 17 00:00:00 2001
From: Bruce Momjian <bruce@momjian.us>
Date: Fri, 31 Aug 2007 04:52:29 +0000
Subject: [PATCH] In text search docs, properly use indexterm _zone_ only when
 we want an entire section, per Peter.

---
 doc/src/sgml/datatype.sgml   |  32 +++++------
 doc/src/sgml/func.sgml       | 100 +++++++++++++++++------------------
 doc/src/sgml/textsearch.sgml |  46 ++++++++--------
 3 files changed, 87 insertions(+), 91 deletions(-)

diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 4c8c0c56cac..67f96ce1f73 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.208 2007/08/29 20:37:14 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.209 2007/08/31 04:52:29 momjian Exp $ -->
 
  <chapter id="datatype">
   <title id="datatype-title">Data Types</title>
@@ -3281,20 +3281,18 @@ a0eebc999c0b4ef8bb6d6bb9bd380a11
 
    <variablelist>
 
-   <indexterm zone="datatype-textsearch">
-   <primary>tsvector</primary>
-   </indexterm>
-
     <varlistentry>
     <term><firstterm>tsvector</firstterm></term>
      <listitem>
 
       <para>
-       <type>tsvector</type> is a data type that represents a document and is
-       optimized for full text searching. In the simplest case,
-       <type>tsvector</type> is a sorted list of lexemes, so even without indexes
-       full text searches perform better than standard <literal>~</literal> and
-       <literal>LIKE</literal> operations:
+       <type>tsvector</type>
+       <indexterm><primary>tsvector</primary></indexterm> is a data type
+       that represents a document and is optimized for full text searching.
+       In the simplest case, <type>tsvector</type> is a sorted list of
+       lexemes, so even without indexes full text searches perform better
+       than standard <literal>~</literal> and <literal>LIKE</literal>
+       operations:
 
 <programlisting>
 SELECT 'a fat cat sat on a mat and ate a fat rat'::tsvector;
@@ -3355,19 +3353,17 @@ SELECT 'fat:1 rat:2'::tsvector || 'fat:1 cat:2'::tsvector;
 
     </varlistentry>
 
-    <indexterm zone="datatype-textsearch">
-    <primary>tsquery</primary>
-    </indexterm>
-
     <varlistentry>
     <term><firstterm>tsquery</firstterm></term>
      <listitem>
 
       <para>
-       <type>tsquery</type> is a data type for textual queries which supports
-       the boolean operators <literal>&amp;</literal> (AND), <literal>|</literal> (OR),
-       and parentheses.  A <type>tsquery</type> consists of lexemes
-       (optionally labeled by letters) with boolean operators in between:
+       <type>tsquery</type>
+       <indexterm><primary>tsquery</primary></indexterm> is a data type
+       for textual queries which supports the boolean operators
+       <literal>&amp;</literal> (AND), <literal>|</literal> (OR), and
+       parentheses.  A <type>tsquery</type> consists of lexemes (optionally
+       labeled by letters) with boolean operators in between:
 
 <programlisting>
 SELECT 'fat &amp; cat'::tsquery;
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 6e56fa4335f..d3f831e81b4 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.390 2007/08/29 21:51:45 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.391 2007/08/31 04:52:29 momjian Exp $ -->
 
  <chapter id="functions">
   <title>Functions and Operators</title>
@@ -7585,8 +7585,8 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-search-operator">
-     <primary>TSVECTOR @@ TSQUERY</primary>
+     <indexterm>
+      <primary>TSVECTOR @@ TSQUERY</primary>
      </indexterm>
 
      <term>
@@ -7620,8 +7620,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat'::tsvector @@ 'fat &amp; cow'::
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-search-operator">
-     <primary>TEXT @@ TSQUERY</primary>
+     <indexterm>
+      <primary>TEXT @@ TSQUERY</primary>
      </indexterm>
 
      <term>
@@ -7652,8 +7652,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat'::text @@ 'cat &amp; cow'::tsqu
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-search-operator">
-     <primary>TEXT @@ TEXT</primary>
+     <indexterm>
+      <primary>TEXT @@ TEXT</primary>
      </indexterm>
 
      <term>
@@ -7701,8 +7701,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>to_tsvector</primary>
+     <indexterm>
+      <primary>to_tsvector</primary>
      </indexterm>
 
      <term>
@@ -7723,8 +7723,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>strip</primary>
+     <indexterm>
+      <primary>strip</primary>
      </indexterm>
 
      <term>
@@ -7746,8 +7746,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>setweight</primary>
+     <indexterm>
+      <primary>setweight</primary>
      </indexterm>
 
      <term>
@@ -7771,8 +7771,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>tsvector concatenation</primary>
+     <indexterm>
+      <primary>tsvector concatenation</primary>
      </indexterm>
 
      <term>
@@ -7802,8 +7802,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
 
     <varlistentry>
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>length(tsvector)</primary>
+     <indexterm>
+      <primary>length(tsvector)</primary>
      </indexterm>
 
      <term>
@@ -7821,8 +7821,8 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>text::tsvector</primary>
+     <indexterm>
+      <primary>text::tsvector</primary>
      </indexterm>
 
      <term>
@@ -7846,9 +7846,9 @@ SELECT 'a fat cat sat on a mat and ate a fat rat' @@ 'cat cow';
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>trigger</primary>
-     <secondary>for updating a derived tsvector column</secondary>
+     <indexterm>
+      <primary>trigger</primary>
+      <secondary>for updating a derived tsvector column</secondary>
      </indexterm>
 
      <term>
@@ -7896,8 +7896,8 @@ tsvector_update_trigger(tsv, 'pg_catalog.english', strMessage);
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>ts_stat</primary>
+     <indexterm>
+      <primary>ts_stat</primary>
      </indexterm>
 
      <term>
@@ -7943,8 +7943,8 @@ LIMIT 10;
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsvector">
-     <primary>Btree operations for tsvector</primary>
+     <indexterm>
+      <primary>Btree operations for tsvector</primary>
      </indexterm>
 
      <term>
@@ -7979,8 +7979,8 @@ LIMIT 10;
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>to_tsquery</primary>
+     <indexterm>
+      <primary>to_tsquery</primary>
      </indexterm>
 
      <term>
@@ -8026,8 +8026,8 @@ SELECT to_tsquery('''supernovae stars'' &amp; !crab');
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>plainto_tsquery</primary>
+     <indexterm>
+      <primary>plainto_tsquery</primary>
      </indexterm>
 
      <term>
@@ -8051,8 +8051,8 @@ SELECT to_tsquery('''supernovae stars'' &amp; !crab');
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>querytree</primary>
+     <indexterm>
+      <primary>querytree</primary>
      </indexterm>
 
      <term>
@@ -8081,8 +8081,8 @@ SELECT querytree(to_tsquery('!defined'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>text::tsquery casting</primary>
+     <indexterm>
+      <primary>text::tsquery casting</primary>
      </indexterm>
 
      <term>
@@ -8107,8 +8107,8 @@ SELECT querytree(to_tsquery('!defined'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>numnode</primary>
+     <indexterm>
+      <primary>numnode</primary>
      </indexterm>
 
      <term>
@@ -8146,8 +8146,8 @@ SELECT numnode(plainto_tsquery('long table'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>TSQUERY &amp;&amp; TSQUERY</primary>
+     <indexterm>
+      <primary>TSQUERY &amp;&amp; TSQUERY</primary>
      </indexterm>
 
      <term>
@@ -8165,8 +8165,8 @@ SELECT numnode(plainto_tsquery('long table'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>TSQUERY || TSQUERY</primary>
+     <indexterm>
+      <primary>TSQUERY || TSQUERY</primary>
      </indexterm>
 
      <term>
@@ -8184,8 +8184,8 @@ SELECT numnode(plainto_tsquery('long table'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>!! TSQUERY</primary>
+     <indexterm>
+      <primary>!! TSQUERY</primary>
      </indexterm>
 
      <term>
@@ -8203,8 +8203,8 @@ SELECT numnode(plainto_tsquery('long table'));
 
     <varlistentry>
 
-     <indexterm zone="functions-textsearch-tsquery">
-     <primary>Btree operations for tsquery</primary>
+     <indexterm>
+      <primary>Btree operations for tsquery</primary>
      </indexterm>
 
      <term>
@@ -8257,8 +8257,8 @@ INSERT INTO aliases VALUES('a', 'c');
 
      <varlistentry>
 
-      <indexterm zone="functions-textsearch-tsquery">
-      <primary>ts_rewrite</primary>
+      <indexterm>
+       <primary>ts_rewrite</primary>
       </indexterm>
 
       <term>
@@ -8404,8 +8404,8 @@ WHERE 'a &amp; b' @> t;
  
      <varlistentry>
 
-      <indexterm zone="functions-textsearch-tsquery">
-      <primary>TSQUERY @&gt; TSQUERY</primary>
+      <indexterm>
+       <primary>TSQUERY @&gt; TSQUERY</primary>
       </indexterm>
 
       <term>
@@ -8423,8 +8423,8 @@ WHERE 'a &amp; b' @> t;
 
      <varlistentry>
 
-      <indexterm zone="functions-textsearch-tsquery">
-      <primary>tsquery &lt;@ tsquery</primary>
+      <indexterm>
+       <primary>tsquery &lt;@ tsquery</primary>
       </indexterm>
 
       <term>
diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml
index bfa83380854..18e6aa7c646 100644
--- a/doc/src/sgml/textsearch.sgml
+++ b/doc/src/sgml/textsearch.sgml
@@ -241,8 +241,8 @@ SELECT 'fat &amp; cow'::tsquery @@ 'a fat cat sat on a mat and ate a fat rat'::t
    <title>Configurations</title>
 
    <indexterm zone="textsearch-configurations">
-   <primary>text search</primary>
-   <secondary>configurations</secondary>
+    <primary>text search</primary>
+    <secondary>configurations</secondary>
    </indexterm>
 
    <para>
@@ -429,6 +429,11 @@ ORDER BY rank DESC LIMIT 10;
   <sect2 id="textsearch-parser">
    <title>Parsing</title>
 
+   <indexterm zone="textsearch-parser">
+    <primary>text search</primary>
+    <secondary>parse</secondary>
+   </indexterm>
+
    <para>
     Full text searching in <productname>PostgreSQL</productname> provides
     function <function>to_tsvector</function>, which converts a document to
@@ -544,11 +549,6 @@ UPDATE tt SET ti=
 
      <varlistentry>
 
-      <indexterm zone="textsearch-parser">
-      <primary>text search</primary>
-      <secondary>parse</secondary>
-      </indexterm>
-
       <term>
        <synopsis>
         ts_parse(<replaceable class="PARAMETER">parser</replaceable>,  <replaceable class="PARAMETER">document</replaceable> TEXT) returns SETOF <type>tokenout</type>
@@ -579,8 +579,8 @@ SELECT * FROM ts_parse('default','123 - a number');
 
      <varlistentry>
       <indexterm zone="textsearch-parser">
-      <primary>text search</primary>
-      <secondary>ts_token_type</secondary>
+       <primary>text search</primary>
+       <secondary>ts_token_type</secondary>
       </indexterm>
 
       <term>
@@ -667,8 +667,8 @@ SELECT * FROM ts_token_type('default');
      <varlistentry>
 
       <indexterm zone="textsearch-ranking">
-      <primary>text search</primary>
-      <secondary>ts_rank</secondary>
+       <primary>text search</primary>
+       <secondary>ts_rank</secondary>
       </indexterm>
 
       <term>
@@ -704,8 +704,8 @@ SELECT * FROM ts_token_type('default');
      <varlistentry>
 
       <indexterm zone="textsearch-ranking">
-      <primary>text search</primary>
-      <secondary>ts_rank_cd</secondary>
+       <primary>text search</primary>
+       <secondary>ts_rank_cd</secondary>
       </indexterm>
 
       <term>
@@ -855,8 +855,8 @@ ORDER BY rnk DESC LIMIT 10;
    <title>Highlighting Results</title>
 
    <indexterm zone="textsearch-headline">
-   <primary>text search</primary>
-   <secondary>headline</secondary>
+    <primary>text search</primary>
+    <secondary>headline</secondary>
    </indexterm>
 
    <para>
@@ -1576,8 +1576,8 @@ CREATE TEXT SEARCH DICTIONARY english_stem (
      <varlistentry>
 
       <indexterm zone="textsearch-dictionaries">
-      <primary>text search</primary>
-      <secondary>ts_lexize</secondary>
+       <primary>text search</primary>
+       <secondary>ts_lexize</secondary>
       </indexterm>
 
       <term>
@@ -1821,13 +1821,13 @@ SHOW default_text_search_config;
     <varlistentry>
 
      <indexterm zone="textsearch-indexes">
-     <primary>text search</primary>
-     <secondary>GiST</secondary>
+      <primary>text search</primary>
+      <secondary>GiST</secondary>
      </indexterm>
 
 <!--
      <indexterm zone="textsearch-indexes">
-     <primary>GiST</primary>
+      <primary>GiST</primary>
      </indexterm>
 -->
      <term>
@@ -1848,13 +1848,13 @@ SHOW default_text_search_config;
     <varlistentry>
 
      <indexterm zone="textsearch-indexes">
-     <primary>text search</primary>
-     <secondary>GIN</secondary>
+      <primary>text search</primary>
+      <secondary>GIN</secondary>
      </indexterm>
 
 <!--
      <indexterm zone="textsearch-indexes">
-     <primary>GIN</primary>
+      <primary>GIN</primary>
      </indexterm>
 -->
      <term>
-- 
GitLab