-
-
29 Sep 2010 18:00:56 UTC
- Development release
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (122 / 14 / 1)
- Kwalitee
Bus factor: 0- License: perl_5
- Activity
24 month- Tools
- Download (841.91KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- Parse::RecDescent
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
KinoSearch::Docs::Tutorial - Step-by-step introduction to KinoSearch toolset.
ABSTRACT
Explore KinoSearch's basic functionality by starting with a minimalist CGI search app based on KSx::Simple and transforming it, step by step, into an "advanced search" interface utilizing more flexible core modules like KinoSearch::Index::Indexer and KinoSearch::Search::IndexSearcher.
DESCRIPTION
Chapters
KinoSearch::Docs::Tutorial::Simple - Build a bare-bones search app using KSx::Simple.
KinoSearch::Docs::Tutorial::BeyondSimple - Rebuild the app using core classes like Indexer and IndexSearcher in place of KSx::Simple.
KinoSearch::Docs::Tutorial::FieldType - Experiment with different field characteristics using subclasses of KinoSearch::Plan::FieldType.
KinoSearch::Docs::Tutorial::Analysis - Examine how the choice of KinoSearch::Analysis::Analyzer subclass affects search results.
KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
KinoSearch::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 -- an html presentation of the United States constitution -- can be found in the
sample
directory at the root of the KinoSearch distribution, along with finished indexing and search apps.sample/indexer.pl # indexing app sample/search.cgi # search app sample/us_constitution # html documents
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 KinoSearch::Docs::Cookbook.
COPYRIGHT
Copyright 2005-2010 Marvin Humphrey
LICENSE, DISCLAIMER, BUGS, etc.
See KinoSearch version 0.30.
Module Install Instructions
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.