You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/02/26 14:44:49 UTC
svn commit: r981214 [3/6] - in /websites/staging/lucy/trunk/content: ./
docs/test/ docs/test/Lucy/ docs/test/Lucy/Analysis/ docs/test/Lucy/Docs/
docs/test/Lucy/Docs/Cookbook/ docs/test/Lucy/Docs/Tutorial/
docs/test/Lucy/Document/ docs/test/Lucy/Highlig...
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Docs/Tutorial/SimpleTutorial.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Docs/Tutorial/SimpleTutorial.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Docs/Tutorial/SimpleTutorial.html Fri Feb 26 13:44:48 2016
@@ -87,7 +87,7 @@ name="Setup"
<p>Copy the text presentation of the US Constitution from the <code>sample</code> directory of the Apache Lucy distribution to the base level of your web server’s <code>htdocs</code> directory.</p>
-<pre> $ cp -R sample/us_constitution /usr/local/apache2/htdocs/</pre>
+<pre>$ cp -R sample/us_constitution /usr/local/apache2/htdocs/</pre>
<h3><a class='u'
name="Indexing:_indexer.pl"
@@ -97,262 +97,276 @@ name="Indexing:_indexer.pl"
<p>After we specify some configuration variables and load all necessary modules…</p>
-<pre> #!/usr/local/bin/perl
- use strict;
- use warnings;
-
- # (Change configuration variables as needed.)
- my $path_to_index = '/path/to/index';
- my $uscon_source = '/usr/local/apache2/htdocs/us_constitution';
+<pre>#!/usr/local/bin/perl
+use strict;
+use warnings;
+
+# (Change configuration variables as needed.)
+my $path_to_index = '/path/to/index';
+my $uscon_source = '/usr/local/apache2/htdocs/us_constitution';
- use Lucy::Simple;
- use File::Spec::Functions qw( catfile );</pre>
+use Lucy::Simple;
+use File::Spec::Functions qw( catfile );</pre>
<p>… we’ll start by creating a <a href="../../../Lucy/Simple.html" class="podlinkpod"
->Lucy::Simple</a> object, telling it where we’d like the index to be located and the language of the source material.</p>
+>Lucy::Simple</a> object,
+telling it where we’d like the index to be located and the language of the source material.</p>
-<pre> my $lucy = Lucy::Simple->new(
- path => $path_to_index,
- language => 'en',
- );</pre>
-
-<p>Next, we’ll add a subroutine which parses our sample documents.</p>
-
-<pre> # Parse a file from our US Constitution collection and return a hashref with
- # the fields title, body, and url.
- sub parse_file {
- my $filename = shift;
- my $filepath = catfile( $uscon_source, $filename );
- open( my $fh, '<', $filepath ) or die "Can't open '$filepath': $!";
- my $text = do { local $/; <$fh> }; # slurp file content
- $text =~ /\A(.+?)^\s+(.*)/ms
- or die "Can't extract title/bodytext from '$filepath'";
- my $title = $1;
- my $bodytext = $2;
- return {
- title => $title,
- content => $bodytext,
- url => "/us_constitution/$filename",
- };
- }</pre>
+<pre>my $lucy = Lucy::Simple->new(
+ path => $path_to_index,
+ language => 'en',
+);</pre>
+
+<p>Next,
+we’ll add a subroutine which parses our sample documents.</p>
+
+<pre># Parse a file from our US Constitution collection and return a hashref with
+# the fields title, body, and url.
+sub parse_file {
+ my $filename = shift;
+ my $filepath = catfile( $uscon_source, $filename );
+ open( my $fh, '<', $filepath ) or die "Can't open '$filepath': $!";
+ my $text = do { local $/; <$fh> }; # slurp file content
+ $text =~ /\A(.+?)^\s+(.*)/ms
+ or die "Can't extract title/bodytext from '$filepath'";
+ my $title = $1;
+ my $bodytext = $2;
+ return {
+ title => $title,
+ content => $bodytext,
+ url => "/us_constitution/$filename",
+ };
+}</pre>
<p>Add some elementary directory reading code…</p>
-<pre> # Collect names of source files.
- opendir( my $dh, $uscon_source )
- or die "Couldn't opendir '$uscon_source': $!";
- my @filenames = grep { $_ =~ /\.txt/ } readdir $dh;</pre>
+<pre># Collect names of source files.
+opendir( my $dh, $uscon_source )
+ or die "Couldn't opendir '$uscon_source': $!";
+my @filenames = grep { $_ =~ /\.txt/ } readdir $dh;</pre>
<p>… and now we’re ready for the meat of indexer.pl – which occupies exactly one line of code.</p>
-<pre> foreach my $filename (@filenames) {
- my $doc = parse_file($filename);
- $lucy->add_doc($doc); # ta-da!
- }</pre>
+<pre>foreach my $filename (@filenames) {
+ my $doc = parse_file($filename);
+ $lucy->add_doc($doc); # ta-da!
+}</pre>
<h3><a class='u'
name="Search:_search.cgi"
>Search: search.cgi</a></h3>
-<p>As with our indexing app, the bulk of the code in our search script won’t be Lucy-specific.</p>
+<p>As with our indexing app,
+the bulk of the code in our search script won’t be Lucy-specific.</p>
<p>The beginning is dedicated to CGI processing and configuration.</p>
-<pre> #!/usr/local/bin/perl -T
- use strict;
- use warnings;
-
- # (Change configuration variables as needed.)
- my $path_to_index = '/path/to/index';
-
- use CGI;
- use List::Util qw( max min );
- use POSIX qw( ceil );
- use Encode qw( decode );
- use Lucy::Simple;
-
- my $cgi = CGI->new;
- my $q = decode( "UTF-8", $cgi->param('q') || '' );
- my $offset = decode( "UTF-8", $cgi->param('offset') || 0 );
- my $page_size = 10;</pre>
-
-<p>Once that’s out of the way, we create our Lucy::Simple object and feed it a query string.</p>
-
-<pre> my $lucy = Lucy::Simple->new(
- path => $path_to_index,
- language => 'en',
- );
- my $hit_count = $lucy->search(
- query => $q,
- offset => $offset,
- num_wanted => $page_size,
- );</pre>
+<pre>#!/usr/local/bin/perl -T
+use strict;
+use warnings;
+
+# (Change configuration variables as needed.)
+my $path_to_index = '/path/to/index';
+
+use CGI;
+use List::Util qw( max min );
+use POSIX qw( ceil );
+use Encode qw( decode );
+use Lucy::Simple;
+
+my $cgi = CGI->new;
+my $q = decode( "UTF-8", $cgi->param('q') || '' );
+my $offset = decode( "UTF-8", $cgi->param('offset') || 0 );
+my $page_size = 10;</pre>
+
+<p>Once that’s out of the way,
+we create our Lucy::Simple object and feed it a query string.</p>
+
+<pre>my $lucy = Lucy::Simple->new(
+ path => $path_to_index,
+ language => 'en',
+);
+my $hit_count = $lucy->search(
+ query => $q,
+ offset => $offset,
+ num_wanted => $page_size,
+);</pre>
<p>The value returned by <a href="../../../Lucy/Simple.html#search" class="podlinkpod"
->search()</a> is the total number of documents in the collection which matched the query. We’ll show this hit count to the user, and also use it in conjunction with the parameters <code>offset</code> and <code>num_wanted</code> to break up results into “pages” of manageable size.</p>
+>search()</a> is the total number of documents in the collection which matched the query.
+We’ll show this hit count to the user,
+and also use it in conjunction with the parameters <code>offset</code> and <code>num_wanted</code> to break up results into “pages” of manageable size.</p>
<p>Calling <a href="../../../Lucy/Simple.html#search" class="podlinkpod"
->search()</a> on our Simple object turns it into an iterator. Invoking <a href="../../../Lucy/Simple.html#next" class="podlinkpod"
+>search()</a> on our Simple object turns it into an iterator.
+Invoking <a href="../../../Lucy/Simple.html#next" class="podlinkpod"
>next()</a> now returns hits one at a time as <a href="../../../Lucy/Document/HitDoc.html" class="podlinkpod"
->HitDoc</a> objects, starting with the most relevant.</p>
+>HitDoc</a> objects,
+starting with the most relevant.</p>
-<pre> # Create result list.
- my $report = '';
- while ( my $hit = $lucy->next ) {
- my $score = sprintf( "%0.3f", $hit->get_score );
- $report .= qq|
+<pre># Create result list.
+my $report = '';
+while ( my $hit = $lucy->next ) {
+ my $score = sprintf( "%0.3f", $hit->get_score );
+ $report .= qq|
+ <p>
+ <a href="$hit->{url}"><strong>$hit->{title}</strong></a>
+ <em>$score</em>
+ <br>
+ <span class="excerptURL">$hit->{url}</span>
+ </p>
+ |;
+}</pre>
+
+<p>The rest of the script is just text wrangling.</p>
+
+<pre>#---------------------------------------------------------------#
+# No tutorial material below this point - just html generation. #
+#---------------------------------------------------------------#
+
+# Generate paging links and hit count, print and exit.
+my $paging_links = generate_paging_info( $q, $hit_count );
+blast_out_content( $q, $report, $paging_links );
+
+# Create html fragment with links for paging through results n-at-a-time.
+sub generate_paging_info {
+ my ( $query_string, $total_hits ) = @_;
+ my $escaped_q = CGI::escapeHTML($query_string);
+ my $paging_info;
+ if ( !length $query_string ) {
+ # No query? No display.
+ $paging_info = '';
+ }
+ elsif ( $total_hits == 0 ) {
+ # Alert the user that their search failed.
+ $paging_info
+ = qq|<p>No matches for <strong>$escaped_q</strong></p>|;
+ }
+ else {
+ # Calculate the nums for the first and last hit to display.
+ my $last_result = min( ( $offset + $page_size ), $total_hits );
+ my $first_result = min( ( $offset + 1 ), $last_result );
+
+ # Display the result nums, start paging info.
+ $paging_info = qq|
<p>
- <a href="$hit->{url}"><strong>$hit->{title}</strong></a>
- <em>$score</em>
- <br>
- <span class="excerptURL">$hit->{url}</span>
+ Results <strong>$first_result-$last_result</strong>
+ of <strong>$total_hits</strong>
+ for <strong>$escaped_q</strong>.
</p>
+ <p>
+ Results Page:
|;
- }</pre>
-
-<p>The rest of the script is just text wrangling.</p>
-<pre> #---------------------------------------------------------------#
- # No tutorial material below this point - just html generation. #
- #---------------------------------------------------------------#
-
- # Generate paging links and hit count, print and exit.
- my $paging_links = generate_paging_info( $q, $hit_count );
- blast_out_content( $q, $report, $paging_links );
-
- # Create html fragment with links for paging through results n-at-a-time.
- sub generate_paging_info {
- my ( $query_string, $total_hits ) = @_;
- my $escaped_q = CGI::escapeHTML($query_string);
- my $paging_info;
- if ( !length $query_string ) {
- # No query? No display.
- $paging_info = '';
- }
- elsif ( $total_hits == 0 ) {
- # Alert the user that their search failed.
- $paging_info
- = qq|<p>No matches for <strong>$escaped_q</strong></p>|;
+ # Calculate first and last hits pages to display / link to.
+ my $current_page = int( $first_result / $page_size ) + 1;
+ my $last_page = ceil( $total_hits / $page_size );
+ my $first_page = max( 1, ( $current_page - 9 ) );
+ $last_page = min( $last_page, ( $current_page + 10 ) );
+
+ # Create a url for use in paging links.
+ my $href = $cgi->url( -relative => 1 );
+ $href .= "?q=" . CGI::escape($query_string);
+ $href .= ";offset=" . CGI::escape($offset);
+
+ # Generate the "Prev" link.
+ if ( $current_page > 1 ) {
+ my $new_offset = ( $current_page - 2 ) * $page_size;
+ $href =~ s/(?<=offset=)\d+/$new_offset/;
+ $paging_info .= qq|<a href="$href">&lt;= Prev</a>\n|;
}
- else {
- # Calculate the nums for the first and last hit to display.
- my $last_result = min( ( $offset + $page_size ), $total_hits );
- my $first_result = min( ( $offset + 1 ), $last_result );
-
- # Display the result nums, start paging info.
- $paging_info = qq|
- <p>
- Results <strong>$first_result-$last_result</strong>
- of <strong>$total_hits</strong>
- for <strong>$escaped_q</strong>.
- </p>
- <p>
- Results Page:
- |;
-
- # Calculate first and last hits pages to display / link to.
- my $current_page = int( $first_result / $page_size ) + 1;
- my $last_page = ceil( $total_hits / $page_size );
- my $first_page = max( 1, ( $current_page - 9 ) );
- $last_page = min( $last_page, ( $current_page + 10 ) );
-
- # Create a url for use in paging links.
- my $href = $cgi->url( -relative => 1 );
- $href .= "?q=" . CGI::escape($query_string);
- $href .= ";offset=" . CGI::escape($offset);
-
- # Generate the "Prev" link.
- if ( $current_page > 1 ) {
- my $new_offset = ( $current_page - 2 ) * $page_size;
- $href =~ s/(?<=offset=)\d+/$new_offset/;
- $paging_info .= qq|<a href="$href">&lt;= Prev</a>\n|;
- }
- # Generate paging links.
- for my $page_num ( $first_page .. $last_page ) {
- if ( $page_num == $current_page ) {
- $paging_info .= qq|$page_num \n|;
- }
- else {
- my $new_offset = ( $page_num - 1 ) * $page_size;
- $href =~ s/(?<=offset=)\d+/$new_offset/;
- $paging_info .= qq|<a href="$href">$page_num</a>\n|;
- }
+ # Generate paging links.
+ for my $page_num ( $first_page .. $last_page ) {
+ if ( $page_num == $current_page ) {
+ $paging_info .= qq|$page_num \n|;
}
-
- # Generate the "Next" link.
- if ( $current_page != $last_page ) {
- my $new_offset = $current_page * $page_size;
+ else {
+ my $new_offset = ( $page_num - 1 ) * $page_size;
$href =~ s/(?<=offset=)\d+/$new_offset/;
- $paging_info .= qq|<a href="$href">Next =&gt;</a>\n|;
+ $paging_info .= qq|<a href="$href">$page_num</a>\n|;
}
+ }
- # Close tag.
- $paging_info .= "</p>\n";
+ # Generate the "Next" link.
+ if ( $current_page != $last_page ) {
+ my $new_offset = $current_page * $page_size;
+ $href =~ s/(?<=offset=)\d+/$new_offset/;
+ $paging_info .= qq|<a href="$href">Next =&gt;</a>\n|;
}
- return $paging_info;
+ # Close tag.
+ $paging_info .= "</p>\n";
}
- # Print content to output.
- sub blast_out_content {
- my ( $query_string, $hit_list, $paging_info ) = @_;
- my $escaped_q = CGI::escapeHTML($query_string);
- binmode( STDOUT, ":encoding(UTF-8)" );
- print qq|Content-type: text/html; charset=UTF-8\n\n|;
- print qq|
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <meta http-equiv="Content-type"
- content="text/html;charset=UTF-8">
- <link rel="stylesheet" type="text/css"
- href="/us_constitution/uscon.css">
- <title>Lucy: $escaped_q</title>
- </head>
-
- <body>
-
- <div id="navigation">
- <form id="usconSearch" action="">
- <strong>
- Search the
- <a href="/us_constitution/index.html">US Constitution</a>:
- </strong>
- <input type="text" name="q" id="q" value="$escaped_q">
- <input type="submit" value="=&gt;">
- </form>
- </div><!--navigation-->
-
- <div id="bodytext">
-
- $hit_list
-
- $paging_info
-
- <p style="font-size: smaller; color: #666">
- <em>
- Powered by <a href="http://lucy.apache.org/"
- >Apache Lucy<small><sup>TM</sup></small></a>
- </em>
- </p>
- </div><!--bodytext-->
-
- </body>
+ return $paging_info;
+}
- </html>
- |;
- }</pre>
+# Print content to output.
+sub blast_out_content {
+ my ( $query_string, $hit_list, $paging_info ) = @_;
+ my $escaped_q = CGI::escapeHTML($query_string);
+ binmode( STDOUT, ":encoding(UTF-8)" );
+ print qq|Content-type: text/html; charset=UTF-8\n\n|;
+ print qq|
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+ "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+ <meta http-equiv="Content-type"
+ content="text/html;charset=UTF-8">
+ <link rel="stylesheet" type="text/css"
+ href="/us_constitution/uscon.css">
+ <title>Lucy: $escaped_q</title>
+</head>
+
+<body>
+
+ <div id="navigation">
+ <form id="usconSearch" action="">
+ <strong>
+ Search the
+ <a href="/us_constitution/index.html">US Constitution</a>:
+ </strong>
+ <input type="text" name="q" id="q" value="$escaped_q">
+ <input type="submit" value="=&gt;">
+ </form>
+ </div><!--navigation-->
+
+ <div id="bodytext">
+
+ $hit_list
+
+ $paging_info
+
+ <p style="font-size: smaller; color: #666">
+ <em>
+ Powered by <a href="http://lucy.apache.org/"
+ >Apache Lucy<small><sup>TM</sup></small></a>
+ </em>
+ </p>
+ </div><!--bodytext-->
+
+</body>
+
+</html>
+|;
+}</pre>
<h3><a class='u'
name="OK(8230)_now_what?"
>OK… now what?</a></h3>
-<p>Lucy::Simple is perfectly adequate for some tasks, but it’s not very flexible. Many people find that it doesn’t do at least one or two things they can’t live without.</p>
-
-<p>In our next tutorial chapter, <a href="../../../Lucy/Docs/Tutorial/BeyondSimpleTutorial.html" class="podlinkpod"
->BeyondSimpleTutorial</a>, we’ll rewrite our indexing and search scripts using the classes that Lucy::Simple hides from view, opening up the possibilities for expansion; then, we’ll spend the rest of the tutorial chapters exploring these possibilities.</p>
+<p>Lucy::Simple is perfectly adequate for some tasks,
+but it’s not very flexible.
+Many people find that it doesn’t do at least one or two things they can’t live without.</p>
+
+<p>In our next tutorial chapter,
+<a href="../../../Lucy/Docs/Tutorial/BeyondSimpleTutorial.html" class="podlinkpod"
+>BeyondSimpleTutorial</a>,
+we’ll rewrite our indexing and search scripts using the classes that Lucy::Simple hides from view,
+opening up the possibilities for expansion; then,
+we’ll spend the rest of the tutorial chapters exploring these possibilities.</p>
</div>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Document/Doc.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Document/Doc.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Document/Doc.html Fri Feb 26 13:44:48 2016
@@ -81,21 +81,23 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $doc = Lucy::Document::Doc->new(
- fields => { foo => 'foo foo', bar => 'bar bar' },
- );
- $indexer->add_doc($doc);</pre>
+<pre>my $doc = Lucy::Document::Doc->new(
+ fields => { foo => 'foo foo', bar => 'bar bar' },
+);
+$indexer->add_doc($doc);</pre>
<p>Doc objects allow access to field values via hashref overloading:</p>
-<pre> $doc->{foo} = 'new value for field "foo"';
- print "foo: $doc->{foo}\n";</pre>
+<pre>$doc->{foo} = 'new value for field "foo"';
+print "foo: $doc->{foo}\n";</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>A Doc object is akin to a row in a database, in that it is made up of one or more fields, each of which has a value.</p>
+<p>A Doc object is akin to a row in a database,
+in that it is made up of one or more fields,
+each of which has a value.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -105,16 +107,17 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $doc = Lucy::Document::Doc->new(
- fields => { foo => 'foo foo', bar => 'bar bar' },
- );</pre>
+<pre>my $doc = Lucy::Document::Doc->new(
+ fields => { foo => 'foo foo', bar => 'bar bar' },
+);</pre>
<p>Create a new Document.</p>
<ul>
<li><b>fields</b> - Field-value pairs.</li>
-<li><b>doc_id</b> - Internal Lucy document id. Default of 0 (an invalid doc id).</li>
+<li><b>doc_id</b> - Internal Lucy document id.
+Default of 0 (an invalid doc id).</li>
</ul>
<h2><a class='u'
@@ -125,7 +128,7 @@ name="METHODS"
name="set_doc_id"
>set_doc_id</a></h3>
-<pre> $doc->set_doc_id($doc_id);</pre>
+<pre>$doc->set_doc_id($doc_id);</pre>
<p>Set internal Lucy document id.</p>
@@ -133,7 +136,7 @@ name="set_doc_id"
name="get_doc_id"
>get_doc_id</a></h3>
-<pre> my $retval = $doc->get_doc_id();</pre>
+<pre>my $retval = $doc->get_doc_id();</pre>
<p>Retrieve internal Lucy document id.</p>
@@ -141,7 +144,7 @@ name="get_doc_id"
name="store"
>store</a></h3>
-<pre> $doc->store($field, $value);</pre>
+<pre>$doc->store($field, $value);</pre>
<p>Store a field value in the Doc.</p>
@@ -155,7 +158,7 @@ name="store"
name="get_fields"
>get_fields</a></h3>
-<pre> my $retval = $doc->get_fields();</pre>
+<pre>my $retval = $doc->get_fields();</pre>
<p>Return the Doc’s backing fields hash.</p>
@@ -163,7 +166,7 @@ name="get_fields"
name="get_size"
>get_size</a></h3>
-<pre> my $retval = $doc->get_size();</pre>
+<pre>my $retval = $doc->get_size();</pre>
<p>Return the number of fields in the Doc.</p>
@@ -171,15 +174,16 @@ name="get_size"
name="extract"
>extract</a></h3>
-<pre> my $retval = $doc->extract($field);</pre>
+<pre>my $retval = $doc->extract($field);</pre>
-<p>Retrieve the field’s value, or NULL if the field is not present.</p>
+<p>Retrieve the field’s value,
+or NULL if the field is not present.</p>
<h3><a class='u'
name="field_names"
>field_names</a></h3>
-<pre> my $retval = $doc->field_names();</pre>
+<pre>my $retval = $doc->field_names();</pre>
<p>Return a list of names of all fields present.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Document/HitDoc.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Document/HitDoc.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Document/HitDoc.html Fri Feb 26 13:44:48 2016
@@ -81,11 +81,11 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> while ( my $hit_doc = $hits->next ) {
- print "$hit_doc->{title}\n";
- print $hit_doc->get_score . "\n";
- ...
- }</pre>
+<pre>while ( my $hit_doc = $hits->next ) {
+ print "$hit_doc->{title}\n";
+ print $hit_doc->get_score . "\n";
+ ...
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -101,7 +101,7 @@ name="METHODS"
name="set_score"
>set_score</a></h3>
-<pre> $hit_doc->set_score($score);</pre>
+<pre>$hit_doc->set_score($score);</pre>
<p>Set score attribute.</p>
@@ -109,7 +109,7 @@ name="set_score"
name="get_score"
>get_score</a></h3>
-<pre> my $retval = $hit_doc->get_score();</pre>
+<pre>my $retval = $hit_doc->get_score();</pre>
<p>Get score attribute.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html Fri Feb 26 13:44:48 2016
@@ -81,22 +81,25 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> 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);
- ...
- }</pre>
+<pre>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);
+ ...
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>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.</p>
+<p>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.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -106,26 +109,29 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $highlighter = Lucy::Highlight::Highlighter->new(
- searcher => $searcher, # required
- query => $query, # required
- field => 'content', # required
- excerpt_length => 150, # default: 200
- );</pre>
+<pre>my $highlighter = Lucy::Highlight::Highlighter->new(
+ searcher => $searcher, # required
+ query => $query, # required
+ field => 'content', # required
+ excerpt_length => 150, # default: 200
+);</pre>
<p>Create a new Highlighter.</p>
<ul>
<li><b>searcher</b> - An object which inherits from <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
->Searcher</a>, such as an <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+>Searcher</a>,
+such as an <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a>.</li>
<li><b>query</b> - Query object or a query string.</li>
-<li><b>field</b> - The name of the field from which to draw the excerpt. The field must marked as be <code>highlightable</code> (see <a href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
+<li><b>field</b> - The name of the field from which to draw the excerpt.
+The field must marked as be <code>highlightable</code> (see <a href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
>FieldType</a>).</li>
-<li><b>excerpt_length</b> - Maximum length of the excerpt, in characters.</li>
+<li><b>excerpt_length</b> - Maximum length of the excerpt,
+in characters.</li>
</ul>
<h2><a class='u'
@@ -136,7 +142,7 @@ name="METHODS"
name="create_excerpt"
>create_excerpt</a></h3>
-<pre> my $retval = $highlighter->create_excerpt($hit_doc);</pre>
+<pre>my $retval = $highlighter->create_excerpt($hit_doc);</pre>
<p>Take a HitDoc object and return a highlighted excerpt as a string if the HitDoc has a value for the specified <code>field</code>.</p>
@@ -144,41 +150,48 @@ name="create_excerpt"
name="encode"
>encode</a></h3>
-<pre> my $retval = $highlighter->encode($text);</pre>
+<pre>my $retval = $highlighter->encode($text);</pre>
-<p>Encode text with HTML entities. This method is called internally by <a href="#create_excerpt" class="podlinkpod"
->create_excerpt()</a> for each text fragment when assembling an excerpt. A subclass can override this if the text should be encoded differently or not at all.</p>
+<p>Encode text with HTML entities.
+This method is called internally by <a href="#create_excerpt" class="podlinkpod"
+>create_excerpt()</a> for each text fragment when assembling an excerpt.
+A subclass can override this if the text should be encoded differently or not at all.</p>
<h3><a class='u'
name="highlight"
>highlight</a></h3>
-<pre> my $retval = $highlighter->highlight($text);</pre>
+<pre>my $retval = $highlighter->highlight($text);</pre>
-<p>Highlight a small section of text. By default, prepends pre-tag and appends post-tag. This method is called internally by <a href="#create_excerpt" class="podlinkpod"
+<p>Highlight a small section of text.
+By default,
+prepends pre-tag and appends post-tag.
+This method is called internally by <a href="#create_excerpt" class="podlinkpod"
>create_excerpt()</a> when assembling an excerpt.</p>
<h3><a class='u'
name="set_pre_tag"
>set_pre_tag</a></h3>
-<pre> $highlighter->set_pre_tag($pre_tag);</pre>
+<pre>$highlighter->set_pre_tag($pre_tag);</pre>
-<p>Setter. The default value is “<strong>”.</p>
+<p>Setter.
+The default value is “<strong>”.</p>
<h3><a class='u'
name="set_post_tag"
>set_post_tag</a></h3>
-<pre> $highlighter->set_post_tag($post_tag);</pre>
+<pre>$highlighter->set_post_tag($post_tag);</pre>
-<p>Setter. The default value is “</strong>”.</p>
+<p>Setter.
+The default value is “</strong>”.</p>
<h3><a class='u'
name="get_pre_tag"
>get_pre_tag</a></h3>
-<pre> my $retval = $highlighter->get_pre_tag();</pre>
+<pre>my $retval = $highlighter->get_pre_tag();</pre>
<p>Accessor.</p>
@@ -186,7 +199,7 @@ name="get_pre_tag"
name="get_post_tag"
>get_post_tag</a></h3>
-<pre> my $retval = $highlighter->get_post_tag();</pre>
+<pre>my $retval = $highlighter->get_post_tag();</pre>
<p>Accessor.</p>
@@ -194,7 +207,7 @@ name="get_post_tag"
name="get_field"
>get_field</a></h3>
-<pre> my $retval = $highlighter->get_field();</pre>
+<pre>my $retval = $highlighter->get_field();</pre>
<p>Accessor.</p>
@@ -202,7 +215,7 @@ name="get_field"
name="get_excerpt_length"
>get_excerpt_length</a></h3>
-<pre> my $retval = $highlighter->get_excerpt_length();</pre>
+<pre>my $retval = $highlighter->get_excerpt_length();</pre>
<p>Accessor.</p>
@@ -210,7 +223,7 @@ name="get_excerpt_length"
name="get_searcher"
>get_searcher</a></h3>
-<pre> my $retval = $highlighter->get_searcher();</pre>
+<pre>my $retval = $highlighter->get_searcher();</pre>
<p>Accessor.</p>
@@ -218,7 +231,7 @@ name="get_searcher"
name="get_query"
>get_query</a></h3>
-<pre> my $retval = $highlighter->get_query();</pre>
+<pre>my $retval = $highlighter->get_query();</pre>
<p>Accessor.</p>
@@ -226,7 +239,7 @@ name="get_query"
name="get_compiler"
>get_compiler</a></h3>
-<pre> my $retval = $highlighter->get_compiler();</pre>
+<pre>my $retval = $highlighter->get_compiler();</pre>
<p>Accessor for the Lucy::Search::Compiler object derived from <code>query</code> and <code>searcher</code>.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html Fri Feb 26 13:44:48 2016
@@ -81,20 +81,23 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $bg_merger = Lucy::Index::BackgroundMerger->new(
- index => '/path/to/index',
- );
- $bg_merger->commit;</pre>
+<pre>my $bg_merger = Lucy::Index::BackgroundMerger->new(
+ index => '/path/to/index',
+);
+$bg_merger->commit;</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>Adding documents to an index is usually fast, but every once in a while the index must be compacted and an update takes substantially longer to complete. See <a href="../../Lucy/Docs/Cookbook/FastUpdates.html" class="podlinkpod"
+<p>Adding documents to an index is usually fast,
+but every once in a while the index must be compacted and an update takes substantially longer to complete.
+See <a href="../../Lucy/Docs/Cookbook/FastUpdates.html" class="podlinkpod"
>FastUpdates</a> for how to use this class to control worst-case index update performance.</p>
<p>As with <a href="../../Lucy/Index/Indexer.html" class="podlinkpod"
->Indexer</a>, see <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
+>Indexer</a>,
+see <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
>FileLocking</a> if your index is on a shared volume.</p>
<h2><a class='u'
@@ -105,17 +108,19 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $bg_merger = Lucy::Index::BackgroundMerger->new(
- index => '/path/to/index', # required
- manager => $manager # default: created internally
- );</pre>
+<pre>my $bg_merger = Lucy::Index::BackgroundMerger->new(
+ index => '/path/to/index', # required
+ manager => $manager # default: created internally
+);</pre>
<p>Open a new BackgroundMerger.</p>
<ul>
<li><b>index</b> - Either a string filepath or a Folder.</li>
-<li><b>manager</b> - An IndexManager. If not supplied, an IndexManager with a 10-second write lock timeout will be created.</li>
+<li><b>manager</b> - An IndexManager.
+If not supplied,
+an IndexManager with a 10-second write lock timeout will be created.</li>
</ul>
<h2><a class='u'
@@ -126,17 +131,21 @@ name="METHODS"
name="optimize"
>optimize</a></h3>
-<pre> $background_merger->optimize();</pre>
+<pre>$background_merger->optimize();</pre>
-<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
+<p>Optimize the index for search-time performance.
+This may take a while,
+as it can involve rewriting large amounts of data.</p>
<h3><a class='u'
name="commit"
>commit</a></h3>
-<pre> $background_merger->commit();</pre>
+<pre>$background_merger->commit();</pre>
-<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
+<p>Commit any changes made to the index.
+Until this is called,
+none of the changes made during an indexing session are permanent.</p>
<p>Calls <a href="#prepare_commit" class="podlinkpod"
>prepare_commit()</a> implicitly if it has not already been called.</p>
@@ -145,14 +154,17 @@ name="commit"
name="prepare_commit"
>prepare_commit</a></h3>
-<pre> $background_merger->prepare_commit();</pre>
+<pre>$background_merger->prepare_commit();</pre>
<p>Perform the expensive setup for <a href="#commit" class="podlinkpod"
->commit()</a> in advance, so that <a href="#commit" class="podlinkpod"
+>commit()</a> in advance,
+so that <a href="#commit" class="podlinkpod"
>commit()</a> completes quickly.</p>
<p>Towards the end of <a href="#prepare_commit" class="podlinkpod"
->prepare_commit()</a>, the BackgroundMerger attempts to re-acquire the write lock, which is then held until <a href="#commit" class="podlinkpod"
+>prepare_commit()</a>,
+the BackgroundMerger attempts to re-acquire the write lock,
+which is then held until <a href="#commit" class="podlinkpod"
>commit()</a> finishes and releases it.</p>
<h2><a class='u'
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html Fri Feb 26 13:44:48 2016
@@ -81,14 +81,15 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Abstract base class.</pre>
+<pre># Abstract base class.</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
<p>DataReader is the companion class to <a href="../../Lucy/Index/DataWriter.html" class="podlinkpod"
->DataWriter</a>. Every index component will implement one of each.</p>
+>DataWriter</a>.
+Every index component will implement one of each.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -98,13 +99,13 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $reader = MyDataReader->new(
- schema => $seg_reader->get_schema, # default undef
- folder => $seg_reader->get_folder, # default undef
- snapshot => $seg_reader->get_snapshot, # default undef
- segments => $seg_reader->get_segments, # default undef
- seg_tick => $seg_reader->get_seg_tick, # default -1
- );</pre>
+<pre>my $reader = MyDataReader->new(
+ schema => $seg_reader->get_schema, # default undef
+ folder => $seg_reader->get_folder, # default undef
+ snapshot => $seg_reader->get_snapshot, # default undef
+ segments => $seg_reader->get_segments, # default undef
+ seg_tick => $seg_reader->get_seg_tick, # default -1
+);</pre>
<p>Abstract constructor.</p>
@@ -117,7 +118,9 @@ name="new"
<li><b>segments</b> - An array of Segments.</li>
-<li><b>seg_tick</b> - The array index of the Segment object within the <code>segments</code> array that this particular DataReader is assigned to, if any. A value of -1 indicates that no Segment should be assigned.</li>
+<li><b>seg_tick</b> - The array index of the Segment object within the <code>segments</code> array that this particular DataReader is assigned to,
+if any.
+A value of -1 indicates that no Segment should be assigned.</li>
</ul>
<h2><a class='u'
@@ -128,12 +131,13 @@ name="ABSTRACT_METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre> my $retval = $data_reader->aggregator(
- readers => $readers # required
- offsets => $offsets # required
- );</pre>
+<pre>my $retval = $data_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+);</pre>
-<p>Create a reader which aggregates the output of several lower level readers. Return undef if such a reader is not valid.</p>
+<p>Create a reader which aggregates the output of several lower level readers.
+Return undef if such a reader is not valid.</p>
<ul>
<li><b>readers</b> - An array of DataReaders.</li>
@@ -149,7 +153,7 @@ name="METHODS"
name="get_schema"
>get_schema</a></h3>
-<pre> my $retval = $data_reader->get_schema();</pre>
+<pre>my $retval = $data_reader->get_schema();</pre>
<p>Accessor for “schema” member var.</p>
@@ -157,7 +161,7 @@ name="get_schema"
name="get_folder"
>get_folder</a></h3>
-<pre> my $retval = $data_reader->get_folder();</pre>
+<pre>my $retval = $data_reader->get_folder();</pre>
<p>Accessor for “folder” member var.</p>
@@ -165,7 +169,7 @@ name="get_folder"
name="get_snapshot"
>get_snapshot</a></h3>
-<pre> my $retval = $data_reader->get_snapshot();</pre>
+<pre>my $retval = $data_reader->get_snapshot();</pre>
<p>Accessor for “snapshot” member var.</p>
@@ -173,7 +177,7 @@ name="get_snapshot"
name="get_segments"
>get_segments</a></h3>
-<pre> my $retval = $data_reader->get_segments();</pre>
+<pre>my $retval = $data_reader->get_segments();</pre>
<p>Accessor for “segments” member var.</p>
@@ -181,7 +185,7 @@ name="get_segments"
name="get_segment"
>get_segment</a></h3>
-<pre> my $retval = $data_reader->get_segment();</pre>
+<pre>my $retval = $data_reader->get_segment();</pre>
<p>Accessor for “segment” member var.</p>
@@ -189,7 +193,7 @@ name="get_segment"
name="get_seg_tick"
>get_seg_tick</a></h3>
-<pre> my $retval = $data_reader->get_seg_tick();</pre>
+<pre>my $retval = $data_reader->get_seg_tick();</pre>
<p>Accessor for “seg_tick” member var.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html Fri Feb 26 13:44:48 2016
@@ -81,13 +81,19 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Abstract base class.</pre>
+<pre># Abstract base class.</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>DataWriter is an abstract base class for writing index data, generally in segment-sized chunks. Each component of an index – e.g. stored fields, lexicon, postings, deletions – is represented by a DataWriter/<a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
+<p>DataWriter is an abstract base class for writing index data,
+generally in segment-sized chunks.
+Each component of an index – e.g.
+stored fields,
+lexicon,
+postings,
+deletions – is represented by a DataWriter/<a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>DataReader</a> pair.</p>
<p>Components may be specified per index by subclassing <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
@@ -101,11 +107,11 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $writer = MyDataWriter->new(
- snapshot => $snapshot, # required
- segment => $segment, # required
- polyreader => $polyreader, # required
- );</pre>
+<pre>my $writer = MyDataWriter->new(
+ snapshot => $snapshot, # required
+ segment => $segment, # required
+ polyreader => $polyreader, # required
+);</pre>
<p>Abstract constructor.</p>
@@ -114,7 +120,9 @@ name="new"
<li><b>segment</b> - The Segment in progress.</li>
-<li><b>polyreader</b> - A PolyReader representing all existing data in the index. (If the index is brand new, the PolyReader will have no sub-readers).</li>
+<li><b>polyreader</b> - A PolyReader representing all existing data in the index.
+(If the index is brand new,
+the PolyReader will have no sub-readers).</li>
</ul>
<h2><a class='u'
@@ -125,34 +133,40 @@ name="ABSTRACT_METHODS"
name="add_segment"
>add_segment</a></h3>
-<pre> $data_writer->add_segment(
- reader => $reader # required
- doc_map => $doc_map # default: undef
- );</pre>
+<pre>$data_writer->add_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+);</pre>
<p>Add content from an existing segment into the one currently being written.</p>
<ul>
<li><b>reader</b> - The SegReader containing content to add.</li>
-<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
+<li><b>doc_map</b> - An array of integers mapping old document ids to new.
+Deleted documents are mapped to 0,
+indicating that they should be skipped.</li>
</ul>
<h3><a class='u'
name="finish"
>finish</a></h3>
-<pre> $data_writer->finish();</pre>
+<pre>$data_writer->finish();</pre>
-<p>Complete the segment: close all streams, store metadata, etc.</p>
+<p>Complete the segment: close all streams,
+store metadata,
+etc.</p>
<h3><a class='u'
name="format"
>format</a></h3>
-<pre> my $retval = $data_writer->format();</pre>
+<pre>my $retval = $data_writer->format();</pre>
-<p>Every writer must specify a file format revision number, which should increment each time the format changes. Responsibility for revision checking is left to the companion DataReader.</p>
+<p>Every writer must specify a file format revision number,
+which should increment each time the format changes.
+Responsibility for revision checking is left to the companion DataReader.</p>
<h2><a class='u'
name="METHODS"
@@ -162,22 +176,26 @@ name="METHODS"
name="delete_segment"
>delete_segment</a></h3>
-<pre> $data_writer->delete_segment($reader);</pre>
+<pre>$data_writer->delete_segment($reader);</pre>
-<p>Remove a segment’s data. The default implementation is a no-op, as all files within the segment directory will be automatically deleted. Subclasses which manage their own files outside of the segment system should override this method and use it as a trigger for cleaning up obsolete data.</p>
+<p>Remove a segment’s data.
+The default implementation is a no-op,
+as all files within the segment directory will be automatically deleted.
+Subclasses which manage their own files outside of the segment system should override this method and use it as a trigger for cleaning up obsolete data.</p>
<ul>
-<li><b>reader</b> - The SegReader containing content to merge, which must represent a segment which is part of the the current snapshot.</li>
+<li><b>reader</b> - The SegReader containing content to merge,
+which must represent a segment which is part of the the current snapshot.</li>
</ul>
<h3><a class='u'
name="merge_segment"
>merge_segment</a></h3>
-<pre> $data_writer->merge_segment(
- reader => $reader # required
- doc_map => $doc_map # default: undef
- );</pre>
+<pre>$data_writer->merge_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+);</pre>
<p>Move content from an existing segment into the one currently being written.</p>
@@ -186,24 +204,28 @@ name="merge_segment"
>delete_segment()</a>.</p>
<ul>
-<li><b>reader</b> - The SegReader containing content to merge, which must represent a segment which is part of the the current snapshot.</li>
+<li><b>reader</b> - The SegReader containing content to merge,
+which must represent a segment which is part of the the current snapshot.</li>
-<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
+<li><b>doc_map</b> - An array of integers mapping old document ids to new.
+Deleted documents are mapped to 0,
+indicating that they should be skipped.</li>
</ul>
<h3><a class='u'
name="metadata"
>metadata</a></h3>
-<pre> my $retval = $data_writer->metadata();</pre>
+<pre>my $retval = $data_writer->metadata();</pre>
-<p>Arbitrary metadata to be serialized and stored by the Segment. The default implementation supplies a Hash with a single key-value pair for “format”.</p>
+<p>Arbitrary metadata to be serialized and stored by the Segment.
+The default implementation supplies a Hash with a single key-value pair for “format”.</p>
<h3><a class='u'
name="get_snapshot"
>get_snapshot</a></h3>
-<pre> my $retval = $data_writer->get_snapshot();</pre>
+<pre>my $retval = $data_writer->get_snapshot();</pre>
<p>Accessor for “snapshot” member var.</p>
@@ -211,7 +233,7 @@ name="get_snapshot"
name="get_segment"
>get_segment</a></h3>
-<pre> my $retval = $data_writer->get_segment();</pre>
+<pre>my $retval = $data_writer->get_segment();</pre>
<p>Accessor for “segment” member var.</p>
@@ -219,7 +241,7 @@ name="get_segment"
name="get_polyreader"
>get_polyreader</a></h3>
-<pre> my $retval = $data_writer->get_polyreader();</pre>
+<pre>my $retval = $data_writer->get_polyreader();</pre>
<p>Accessor for “polyreader” member var.</p>
@@ -227,7 +249,7 @@ name="get_polyreader"
name="get_schema"
>get_schema</a></h3>
-<pre> my $retval = $data_writer->get_schema();</pre>
+<pre>my $retval = $data_writer->get_schema();</pre>
<p>Accessor for “schema” member var.</p>
@@ -235,7 +257,7 @@ name="get_schema"
name="get_folder"
>get_folder</a></h3>
-<pre> my $retval = $data_writer->get_folder();</pre>
+<pre>my $retval = $data_writer->get_folder();</pre>
<p>Accessor for “folder” member var.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html Fri Feb 26 13:44:48 2016
@@ -81,12 +81,12 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $polyreader = $del_writer->get_polyreader;
- my $seg_readers = $polyreader->seg_readers;
- for my $seg_reader (@$seg_readers) {
- my $count = $del_writer->seg_del_count( $seg_reader->get_seg_name );
- ...
- }</pre>
+<pre>my $polyreader = $del_writer->get_polyreader;
+my $seg_readers = $polyreader->seg_readers;
+for my $seg_reader (@$seg_readers) {
+ my $count = $del_writer->seg_del_count( $seg_reader->get_seg_name );
+ ...
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -94,7 +94,11 @@ name="DESCRIPTION"
<p>Subclasses of DeletionsWriter provide a low-level mechanism for declaring a document deleted from an index.</p>
-<p>Because files in an index are never modified, and because it is not practical to delete entire segments, a DeletionsWriter does not actually remove documents from the index. Instead, it communicates to a search-time companion DeletionsReader which documents are deleted in such a way that it can create a Matcher iterator.</p>
+<p>Because files in an index are never modified,
+and because it is not practical to delete entire segments,
+a DeletionsWriter does not actually remove documents from the index.
+Instead,
+it communicates to a search-time companion DeletionsReader which documents are deleted in such a way that it can create a Matcher iterator.</p>
<p>Documents are truly deleted only when the segments which contain them are merged into new ones.</p>
@@ -106,24 +110,28 @@ name="ABSTRACT_METHODS"
name="delete_by_term"
>delete_by_term</a></h3>
-<pre> $deletions_writer->delete_by_term(
- field => $field # required
- term => $term # required
- );</pre>
+<pre>$deletions_writer->delete_by_term(
+ field => $field # required
+ term => $term # required
+);</pre>
<p>Delete all documents in the index that index the supplied term.</p>
<ul>
-<li><b>field</b> - The name of an indexed field. (If it is not spec’d as <code>indexed</code>, an error will occur.)</li>
-
-<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
+<li><b>field</b> - The name of an indexed field.
+(If it is not spec’d as <code>indexed</code>,
+an error will occur.)</li>
+
+<li><b>term</b> - The term which identifies docs to be marked as deleted.
+If <code>field</code> is associated with an Analyzer,
+<code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
</ul>
<h3><a class='u'
name="delete_by_query"
>delete_by_query</a></h3>
-<pre> $deletions_writer->delete_by_query($query);</pre>
+<pre>$deletions_writer->delete_by_query($query);</pre>
<p>Delete all documents in the index that match <code>query</code>.</p>
@@ -136,7 +144,7 @@ name="delete_by_query"
name="updated"
>updated</a></h3>
-<pre> my $retval = $deletions_writer->updated();</pre>
+<pre>my $retval = $deletions_writer->updated();</pre>
<p>Returns true if there are updates that need to be written.</p>
@@ -144,7 +152,7 @@ name="updated"
name="seg_del_count"
>seg_del_count</a></h3>
-<pre> my $retval = $deletions_writer->seg_del_count($seg_name);</pre>
+<pre>my $retval = $deletions_writer->seg_del_count($seg_name);</pre>
<p>Return the number of deletions for a given segment.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html Fri Feb 26 13:44:48 2016
@@ -81,14 +81,15 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
- my $doc = $doc_reader->fetch_doc($doc_id);</pre>
+<pre>my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
+my $doc = $doc_reader->fetch_doc($doc_id);</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>DocReader defines the interface by which documents (with all stored fields) are retrieved from the index. The default implementation returns <a href="../../Lucy/Document/HitDoc.html" class="podlinkpod"
+<p>DocReader defines the interface by which documents (with all stored fields) are retrieved from the index.
+The default implementation returns <a href="../../Lucy/Document/HitDoc.html" class="podlinkpod"
>HitDoc</a> objects.</p>
<h2><a class='u'
@@ -99,7 +100,7 @@ name="ABSTRACT_METHODS"
name="fetch_doc"
>fetch_doc</a></h3>
-<pre> my $retval = $doc_reader->fetch_doc($doc_id);</pre>
+<pre>my $retval = $doc_reader->fetch_doc($doc_id);</pre>
<p>Retrieve the document identified by <code>doc_id</code>.</p>
@@ -113,10 +114,10 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre> my $retval = $doc_reader->aggregator(
- readers => $readers # required
- offsets => $offsets # required
- );</pre>
+<pre>my $retval = $doc_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+);</pre>
<p>Returns a DocReader which divvies up requests to its sub-readers according to the offset range.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html Fri Feb 26 13:44:48 2016
@@ -83,30 +83,33 @@ and file deletion.</p>
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> use Sys::Hostname qw( hostname );
- my $hostname = hostname() or die "Can't get unique hostname";
- my $manager = Lucy::Index::IndexManager->new(
- host => $hostname,
- );
-
- # Index time:
- my $indexer = Lucy::Index::Indexer->new(
- index => '/path/to/index',
- manager => $manager,
- );
-
- # Search time:
- my $reader = Lucy::Index::IndexReader->open(
- index => '/path/to/index',
- manager => $manager,
- );
- my $searcher = Lucy::Search::IndexSearcher->new( index => $reader );</pre>
+<pre>use Sys::Hostname qw( hostname );
+my $hostname = hostname() or die "Can't get unique hostname";
+my $manager = Lucy::Index::IndexManager->new(
+ host => $hostname,
+);
+
+# Index time:
+my $indexer = Lucy::Index::Indexer->new(
+ index => '/path/to/index',
+ manager => $manager,
+);
+
+# Search time:
+my $reader = Lucy::Index::IndexReader->open(
+ index => '/path/to/index',
+ manager => $manager,
+);
+my $searcher = Lucy::Search::IndexSearcher->new( index => $reader );</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>IndexManager is an advanced-use class for controlling index locking, updating, merging, and deletion behaviors.</p>
+<p>IndexManager is an advanced-use class for controlling index locking,
+updating,
+merging,
+and deletion behaviors.</p>
<p>IndexManager and <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a> are complementary classes: Architecture is used to define traits and behaviors which cannot change for the life of an index; IndexManager is used for defining rules which may change from process to process.</p>
@@ -119,9 +122,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $manager = Lucy::Index::IndexManager->new(
- host => $hostname, # default: ""
- );</pre>
+<pre>my $manager = Lucy::Index::IndexManager->new(
+ host => $hostname, # default: ""
+);</pre>
<p>Create a new IndexManager.</p>
@@ -139,16 +142,18 @@ name="METHODS"
name="set_folder"
>set_folder</a></h3>
-<pre> $index_manager->set_folder($folder);
- $index_manager->set_folder(); # default: undef</pre>
+<pre>$index_manager->set_folder($folder);
+$index_manager->set_folder(); # default: undef</pre>
-<p>Setter for <code>folder</code> member. Typical clients (Indexer, IndexReader) will use this method to install their own Folder instance.</p>
+<p>Setter for <code>folder</code> member.
+Typical clients (Indexer,
+IndexReader) will use this method to install their own Folder instance.</p>
<h3><a class='u'
name="get_folder"
>get_folder</a></h3>
-<pre> my $retval = $index_manager->get_folder();</pre>
+<pre>my $retval = $index_manager->get_folder();</pre>
<p>Getter for <code>folder</code> member.</p>
@@ -156,7 +161,7 @@ name="get_folder"
name="get_host"
>get_host</a></h3>
-<pre> my $retval = $index_manager->get_host();</pre>
+<pre>my $retval = $index_manager->get_host();</pre>
<p>Getter for <code>host</code> member.</p>
@@ -164,14 +169,16 @@ name="get_host"
name="recycle"
>recycle</a></h3>
-<pre> my $retval = $index_manager->recycle(
- reader => $reader # required
- del_writer => $del_writer # required
- cutoff => $cutoff # required
- optimize => $optimize # default: false
- );</pre>
-
-<p>Return an array of SegReaders representing segments that should be consolidated. Implementations must balance index-time churn against search-time degradation due to segment proliferation. The default implementation prefers small segments or segments with a high proportion of deletions.</p>
+<pre>my $retval = $index_manager->recycle(
+ reader => $reader # required
+ del_writer => $del_writer # required
+ cutoff => $cutoff # required
+ optimize => $optimize # default: false
+);</pre>
+
+<p>Return an array of SegReaders representing segments that should be consolidated.
+Implementations must balance index-time churn against search-time degradation due to segment proliferation.
+The default implementation prefers small segments or segments with a high proportion of deletions.</p>
<ul>
<li><b>reader</b> - A PolyReader.</li>
@@ -187,7 +194,7 @@ name="recycle"
name="make_write_lock"
>make_write_lock</a></h3>
-<pre> my $retval = $index_manager->make_write_lock();</pre>
+<pre>my $retval = $index_manager->make_write_lock();</pre>
<p>Create the Lock which controls access to modifying the logical content of the index.</p>
@@ -195,15 +202,16 @@ name="make_write_lock"
name="set_write_lock_timeout"
>set_write_lock_timeout</a></h3>
-<pre> $index_manager->set_write_lock_timeout($timeout);</pre>
+<pre>$index_manager->set_write_lock_timeout($timeout);</pre>
-<p>Setter for write lock timeout. Default: 1000 milliseconds.</p>
+<p>Setter for write lock timeout.
+Default: 1000 milliseconds.</p>
<h3><a class='u'
name="get_write_lock_timeout"
>get_write_lock_timeout</a></h3>
-<pre> my $retval = $index_manager->get_write_lock_timeout();</pre>
+<pre>my $retval = $index_manager->get_write_lock_timeout();</pre>
<p>Getter for write lock timeout.</p>
@@ -211,15 +219,16 @@ name="get_write_lock_timeout"
name="set_write_lock_interval"
>set_write_lock_interval</a></h3>
-<pre> $index_manager->set_write_lock_interval($timeout);</pre>
+<pre>$index_manager->set_write_lock_interval($timeout);</pre>
-<p>Setter for write lock retry interval. Default: 100 milliseconds.</p>
+<p>Setter for write lock retry interval.
+Default: 100 milliseconds.</p>
<h3><a class='u'
name="get_write_lock_interval"
>get_write_lock_interval</a></h3>
-<pre> my $retval = $index_manager->get_write_lock_interval();</pre>
+<pre>my $retval = $index_manager->get_write_lock_interval();</pre>
<p>Getter for write lock retry interval.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html Fri Feb 26 13:44:48 2016
@@ -81,20 +81,20 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $reader = Lucy::Index::IndexReader->open(
- index => '/path/to/index',
- );
- my $seg_readers = $reader->seg_readers;
- for my $seg_reader (@$seg_readers) {
- my $seg_name = $seg_reader->get_segment->get_name;
- my $num_docs = $seg_reader->doc_max;
- print "Segment $seg_name ($num_docs documents):\n";
- my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
- for my $doc_id ( 1 .. $num_docs ) {
- my $doc = $doc_reader->fetch_doc($doc_id);
- print " $doc_id: $doc->{title}\n";
- }
- }</pre>
+<pre>my $reader = Lucy::Index::IndexReader->open(
+ index => '/path/to/index',
+);
+my $seg_readers = $reader->seg_readers;
+for my $seg_reader (@$seg_readers) {
+ my $seg_name = $seg_reader->get_segment->get_name;
+ my $num_docs = $seg_reader->doc_max;
+ print "Segment $seg_name ($num_docs documents):\n";
+ my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
+ for my $doc_id ( 1 .. $num_docs ) {
+ my $doc = $doc_reader->fetch_doc($doc_id);
+ print " $doc_id: $doc->{title}\n";
+ }
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -103,12 +103,16 @@ name="DESCRIPTION"
<p>IndexReader is the interface through which <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a> objects access the content of an index.</p>
-<p>IndexReader objects always represent a point-in-time view of an index as it existed at the moment the reader was created. If you want search results to reflect modifications to an index, you must create a new IndexReader after the update process completes.</p>
+<p>IndexReader objects always represent a point-in-time view of an index as it existed at the moment the reader was created.
+If you want search results to reflect modifications to an index,
+you must create a new IndexReader after the update process completes.</p>
<p>IndexReaders are composites; most of the work is done by individual <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
->DataReader</a> sub-components, which may be accessed via <a href="#fetch" class="podlinkpod"
+>DataReader</a> sub-components,
+which may be accessed via <a href="#fetch" class="podlinkpod"
>fetch()</a> and <a href="#obtain" class="podlinkpod"
->obtain()</a>. The most efficient and powerful access to index data happens at the segment level via <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
+>obtain()</a>.
+The most efficient and powerful access to index data happens at the segment level via <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
>SegReader</a>’s sub-components.</p>
<h2><a class='u'
@@ -119,21 +123,25 @@ name="CONSTRUCTORS"
name="open"
>open</a></h3>
-<pre> my $reader = Lucy::Index::IndexReader->open(
- index => '/path/to/index', # required
- snapshot => $snapshot,
- manager => $index_manager,
- );</pre>
+<pre>my $reader = Lucy::Index::IndexReader->open(
+ index => '/path/to/index', # required
+ snapshot => $snapshot,
+ manager => $index_manager,
+);</pre>
-<p>IndexReader is an abstract base class; open() returns the IndexReader subclass PolyReader, which channels the output of 0 or more SegReaders.</p>
+<p>IndexReader is an abstract base class; open() returns the IndexReader subclass PolyReader,
+which channels the output of 0 or more SegReaders.</p>
<ul>
<li><b>index</b> - Either a string filepath or a Folder.</li>
-<li><b>snapshot</b> - A Snapshot. If not supplied, the most recent snapshot file will be used.</li>
+<li><b>snapshot</b> - A Snapshot.
+If not supplied,
+the most recent snapshot file will be used.</li>
<li><b>manager</b> - An <a href="../../Lucy/Index/IndexManager.html" class="podlinkpod"
->IndexManager</a>. Read-locking is off by default; supplying this argument turns it on.</li>
+>IndexManager</a>.
+Read-locking is off by default; supplying this argument turns it on.</li>
</ul>
<h2><a class='u'
@@ -144,23 +152,26 @@ name="ABSTRACT_METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $index_reader->doc_max();</pre>
+<pre>my $retval = $index_reader->doc_max();</pre>
-<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
+<p>Return the maximum number of documents available to the reader,
+which is also the highest possible internal document id.
+Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
<h3><a class='u'
name="doc_count"
>doc_count</a></h3>
-<pre> my $retval = $index_reader->doc_count();</pre>
+<pre>my $retval = $index_reader->doc_count();</pre>
-<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
+<p>Return the number of documents available to the reader,
+subtracting any that are marked as deleted.</p>
<h3><a class='u'
name="del_count"
>del_count</a></h3>
-<pre> my $retval = $index_reader->del_count();</pre>
+<pre>my $retval = $index_reader->del_count();</pre>
<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
@@ -168,15 +179,16 @@ name="del_count"
name="offsets"
>offsets</a></h3>
-<pre> my $retval = $index_reader->offsets();</pre>
+<pre>my $retval = $index_reader->offsets();</pre>
-<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
+<p>Return an array with one entry for each segment,
+corresponding to segment doc_id start offset.</p>
<h3><a class='u'
name="seg_readers"
>seg_readers</a></h3>
-<pre> my $retval = $index_reader->seg_readers();</pre>
+<pre>my $retval = $index_reader->seg_readers();</pre>
<p>Return an array of all the SegReaders represented within the IndexReader.</p>
@@ -188,9 +200,10 @@ name="METHODS"
name="obtain"
>obtain</a></h3>
-<pre> my $retval = $index_reader->obtain($api);</pre>
+<pre>my $retval = $index_reader->obtain($api);</pre>
-<p>Fetch a component, or throw an error if the component can’t be found.</p>
+<p>Fetch a component,
+or throw an error if the component can’t be found.</p>
<ul>
<li><b>api</b> - The name of the DataReader subclass that the desired component must implement.</li>
@@ -200,9 +213,10 @@ name="obtain"
name="fetch"
>fetch</a></h3>
-<pre> my $retval = $index_reader->fetch($api);</pre>
+<pre>my $retval = $index_reader->fetch($api);</pre>
-<p>Fetch a component, or return undef if the component can’t be found.</p>
+<p>Fetch a component,
+or return undef if the component can’t be found.</p>
<ul>
<li><b>api</b> - The name of the DataReader subclass that the desired component must implement.</li>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html Fri Feb 26 13:44:48 2016
@@ -81,35 +81,43 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $indexer = Lucy::Index::Indexer->new(
- schema => $schema,
- index => '/path/to/index',
- create => 1,
- );
- while ( my ( $title, $content ) = each %source_docs ) {
- $indexer->add_doc({
- title => $title,
- content => $content,
- });
- }
- $indexer->commit;</pre>
+<pre>my $indexer = Lucy::Index::Indexer->new(
+ schema => $schema,
+ index => '/path/to/index',
+ create => 1,
+);
+while ( my ( $title, $content ) = each %source_docs ) {
+ $indexer->add_doc({
+ title => $title,
+ content => $content,
+ });
+}
+$indexer->commit;</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>The Indexer class is Apache Lucy’s primary tool for managing the content of inverted indexes, which may later be searched using <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+<p>The Indexer class is Apache Lucy’s primary tool for managing the content of inverted indexes,
+which may later be searched using <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a>.</p>
-<p>In general, only one Indexer at a time may write to an index safely. If a write lock cannot be secured, new() will throw an exception.</p>
-
-<p>If an index is located on a shared volume, each writer application must identify itself by supplying an <a href="../../Lucy/Index/IndexManager.html" class="podlinkpod"
->IndexManager</a> with a unique <code>host</code> id to Indexer’s constructor or index corruption will occur. See <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
+<p>In general,
+only one Indexer at a time may write to an index safely.
+If a write lock cannot be secured,
+new() will throw an exception.</p>
+
+<p>If an index is located on a shared volume,
+each writer application must identify itself by supplying an <a href="../../Lucy/Index/IndexManager.html" class="podlinkpod"
+>IndexManager</a> with a unique <code>host</code> id to Indexer’s constructor or index corruption will occur.
+See <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
>FileLocking</a> for a detailed discussion.</p>
-<p>Note: at present, <a href="#delete_by_term" class="podlinkpod"
+<p>Note: at present,
+<a href="#delete_by_term" class="podlinkpod"
>delete_by_term()</a> and <a href="#delete_by_query" class="podlinkpod"
->delete_by_query()</a> only affect documents which had been previously committed to the index – and not any documents added this indexing session but not yet committed. This may change in a future update.</p>
+>delete_by_query()</a> only affect documents which had been previously committed to the index – and not any documents added this indexing session but not yet committed.
+This may change in a future update.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -119,22 +127,27 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $indexer = Lucy::Index::Indexer->new(
- schema => $schema, # required at index creation
- index => '/path/to/index', # required
- create => 1, # default: 0
- truncate => 1, # default: 0
- manager => $manager # default: created internally
- );</pre>
+<pre>my $indexer = Lucy::Index::Indexer->new(
+ schema => $schema, # required at index creation
+ index => '/path/to/index', # required
+ create => 1, # default: 0
+ truncate => 1, # default: 0
+ manager => $manager # default: created internally
+);</pre>
<ul>
-<li><b>schema</b> - A Schema. Required when index is being created; if not supplied, will be extracted from the index folder.</li>
+<li><b>schema</b> - A Schema.
+Required when index is being created; if not supplied,
+will be extracted from the index folder.</li>
<li><b>index</b> - Either a filepath to an index or a Folder.</li>
-<li><b>create</b> - If true and the index directory does not exist, attempt to create it.</li>
+<li><b>create</b> - If true and the index directory does not exist,
+attempt to create it.</li>
-<li><b>truncate</b> - If true, proceed with the intention of discarding all previous indexing data. The old data will remain intact and visible until commit() succeeds.</li>
+<li><b>truncate</b> - If true,
+proceed with the intention of discarding all previous indexing data.
+The old data will remain intact and visible until commit() succeeds.</li>
<li><b>manager</b> - An IndexManager.</li>
</ul>
@@ -147,17 +160,19 @@ name="METHODS"
name="add_doc"
>add_doc</a></h3>
-<pre> $indexer->add_doc($doc);
- $indexer->add_doc( { field_name => $field_value } );
- $indexer->add_doc(
- doc => { field_name => $field_value },
- boost => 2.5, # default: 1.0
- );</pre>
+<pre>$indexer->add_doc($doc);
+$indexer->add_doc( { field_name => $field_value } );
+$indexer->add_doc(
+ doc => { field_name => $field_value },
+ boost => 2.5, # default: 1.0
+);</pre>
-<p>Add a document to the index. Accepts either a single argument or labeled params.</p>
+<p>Add a document to the index.
+Accepts either a single argument or labeled params.</p>
<ul>
-<li><b>doc</b> - Either a Lucy::Document::Doc object, or a hashref (which will be attached to a Lucy::Document::Doc object internally).</li>
+<li><b>doc</b> - Either a Lucy::Document::Doc object,
+or a hashref (which will be attached to a Lucy::Document::Doc object internally).</li>
<li><b>boost</b> - A floating point weight which affects how this document scores.</li>
</ul>
@@ -166,9 +181,10 @@ name="add_doc"
name="add_index"
>add_index</a></h3>
-<pre> $indexer->add_index($index);</pre>
+<pre>$indexer->add_index($index);</pre>
-<p>Absorb an existing index into this one. The two indexes must have matching Schemas.</p>
+<p>Absorb an existing index into this one.
+The two indexes must have matching Schemas.</p>
<ul>
<li><b>index</b> - Either an index path name or a Folder.</li>
@@ -178,25 +194,31 @@ name="add_index"
name="delete_by_term"
>delete_by_term</a></h3>
-<pre> $indexer->delete_by_term(
- field => $field # required
- term => $term # required
- );</pre>
-
-<p>Mark documents which contain the supplied term as deleted, so that they will be excluded from search results and eventually removed altogether. The change is not apparent to search apps until after <a href="#commit" class="podlinkpod"
+<pre>$indexer->delete_by_term(
+ field => $field # required
+ term => $term # required
+);</pre>
+
+<p>Mark documents which contain the supplied term as deleted,
+so that they will be excluded from search results and eventually removed altogether.
+The change is not apparent to search apps until after <a href="#commit" class="podlinkpod"
>commit()</a> succeeds.</p>
<ul>
-<li><b>field</b> - The name of an indexed field. (If it is not spec’d as <code>indexed</code>, an error will occur.)</li>
-
-<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
+<li><b>field</b> - The name of an indexed field.
+(If it is not spec’d as <code>indexed</code>,
+an error will occur.)</li>
+
+<li><b>term</b> - The term which identifies docs to be marked as deleted.
+If <code>field</code> is associated with an Analyzer,
+<code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
</ul>
<h3><a class='u'
name="delete_by_query"
>delete_by_query</a></h3>
-<pre> $indexer->delete_by_query($query);</pre>
+<pre>$indexer->delete_by_query($query);</pre>
<p>Mark documents which match the supplied Query as deleted.</p>
@@ -209,7 +231,7 @@ name="delete_by_query"
name="delete_by_doc_id"
>delete_by_doc_id</a></h3>
-<pre> $indexer->delete_by_doc_id($doc_id);</pre>
+<pre>$indexer->delete_by_doc_id($doc_id);</pre>
<p>Mark the document identified by the supplied document ID as deleted.</p>
@@ -222,51 +244,71 @@ name="delete_by_doc_id"
name="optimize"
>optimize</a></h3>
-<pre> $indexer->optimize();</pre>
+<pre>$indexer->optimize();</pre>
-<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
+<p>Optimize the index for search-time performance.
+This may take a while,
+as it can involve rewriting large amounts of data.</p>
<p>Every Indexer session which changes index content and ends in a <a href="#commit" class="podlinkpod"
->commit()</a> creates a new segment. Once written, segments are never modified. However, they are periodically recycled by feeding their content into the segment currently being written.</p>
+>commit()</a> creates a new segment.
+Once written,
+segments are never modified.
+However,
+they are periodically recycled by feeding their content into the segment currently being written.</p>
<p>The <a href="#optimize" class="podlinkpod"
->optimize()</a> method causes all existing index content to be fed back into the Indexer. When <a href="#commit" class="podlinkpod"
+>optimize()</a> method causes all existing index content to be fed back into the Indexer.
+When <a href="#commit" class="podlinkpod"
>commit()</a> completes after an <a href="#optimize" class="podlinkpod"
->optimize()</a>, the index will consist of one segment. So <a href="#optimize" class="podlinkpod"
+>optimize()</a>,
+the index will consist of one segment.
+So <a href="#optimize" class="podlinkpod"
>optimize()</a> must be called before <a href="#commit" class="podlinkpod"
->commit()</a>. Also, optimizing a fresh index created from scratch has no effect.</p>
-
-<p>Historically, there was a significant search-time performance benefit to collapsing down to a single segment versus even two segments. Now the effect of collapsing is much less significant, and calling <a href="#optimize" class="podlinkpod"
+>commit()</a>.
+Also,
+optimizing a fresh index created from scratch has no effect.</p>
+
+<p>Historically,
+there was a significant search-time performance benefit to collapsing down to a single segment versus even two segments.
+Now the effect of collapsing is much less significant,
+and calling <a href="#optimize" class="podlinkpod"
>optimize()</a> is rarely justified.</p>
<h3><a class='u'
name="commit"
>commit</a></h3>
-<pre> $indexer->commit();</pre>
+<pre>$indexer->commit();</pre>
-<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
+<p>Commit any changes made to the index.
+Until this is called,
+none of the changes made during an indexing session are permanent.</p>
<p>Calling <a href="#commit" class="podlinkpod"
->commit()</a> invalidates the Indexer, so if you want to make more changes you’ll need a new one.</p>
+>commit()</a> invalidates the Indexer,
+so if you want to make more changes you’ll need a new one.</p>
<h3><a class='u'
name="prepare_commit"
>prepare_commit</a></h3>
-<pre> $indexer->prepare_commit();</pre>
+<pre>$indexer->prepare_commit();</pre>
<p>Perform the expensive setup for <a href="#commit" class="podlinkpod"
->commit()</a> in advance, so that <a href="#commit" class="podlinkpod"
->commit()</a> completes quickly. (If <a href="#prepare_commit" class="podlinkpod"
->prepare_commit()</a> is not called explicitly by the user, <a href="#commit" class="podlinkpod"
+>commit()</a> in advance,
+so that <a href="#commit" class="podlinkpod"
+>commit()</a> completes quickly.
+(If <a href="#prepare_commit" class="podlinkpod"
+>prepare_commit()</a> is not called explicitly by the user,
+<a href="#commit" class="podlinkpod"
>commit()</a> will call it internally.)</p>
<h3><a class='u'
name="get_schema"
>get_schema</a></h3>
-<pre> my $retval = $indexer->get_schema();</pre>
+<pre>my $retval = $indexer->get_schema();</pre>
<p>Accessor for schema.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Lexicon.html Fri Feb 26 13:44:48 2016
@@ -81,11 +81,11 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $lex_reader = $seg_reader->obtain('Lucy::Index::LexiconReader');
- my $lexicon = $lex_reader->lexicon( field => 'content' );
- while ( $lexicon->next ) {
- print $lexicon->get_term . "\n";
- }</pre>
+<pre>my $lex_reader = $seg_reader->obtain('Lucy::Index::LexiconReader');
+my $lexicon = $lex_reader->lexicon( field => 'content' );
+while ( $lexicon->next ) {
+ print $lexicon->get_term . "\n";
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -93,12 +93,13 @@ name="DESCRIPTION"
<p>A Lexicon is an iterator which provides access to all the unique terms for a given field in sorted order.</p>
-<p>If an index consists of two documents with a ‘content’ field holding “three blind mice” and “three musketeers” respectively, then iterating through the ‘content’ field’s lexicon would produce this list:</p>
+<p>If an index consists of two documents with a ‘content’ field holding “three blind mice” and “three musketeers” respectively,
+then iterating through the ‘content’ field’s lexicon would produce this list:</p>
-<pre> blind
- mice
- musketeers
- three</pre>
+<pre>blind
+mice
+musketeers
+three</pre>
<h2><a class='u'
name="ABSTRACT_METHODS"
@@ -108,37 +109,42 @@ name="ABSTRACT_METHODS"
name="seek"
>seek</a></h3>
-<pre> $lexicon->seek($target);
- $lexicon->seek(); # default: undef</pre>
+<pre>$lexicon->seek($target);
+$lexicon->seek(); # default: undef</pre>
-<p>Seek the Lexicon to the first iterator state which is greater than or equal to <code>target</code>. If <code>target</code> is undef, reset the iterator.</p>
+<p>Seek the Lexicon to the first iterator state which is greater than or equal to <code>target</code>.
+If <code>target</code> is undef,
+reset the iterator.</p>
<h3><a class='u'
name="next"
>next</a></h3>
-<pre> my $retval = $lexicon->next();</pre>
+<pre>my $retval = $lexicon->next();</pre>
<p>Proceed to the next term.</p>
-<p>Returns: true until the iterator is exhausted, then false.</p>
+<p>Returns: true until the iterator is exhausted,
+then false.</p>
<h3><a class='u'
name="reset"
>reset</a></h3>
-<pre> $lexicon->reset();</pre>
+<pre>$lexicon->reset();</pre>
-<p>Reset the iterator. <a href="#next" class="podlinkpod"
+<p>Reset the iterator.
+<a href="#next" class="podlinkpod"
>next()</a> must be called to proceed to the first element.</p>
<h3><a class='u'
name="get_term"
>get_term</a></h3>
-<pre> my $retval = $lexicon->get_term();</pre>
+<pre>my $retval = $lexicon->get_term();</pre>
-<p>Return the current term, or undef if the iterator is not in a valid state.</p>
+<p>Return the current term,
+or undef if the iterator is not in a valid state.</p>
<h2><a class='u'
name="INHERITANCE"
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/LexiconReader.html Fri Feb 26 13:44:48 2016
@@ -81,8 +81,8 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $lex_reader = $seg_reader->obtain("Lucy::Index::LexiconReader");
- my $lexicon = $lex_reader->lexicon( field => 'title' );</pre>
+<pre>my $lex_reader = $seg_reader->obtain("Lucy::Index::LexiconReader");
+my $lexicon = $lex_reader->lexicon( field => 'title' );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -98,12 +98,14 @@ name="ABSTRACT_METHODS"
name="lexicon"
>lexicon</a></h3>
-<pre> my $retval = $lexicon_reader->lexicon(
- field => $field # required
- term => $term # default: undef
- );</pre>
-
-<p>Return a new Lexicon for the given <code>field</code>. Will return undef if either the field is not indexed, or if no documents contain a value for the field.</p>
+<pre>my $retval = $lexicon_reader->lexicon(
+ field => $field # required
+ term => $term # default: undef
+);</pre>
+
+<p>Return a new Lexicon for the given <code>field</code>.
+Will return undef if either the field is not indexed,
+or if no documents contain a value for the field.</p>
<ul>
<li><b>field</b> - Field name.</li>
@@ -115,10 +117,10 @@ name="lexicon"
name="doc_freq"
>doc_freq</a></h3>
-<pre> my $retval = $lexicon_reader->doc_freq(
- field => $field # required
- term => $term # required
- );</pre>
+<pre>my $retval = $lexicon_reader->doc_freq(
+ field => $field # required
+ term => $term # required
+);</pre>
<p>Return the number of documents where the specified term is present.</p>
@@ -130,10 +132,10 @@ name="METHODS"
name="aggregator"
>aggregator</a></h3>
-<pre> my $retval = $lexicon_reader->aggregator(
- readers => $readers # required
- offsets => $offsets # required
- );</pre>
+<pre>my $retval = $lexicon_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+);</pre>
<p>Return a LexiconReader which merges the output of other LexiconReaders.</p>