-
-
31 Dec 2014 03:15:36 UTC
- Distribution: Lucy
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Clone repository
- Issues
- Testers (1056 / 65 / 0)
- Kwalitee
Bus factor: 1- License: apache_2_0
- Perl: v5.8.3
- Activity
24 month- Tools
- Download (1.06MB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- The Apache Lucy Project <dev at lucy dot apache dot org>
- Dependencies
- Clownfish
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Lucy::Docs::Tutorial - Step-by-step introduction to Apache Lucy.
ABSTRACT
Explore Apache Lucy's basic functionality by starting with a minimalist CGI search app based on Lucy::Simple and transforming it, step by step, into an "advanced search" interface utilizing more flexible core modules like Lucy::Index::Indexer and Lucy::Search::IndexSearcher.
DESCRIPTION
Chapters
Lucy::Docs::Tutorial::Simple - Build a bare-bones search app using Lucy::Simple.
Lucy::Docs::Tutorial::BeyondSimple - Rebuild the app using core classes like Indexer and IndexSearcher in place of Lucy::Simple.
Lucy::Docs::Tutorial::FieldType - Experiment with different field characteristics using subclasses of Lucy::Plan::FieldType.
Lucy::Docs::Tutorial::Analysis - Examine how the choice of Lucy::Analysis::Analyzer subclass affects search results.
Lucy::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
Lucy::Docs::Tutorial::QueryObjects - Unlock advanced search features by using Query objects instead of query strings.
Source materials
The source material used by the tutorial app -- a multi-text-file presentation of the United States constitution -- can be found in the
sample
directory at the root of the Lucy distribution, along with finished indexing and search apps.sample/indexer.pl # indexing app sample/search.cgi # search app sample/us_constitution # corpus
Conventions
The user is expected to be familiar with OO Perl and basic CGI programming.
The code in this tutorial assumes a Unix-flavored operating system and the Apache webserver, but will work with minor modifications on other setups.
SEE ALSO
More advanced and esoteric subjects are covered in Lucy::Docs::Cookbook.
Module Install Instructions
To install Lucy::Simple, copy and paste the appropriate command in to your terminal.
cpanm Lucy::Simple
perl -MCPAN -e shell install Lucy::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.