Mailing List Archive

Author: creamyg
Date: 2008-08-29 11:15:14 -0700 (Fri, 29 Aug 2008)
New Revision: 3788

Modified:
trunk/perl/lib/KinoSearch/Docs/Tutorial.pod
Log:
Revise Tutorial start page.


Modified: trunk/perl/lib/KinoSearch/Docs/Tutorial.pod
===================================================================
--- trunk/perl/lib/KinoSearch/Docs/Tutorial.pod 2008-08-29 16:32:24 UTC (rev 3787)
+++ trunk/perl/lib/KinoSearch/Docs/Tutorial.pod 2008-08-29 18:15:14 UTC (rev 3788)
@@ -1,17 +1,15 @@
=head1 NAME

-KinoSearch::Docs::Tutorial - Step-by-step guide.
+KinoSearch::Docs::Tutorial - Step-by-step introduction to KinoSearch toolset.

-=head1 DESCRIPTION
+=head1 ABSTRACT

-KinoSearch is a flexible tool for building search applications. This tutorial
-explores its basic functionality by starting with a minimalist CGI search app
-based on L<KSx::Simple> and transforming it, step by step, into an
+Explore KinoSearch's basic functionality by starting with a minimalist CGI
+search app based on L<KSx::Simple> and transforming it, step by step, into an
"advanced search" interface utilizing more flexible core modules like
L<KinoSearch::InvIndexer> and L<KinoSearch::Searcher>.

-More advanced and esoteric subjects are covered in
-L<KinoSearch::Docs::Cookbook>.
+=head1 DESCRIPTION

=head2 Chapters

@@ -19,37 +17,33 @@

=item *

-L<KinoSearch::Docs::Tutorial::Simple> - build a bare-bones search app using
+L<KinoSearch::Docs::Tutorial::Simple> - Build a bare-bones search app using
L<KSx::Simple>.

=item *

-L<KinoSearch::Docs::Tutorial::BeyondSimple> - rebuild the app using
-core classes instead of KSx::Simple.
+L<KinoSearch::Docs::Tutorial::BeyondSimple> - Rebuild the app using
+core classes like L<InvIndexer|KinoSearch::InvIndexer> and
+L<Searcher|KinoSearch::Searcher> in place of KSx::Simple.

=item *

L<KinoSearch::Docs::Tutorial::FieldSpec> - Experiment with different field
-characteristics using subclasses of L<KinoSearch::FieldSpec>. [TODO]
+characteristics using subclasses of L<KinoSearch::FieldSpec>.

=item *

-L<KinoSearch::Docs::Tutorial::Analysis> - how to choose and use various
-subclasses of L<KinoSearch::Analysis::Analyzer>. [TODO]
+L<KinoSearch::Docs::Tutorial::Analysis> - Examine how the choice of
+L<KinoSearch::Analysis::Analyzer> subclass affects search results.

=item *

-L<KinoSearch::Docs::Tutorial::IncrementalIndexing> - modify the index by
-adding and deleting documents. [TODO]
-
-=item *
-
-L<KinoSearch::Docs::Tutorial::Highlighter> - augment your search results with
+L<KinoSearch::Docs::Tutorial::Highlighter> - Augment search results with
highlighted excerpts. [TODO]

=item *

-L<KinoSearch::Docs::Tutorial::QueryObjects> - unlock advanced search features
+L<KinoSearch::Docs::Tutorial::QueryObjects> - Unlock advanced search features
by using Query objects instead of query strings. [TODO]

=back
@@ -71,9 +65,14 @@

The user is expected to be familiar with OO Perl and basic CGI programming.

-This tutorial assumes a Unix-flavored operating system and the Apache
-webserver, but it will work with minor modifications on other rigs.
+The code in this tutorial assumes a Unix-flavored operating system and the
+Apache webserver, but will work with minor modifications on other setups.

+=head1 SEE ALSO
+
+More advanced and esoteric subjects are covered in
+L<KinoSearch::Docs::Cookbook>.
+
=head1 COPYRIGHT

Copyright 2005-2008 Marvin Humphrey


_______________________________________________
kinosearch-commits mailing list
kinosearch-commits@rectangular.com
http://www.rectangular.com/mailman/listinfo/kinosearch-commits