1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_search_excerpt">
<refmeta>
<refentrytitle>search_excerpt</refentrytitle>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>search_excerpt</refname>
<refpurpose>Returns excerpts with hit words from text</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_file_dirlist">
<funcprototype id="fproto_file_dirlist">
<funcdef><function>search_excerpt</function></funcdef>
<paramdef>in <parameter>hit_words</parameter> any</paramdef>
<paramdef>in <parameter>text</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>within_first</parameter> int</optional></paramdef>
<paramdef><optional>in <parameter>max_excerpt</parameter> int</optional></paramdef>
<paramdef><optional>in <parameter>total</parameter> int</optional></paramdef>
<paramdef><optional>in <parameter>html_hit_tag</parameter> varchar</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_file_dirlist"><title>Description</title>
<para>This function produces representative samples for use in displaying a query hit. There are two modes: html mode and text mode. In html mode everything looks like html tags is ignored and searching of excerpt begins from <body> tag. All found hit words highlighted by html_hit_tag.</para>
<para>In text mode text is treated as plain text, html tag detection is disabled and hit words is not highlighted. </para>
</refsect1>
<refsect1 id="params_file_dirlist"><title>Parameters</title>
<refsect2><title>hit_words</title>
<para>array of hit words to be found in text. Number of hit words can not be more than 10.</para></refsect2>
<refsect2><title>text</title>
<para>original text where hit words are searched</para>
</refsect2>
<refsect2><title>within_first</title>
<para>number of chars in text from the start to consider. Default value is 20000.</para>
</refsect2>
<refsect2><title>max_excerpt</title>
<para>maximum length of single excerpt phrase. Default value is 90.</para>
</refsect2>
<refsect2><title>total</title>
<para>maximum length of whole excerpt. Default value is 200.</para>
</refsect2>
<refsect2><title>html_hit_tag</title>
<para>HTML tag which is used to highlight hit words in excerpt. Default value is "b". If it is NULL text mode is used</para>
</refsect2>
</refsect1>
<refsect1 id="ret_file_dirlist"><title>Return Types</title><para>
varchar
</para>
</refsect1>
<refsect1 id="examples_search_excerpt">
<title>Examples</title>
<example id="ex_search_excerpt">
<title>Creating search excerpt</title>
<para>creates a search excerpt from found DAV resource</para>
<programlisting><![CDATA[
for select RES_CONTENT from WS.WS.SYS_DAV_RES
where contains (RES_CONTENT, 'place and knowledge')
do {
http_value (search_excerpt (vector ('place', 'knowledge'),
cast (RES_CONTENT as varchar),
200000, 90, 200, 'b', 1),
'P');
}
]]>
</programlisting>
</example>
</refsect1>
</refentry>
|
