-
-
27 Oct 2007 19:46:10 UTC
- Development release
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (21 / 5 / 2)
- Kwalitee
Bus factor: 0- License: perl_5
- Activity
24 month- Tools
- Download (460.82KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- Compress::Zlib
- HTML::Parser
- Lingua::Stem::Snowball
- Lingua::StopWords
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
KinoSearch::Docs::Tutorial - Overview
DESCRIPTION
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 KinoSearch::Simple and transforming it, step by step, into an "advanced search" interface utilizing more flexible core modules like KinoSearch::InvIndexer and KinoSearch::Searcher.
More advanced and esoteric subjects are covered in KinoSearch::Docs::Cookbook.
Chapters
KinoSearch::Docs::Tutorial::Simple - build a bare-bones search app using KinoSearch::Simple.
KinoSearch::Docs::Tutorial::BeyondSimple - rebuild the app using core classes instead of KinoSearch::Simple.
KinoSearch::Docs::Tutorial::FieldSpec - Experiment with different field characteristics using subclasses of KinoSearch::FieldSpec. [TODO]
KinoSearch::Docs::Tutorial::Analysis - how to choose and use various subclasses of KinoSearch::Analysis::Analyzer. [TODO]
KinoSearch::Docs::Tutorial::IncrementalIndexing - modify the index by adding and deleting documents. [TODO]
KinoSearch::Docs::Tutorial::Highlighter - augment your search results with highlighted excerpts. [TODO]
KinoSearch::Docs::Tutorial::QueryObjects - unlock advanced search features by using Query objects instead of query strings. [TODO]
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/USConSchema.pm # custom KinoSearch::Schema subclass sample/invindexer.pl # indexing app sample/search.cgi # search app sample/conf.pl # shared configuration file sample/us_constitution # html documents
Conventions
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.
COPYRIGHT
Copyright 2005-2007 Marvin Humphrey
LICENSE, DISCLAIMER, BUGS, etc.
See KinoSearch version 0.20.
Module Install Instructions
To install KinoSearch, copy and paste the appropriate command in to your terminal.
cpanm KinoSearch
perl -MCPAN -e shell install KinoSearch
For more information on module installation, please visit the detailed CPAN module installation guide.