2002-01-26 11:38:28 -05:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
|
|
|
2004-03-04 09:41:28 -05:00
|
|
|
<!--
|
|
|
|
|
Copyright 1999-2004 The Apache Software Foundation
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
2002-01-26 11:38:28 -05:00
|
|
|
<!-- Content Stylesheet for Site -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- start the processing -->
|
|
|
|
|
<!-- ====================================================================== -->
|
2002-12-12 01:23:48 -05:00
|
|
|
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
|
2002-01-26 11:38:28 -05:00
|
|
|
<!-- Main Page Section -->
|
|
|
|
|
<!-- ====================================================================== -->
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
|
|
|
|
|
|
|
|
|
|
<meta name="author" value="Andrew C. Oliver">
|
|
|
|
|
<meta name="email" value="acoliver@apache.org">
|
|
|
|
|
|
2002-02-11 14:45:24 -05:00
|
|
|
|
|
|
|
|
|
2003-01-04 11:29:08 -05:00
|
|
|
|
2002-01-26 11:38:28 -05:00
|
|
|
<title>Jakarta Lucene - Jakarta Lucene - Getting Started Guide</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body bgcolor="#ffffff" text="#000000" link="#525D76">
|
|
|
|
|
<table border="0" width="100%" cellspacing="0">
|
|
|
|
|
<!-- TOP IMAGE -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td align="left">
|
|
|
|
|
<a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif" border="0"/></a>
|
|
|
|
|
</td>
|
|
|
|
|
<td align="right">
|
|
|
|
|
<a href="http://jakarta.apache.org/lucene/"><img src="./images/lucene_green_300.gif" alt="Jakarta Lucene" border="0"/></a>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<table border="0" width="100%" cellspacing="4">
|
|
|
|
|
<tr><td colspan="2">
|
|
|
|
|
<hr noshade="" size="1"/>
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<!-- LEFT SIDE NAVIGATION -->
|
|
|
|
|
<td width="20%" valign="top" nowrap="true">
|
2003-10-09 10:40:30 -04:00
|
|
|
|
|
|
|
|
<!-- ============================================================ -->
|
|
|
|
|
|
|
|
|
|
<p><strong>About</strong></p>
|
2002-01-26 11:38:28 -05:00
|
|
|
<ul>
|
|
|
|
|
<li> <a href="./index.html">Overview</a>
|
|
|
|
|
</li>
|
2004-05-18 09:32:01 -04:00
|
|
|
<li> <a href="http://wiki.apache.org/jakarta-lucene/PoweredBy">Powered by Lucene</a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./whoweare.html">Who We Are</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><strong>Resources</strong></p>
|
|
|
|
|
<ul>
|
2004-02-28 21:43:36 -05:00
|
|
|
<li> <a href="http://wiki.apache.org/jakarta-lucene">Wiki</a>
|
|
|
|
|
</li>
|
2004-12-30 16:50:43 -05:00
|
|
|
<li> <a href="http://wiki.apache.org/jakarta-lucene/LuceneFAQ">FAQ</a>
|
2002-06-20 10:23:48 -04:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./gettingstarted.html">Getting Started</a>
|
2002-05-16 01:16:10 -04:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./queryparsersyntax.html">Query Syntax</a>
|
2002-10-29 23:14:11 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./fileformats.html">File Formats</a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./api/index.html">Javadoc</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li> <a href="./contributions.html">Contributions</a>
|
2002-06-20 10:23:48 -04:00
|
|
|
</li>
|
2002-07-14 15:04:00 -04:00
|
|
|
<li> <a href="./resources.html">Articles, etc.</a>
|
2002-12-04 00:56:33 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./benchmarks.html">Benchmarks</a>
|
2002-11-29 16:23:47 -05:00
|
|
|
</li>
|
2004-11-15 14:00:49 -05:00
|
|
|
<li> <a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Lucene&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&order=Importance">Patches</a>
|
2002-11-07 15:18:09 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/bugs.html">Bugs</a>
|
|
|
|
|
</li>
|
2004-11-15 14:00:49 -05:00
|
|
|
<li> <a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Lucene&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&order=Importance">Lucene Bugs</a>
|
2002-11-29 16:23:47 -05:00
|
|
|
</li>
|
2004-11-16 16:01:02 -05:00
|
|
|
<li> <a href="http://nagoya.apache.org/eyebrowse/SummarizeList?listId=30">Lucene-user</a>
|
2002-11-29 16:23:47 -05:00
|
|
|
</li>
|
2004-11-16 16:01:02 -05:00
|
|
|
<li> <a href="http://nagoya.apache.org/eyebrowse/SummarizeList?listId=29">Lucene-dev</a>
|
2002-12-04 00:56:33 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="./lucene-sandbox/">Lucene Sandbox</a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><strong>Download</strong></p>
|
|
|
|
|
<ul>
|
2004-11-29 08:34:57 -05:00
|
|
|
<li> <a href="http://www.apache.org/dyn/closer.cgi/jakarta/lucene/binaries/">Binaries</a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</li>
|
2004-11-29 08:34:57 -05:00
|
|
|
<li> <a href="http://www.apache.org/dyn/closer.cgi/jakarta/lucene/source/">Source Code</a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repositories</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><strong>Jakarta</strong></p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/getinvolved.html">Get Involved</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/acknowledgements.html">Acknowledgements</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/contact.html">Contact</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li> <a href="http://jakarta.apache.org/site/legal.html">Legal</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</td>
|
|
|
|
|
<td width="80%" align="left" valign="top">
|
|
|
|
|
<table border="0" cellspacing="0" cellpadding="2" width="100%">
|
|
|
|
|
<tr><td bgcolor="#525D76">
|
|
|
|
|
<font color="#ffffff" face="arial,helvetica,sanserif">
|
2004-10-19 17:43:41 -04:00
|
|
|
<a name="Getting Started"><strong>Getting Started</strong></a>
|
2002-01-26 11:38:28 -05:00
|
|
|
</font>
|
|
|
|
|
</td></tr>
|
|
|
|
|
<tr><td>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<p>
|
|
|
|
|
This document is intended as a "getting started" guide. It has three basic
|
|
|
|
|
audiences: novices looking to install Jakarta Lucene on their application or
|
|
|
|
|
web server, developers looking to modify or base the applications they develop
|
|
|
|
|
on Lucene, and developers looking to become involved in and contribute to the
|
|
|
|
|
development of Lucene. This document is written in tutorial and walkthrough
|
|
|
|
|
format. It intends to help you in "getting started", but does not go into great
|
|
|
|
|
depth into some of the conceptual or inner details of Jakarta Lucene.
|
|
|
|
|
</p>
|
2004-10-19 17:43:41 -04:00
|
|
|
<p>
|
2002-01-26 11:38:28 -05:00
|
|
|
Each section listed below builds on one another. That being said more advanced users may
|
|
|
|
|
wish to skip sections.
|
|
|
|
|
</p>
|
2004-10-19 17:43:41 -04:00
|
|
|
<ul>
|
|
|
|
|
<li><a href="demo.html">About the basic Lucene demo and its usage</a>.
|
|
|
|
|
This section is intended for anyone who wants a basic background on using the provided Lucene demos.</li>
|
|
|
|
|
|
|
|
|
|
<li><a href="demo2.html">About the sources and implementation
|
|
|
|
|
for the basic Lucene demo</a> section we walk through . This section is intended for developers.</li>
|
|
|
|
|
|
|
|
|
|
<li><a href="demo3.html">About installing
|
|
|
|
|
and configuring the template web application</a>. While this walkthrough assumes
|
|
|
|
|
Tomcat 4.0.x as your container of choice, there is no reason you can't (provided you have
|
|
|
|
|
the requisite knowledge) adapt the instructions to your container. This section is intended
|
|
|
|
|
for those responsible for the development or deployment of Lucene-based web applications.</li>
|
|
|
|
|
|
|
|
|
|
<li><a href="demo4.html">About the sources used to construct the
|
|
|
|
|
template web application</a>. Please note the template application is designed to highlight
|
|
|
|
|
features of Lucene and is <b>not</b> an example of best practices. (One would hopefully
|
|
|
|
|
use MVC architecture such as provided by Jakarta Struts and taglibs, or better yet XML
|
|
|
|
|
with stylesheets, but showing you how to do that would be WAY beyond the scope of this
|
|
|
|
|
demonstration. Additionally one could cache results, and perform other performance
|
|
|
|
|
optimizations, but those are beyond the scope of this demo).
|
|
|
|
|
This section is intended for developers and those wishing to customize the template web
|
|
|
|
|
application to their needs. The sections useful to developers only are clearly delineated.</li>
|
|
|
|
|
</ul>
|
2002-01-26 11:38:28 -05:00
|
|
|
</blockquote>
|
|
|
|
|
</p>
|
|
|
|
|
</td></tr>
|
|
|
|
|
<tr><td><br/></td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<!-- FOOTER -->
|
|
|
|
|
<tr><td colspan="2">
|
|
|
|
|
<hr noshade="" size="1"/>
|
|
|
|
|
</td></tr>
|
|
|
|
|
<tr><td colspan="2">
|
|
|
|
|
<div align="center"><font color="#525D76" size="-1"><em>
|
2004-02-28 21:43:36 -05:00
|
|
|
Copyright © 1999-2004, The Apache Software Foundation
|
2002-01-26 11:38:28 -05:00
|
|
|
</em></font></div>
|
|
|
|
|
</td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
<!-- end the processing -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2002-02-11 14:45:24 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
