From e1ec2e2c6a17263551e223dff6696b1f2f406b2a Mon Sep 17 00:00:00 2001 From: "Andrew C. Oliver" Date: Sat, 26 Jan 2002 15:17:22 +0000 Subject: [PATCH] forgot a file git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@149647 13f79535-47bb-0310-9956-ffa450edef68 --- xdocs/gettingstarted.xml | 70 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 xdocs/gettingstarted.xml diff --git a/xdocs/gettingstarted.xml b/xdocs/gettingstarted.xml new file mode 100644 index 00000000000..6285a3ef742 --- /dev/null +++ b/xdocs/gettingstarted.xml @@ -0,0 +1,70 @@ + + + +Andrew C. Oliver +Jakarta Lucene - Getting Started Guide + + + +
+

+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. +

+
+ +
+

+Each section listed below builds on one another. That being said more advanced users may +wish to skip sections. +

+
+ +
+

+In this section we walk through the basic Lucene demo and executing it. +This section is intended for anyone who wants a basic background on using the provided Lucene demos. +

+
+ +
+

+In this section we walk through the sources and implementation +for the basic Lucene demo. This section is intended for developers. +

+
+ +
+

+In this section we walk through installing +and configuring the template web application. While this walkthough 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. +

+
+ +
+

+In this section we walk through the sources used to construct the +template web application. Please note the template application is designed to highlight +features of Lucene and is not 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 once 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. +

+
+ + + +