Remove claim that ts_headline knows how to generate multiple ellipsis-separated
authorTom Lane
Mon, 29 Oct 2007 01:55:11 +0000 (01:55 +0000)
committerTom Lane
Mon, 29 Oct 2007 01:55:11 +0000 (01:55 +0000)
excerpts of a document.  That's clearly desirable, but the functionality
is not there yet.

doc/src/sgml/textsearch.sgml

index 9cab9a4b46cdcb27b5587b28eb1d9651b39d1b44..9ed4b7435b7591c0e9e0b7bfb759306deff2d5e1 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
 
  Full Text Search
@@ -1040,7 +1040,7 @@ ORDER BY rank DESC LIMIT 10;
 
    
     ts_headline accepts a document along
-    with a query, and returns one or more ellipsis-separated excerpts from
+    with a query, and returns an excerpt from
     the document in which terms from the query are highlighted.  The
     configuration to be used to parse the document can be specified by
     config; if config
@@ -1094,24 +1094,27 @@ StartSel=<b>, StopSel=</b>, MaxWords=35, MinWords=15, ShortWord=3, H
     For example:
 
 
-SELECT ts_headline('ts_headline accepts a document along
-with a query, and returns one or more ellipsis-separated excerpts from
-the document in which terms from the query are highlighted.',
-  to_tsquery('ellipsis & term'));
-                            ts_headline                             
---------------------------------------------------------------------
- <b>ellipsis</b>-separated excerpts from
- the document in which <b>terms</b> from the query are highlighted.
-
-SELECT ts_headline('ts_headline accepts a document along
-with a query, and returns one or more ellipsis-separated excerpts from
-the document in which terms from the query are highlighted.',
-  to_tsquery('ellipsis & term'),
+SELECT ts_headline('The most common type of search
+is to find all documents containing given query terms 
+and return them in order of their similarity to the
+query.', to_tsquery('query & similarity'));
+                        ts_headline                         
+------------------------------------------------------------
+ given <b>query</b> terms
+ and return them in order of their <b>similarity</b> to the
+ <b>query</b>.
+
+SELECT ts_headline('The most common type of search
+is to find all documents containing given query terms
+and return them in order of their similarity to the
+query.',
+  to_tsquery('query & similarity'), 
   'StartSel = <, StopSel = >');
-                          ts_headline                          
----------------------------------------------------------------
- <ellipsis>-separated excerpts from
- the document in which <terms> from the query are highlighted.
+                      ts_headline                      
+-------------------------------------------------------
+ given <query> terms
+ and return them in order of their <similarity> to the
+ <query>.