/usr/lib/x86_64-linux-gnu/perl5/5.24/Lucy/Highlight/Highlighter.pod is in liblucy-perl 0.3.3-7+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | # Auto-generated file -- DO NOT EDIT!!!!!
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
=head1 NAME
Lucy::Highlight::Highlighter - Create and highlight excerpts.
=head1 SYNOPSIS
my $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher,
query => $query,
field => 'body'
);
my $hits = $searcher->hits( query => $query );
while ( my $hit = $hits->next ) {
my $excerpt = $highlighter->create_excerpt($hit);
...
}
=head1 DESCRIPTION
The Highlighter can be used to select relevant snippets from a document,
and to surround search terms with highlighting tags. It handles both stems
and phrases correctly and efficiently, using special-purpose data generated
at index-time.
=head1 CONSTRUCTORS
=head2 new( I<[labeled params]> )
my $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher, # required
query => $query, # required
field => 'content', # required
excerpt_length => 150, # default: 200
);
=over
=item *
B<searcher> - An object which inherits from
L<Searcher|Lucy::Search::Searcher>, such as an
L<IndexSearcher|Lucy::Search::IndexSearcher>.
=item *
B<query> - Query object or a query string.
=item *
B<field> - The name of the field from which to draw the excerpt. The
field must marked as be C<highlightable> (see
L<FieldType|Lucy::Plan::FieldType>).
=item *
B<excerpt_length> - Maximum length of the excerpt, in characters.
=back
=head1 METHODS
=head2 create_excerpt(hit_doc)
Take a HitDoc object and return a highlighted excerpt as a string if
the HitDoc has a value for the specified C<< field >>.
=head2 highlight(text)
Highlight a small section of text. By default, prepends pre-tag and
appends post-tag. This method is called internally by create_excerpt()
when assembling an excerpt.
=head2 encode(text)
Encode text with HTML entities. This method is called internally by
create_excerpt() for each text fragment when assembling an excerpt. A
subclass can override this if the text should be encoded differently or
not at all.
=head2 set_pre_tag(pre_tag)
Setter. The default value is "<strong>".
=head2 get_pre_tag()
Accessor.
=head2 set_post_tag(post_tag)
Setter. The default value is "</strong>".
=head2 get_post_tag()
Accessor.
=head2 get_searcher()
Accessor.
=head2 get_query()
Accessor.
=head2 get_compiler()
Accessor for the Lucy::Search::Compiler object derived from
C<< query >> and C<< searcher >>.
=head2 get_excerpt_length()
Accessor.
=head2 get_field()
Accessor.
=head1 INHERITANCE
Lucy::Highlight::Highlighter isa L<Lucy::Object::Obj>.
=cut
|