[lucy-commits] svn commit: r1029925 - /incubator/lucy/trunk/perl/lib/Lucy.pod

[ma...@apache.org]

Author: marvin
Date: Tue Nov  2 00:44:43 2010
New Revision: 1029925

URL: http://svn.apache.org/viewvc?rev=1029925&view=rev
Log:
Dupe the primary documentation page for KinoSearch.  Make mechanical
substitutions (e.g. class names) of "KinoSearch" and "KSx" for "Lucy" and
"LucyX" -- all gimmes, nothing which requires rephrasing or careful thought.

Added:
    incubator/lucy/trunk/perl/lib/Lucy.pod
      - copied, changed from r1029891, incubator/lucy/trunk/perl/lib/KinoSearch.pod

Copied: incubator/lucy/trunk/perl/lib/Lucy.pod (from r1029891, incubator/lucy/trunk/perl/lib/KinoSearch.pod)
URL: http://svn.apache.org/viewvc/incubator/lucy/trunk/perl/lib/Lucy.pod?p2=incubator/lucy/trunk/perl/lib/Lucy.pod&p1=incubator/lucy/trunk/perl/lib/KinoSearch.pod&r1=1029891&r2=1029925&rev=1029925&view=diff
==============================================================================
--- incubator/lucy/trunk/perl/lib/KinoSearch.pod (original)
+++ incubator/lucy/trunk/perl/lib/Lucy.pod Tue Nov  2 00:44:43 2010
@@ -15,7 +15,7 @@
 
 =head1 NAME
 
-KinoSearch - Search engine library.
+Lucy - Search engine library.
 
 =head1 VERSION
 
@@ -27,24 +27,24 @@ First, plan out your index structure, cr
 
     # indexer.pl
     
-    use KinoSearch::Index::Indexer;
-    use KinoSearch::Plan::Schema;
-    use KinoSearch::Analysis::PolyAnalyzer;
-    use KinoSearch::Plan::FullTextType;
+    use Lucy::Index::Indexer;
+    use Lucy::Plan::Schema;
+    use Lucy::Analysis::PolyAnalyzer;
+    use Lucy::Plan::FullTextType;
     
     # Create a Schema which defines index fields.
-    my $schema = KinoSearch::Plan::Schema->new;
-    my $polyanalyzer = KinoSearch::Analysis::PolyAnalyzer->new( 
+    my $schema = Lucy::Plan::Schema->new;
+    my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( 
         language => 'en',
     );
-    my $type = KinoSearch::Plan::FullTextType->new(
+    my $type = Lucy::Plan::FullTextType->new(
         analyzer => $polyanalyzer,
     );
     $schema->spec_field( name => 'title',   type => $type );
     $schema->spec_field( name => 'content', type => $type );
     
     # Create the index and add documents.
-    my $indexer = KinoSearch::Index::Indexer->new(
+    my $indexer = Lucy::Index::Indexer->new(
         schema => $schema,   
         index  => '/path/to/index',
         create => 1,
@@ -61,9 +61,9 @@ Then, search the index:
 
     # search.pl
     
-    use KinoSearch::Search::IndexSearcher;
+    use Lucy::Search::IndexSearcher;
     
-    my $searcher = KinoSearch::Search::IndexSearcher->new( 
+    my $searcher = Lucy::Search::IndexSearcher->new( 
         index => '/path/to/index' 
     );
     my $hits = $searcher->hits( query => "foo bar" );
@@ -134,10 +134,10 @@ Stoplists.
 
 =head2 Getting Started
 
-L<KSx::Simple> provides a stripped down API which may suffice for many
+L<LucyX::Simple> provides a stripped down API which may suffice for many
 tasks.
 
-L<KinoSearch::Docs::Tutorial> demonstrates how to build a basic CGI search
+L<Lucy::Docs::Tutorial> demonstrates how to build a basic CGI search
 application.  
 
 The tutorial spends most of its time on these five classes:
@@ -146,23 +146,23 @@ The tutorial spends most of its time on 
 
 =item *
 
-L<KinoSearch::Plan::Schema> - Plan out your index.
+L<Lucy::Plan::Schema> - Plan out your index.
 
 =item *
 
-L<KinoSearch::Plan::FieldType> - Define index fields.
+L<Lucy::Plan::FieldType> - Define index fields.
 
 =item *
 
-L<KinoSearch::Index::Indexer> - Manipulate index content.
+L<Lucy::Index::Indexer> - Manipulate index content.
 
 =item *
 
-L<KinoSearch::Search::IndexSearcher> - Search an index.
+L<Lucy::Search::IndexSearcher> - Search an index.
 
 =item *
 
-L<KinoSearch::Analysis::PolyAnalyzer> - A one-size-fits-all parser/tokenizer.
+L<Lucy::Analysis::PolyAnalyzer> - A one-size-fits-all parser/tokenizer.
 
 =back
 
@@ -241,22 +241,22 @@ Turkish
 
 =head2 Delving Deeper
 
-L<KinoSearch::Docs::Cookbook> augments the tutorial with more advanced
+L<Lucy::Docs::Cookbook> augments the tutorial with more advanced
 recipes.
 
-For creating complex queries, see L<KinoSearch::Search::Query> and its
-subclasses L<TermQuery|KinoSearch::Search::TermQuery>,
-L<PhraseQuery|KinoSearch::Search::PhraseQuery>,
-L<ANDQuery|KinoSearch::Search::ANDQuery>,
-L<ORQuery|KinoSearch::Search::ORQuery>,
-L<NOTQuery|KinoSearch::Search::NOTQuery>,
-L<RequiredOptionalQuery|KinoSearch::Search::RequiredOptionalQuery>,
-L<MatchAllQuery|KinoSearch::Search::MatchAllQuery>, and
-L<NoMatchQuery|KinoSearch::Search::NoMatchQuery>, plus
-L<KinoSearch::Search::QueryParser>.
+For creating complex queries, see L<Lucy::Search::Query> and its
+subclasses L<TermQuery|Lucy::Search::TermQuery>,
+L<PhraseQuery|Lucy::Search::PhraseQuery>,
+L<ANDQuery|Lucy::Search::ANDQuery>,
+L<ORQuery|Lucy::Search::ORQuery>,
+L<NOTQuery|Lucy::Search::NOTQuery>,
+L<RequiredOptionalQuery|Lucy::Search::RequiredOptionalQuery>,
+L<MatchAllQuery|Lucy::Search::MatchAllQuery>, and
+L<NoMatchQuery|Lucy::Search::NoMatchQuery>, plus
+L<Lucy::Search::QueryParser>.
 
-For distributed searching, see L<KSx::Remote::SearchServer>,
-L<KSx::Remote::SearchClient>, and L<KinoSearch::Search::PolySearcher>.
+For distributed searching, see L<LucyX::Remote::SearchServer>,
+L<LucyX::Remote::SearchClient>, and L<Lucy::Search::PolySearcher>.
 
 =head2 Backwards Compatibility Policy
 
@@ -273,14 +273,14 @@ in a while.
 
 =head1 CLASS METHODS
 
-The KinoSearch module itself does not do much.
+The Lucy module itself does not do much.
 
 =head2 error
 
-    my $instream = $folder->open_in( file => 'foo' ) or die KinoSearch->error;
+    my $instream = $folder->open_in( file => 'foo' ) or die Lucy->error;
 
 Access a shared variable which is set by some routines on failure.  It will
-always be either a L<KinoSearch::Object::Err> or undef.
+always be either a L<Lucy::Object::Err> or undef.
 
 =head1 SEE ALSO