← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pylucene/trusty

« back to all changes in this revision

Viewing changes to lucene-java-2.3.1/docs/gettingstarted.html

  • Committer: Package Import Robot
  • Author(s): Dmitry Nezhevenko
  • Date: 2012-04-23 16:43:55 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120423164355-grqtepnwtecdjfk2
Tags: 3.5.0-1
http://bugs.debian.org/670179
http://bugs.debian.org/581198
http://bugs.debian.org/632240
http://bugs.debian.org/581197
* New maintainer (closes: 670179)
* New upstream release
* Switch to dpkg-source 3.0 (quilt) format
* Switch to machine-readable debian/copyright
* Bump debian/compat to 8, drop debian/pycompat
* Switch from cdbs to dh
* Add watch file
* Build for all supported versions of python2 (closes: 581198, 632240)
* Rename binary package to python-lucene (closes: 581197)
* Add -dbg package

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene-java-2.3.1/docs/gettingstarted.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
 
<html>
3
 
<head>
4
 
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<meta content="Apache Forrest" name="Generator">
6
 
<meta name="Forrest-version" content="0.8">
7
 
<meta name="Forrest-skin-name" content="pelt">
8
 
<title>
9
 
        Apache Lucene - Getting Started Guide
10
 
                </title>
11
 
<link type="text/css" href="skin/basic.css" rel="stylesheet">
12
 
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
13
 
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
14
 
<link type="text/css" href="skin/profile.css" rel="stylesheet">
15
 
<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
16
 
<link rel="shortcut icon" href="images/favicon.ico">
17
 
</head>
18
 
<body onload="init()">
19
 
<script type="text/javascript">ndeSetTextSize();</script>
20
 
<div id="top">
21
 
<!--+
22
 
    |breadtrail
23
 
    +-->
24
 
<div class="breadtrail">
25
 
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://lucene.apache.org/">Lucene</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
26
 
</div>
27
 
<!--+
28
 
    |header
29
 
    +-->
30
 
<div class="header">
31
 
<!--+
32
 
    |start group logo
33
 
    +-->
34
 
<div class="grouplogo">
35
 
<a href="http://lucene.apache.org/"><img class="logoImage" alt="Lucene" src="http://www.apache.org/images/asf_logo_simple.png" title="Apache Lucene"></a>
36
 
</div>
37
 
<!--+
38
 
    |end group logo
39
 
    +-->
40
 
<!--+
41
 
    |start Project Logo
42
 
    +-->
43
 
<div class="projectlogo">
44
 
<a href="http://lucene.apache.org/java/"><img class="logoImage" alt="Lucene" src="http://lucene.apache.org/images/lucene_green_300.gif" title="Apache Lucene is a high-performance, full-featured text search engine library written entirely in
45
 
      Java. It is a technology suitable for nearly any application that requires full-text search, especially cross-platform."></a>
46
 
</div>
47
 
<!--+
48
 
    |end Project Logo
49
 
    +-->
50
 
<!--+
51
 
    |start Search
52
 
    +-->
53
 
<div class="searchbox">
54
 
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
55
 
<input value="lucene.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
56
 
                    <input name="Search" value="Search" type="submit">
57
 
</form>
58
 
</div>
59
 
<!--+
60
 
    |end search
61
 
    +-->
62
 
<!--+
63
 
    |start Tabs
64
 
    +-->
65
 
<ul id="tabs">
66
 
<li class="current">
67
 
<a class="selected" href="http://lucene.apache.org/java/docs/">Main</a>
68
 
</li>
69
 
<li>
70
 
<a class="unselected" href="http://wiki.apache.org/lucene-java">Wiki</a>
71
 
</li>
72
 
<li class="current">
73
 
<a class="selected" href="index.html">Lucene 2.3.1 Documentation</a>
74
 
</li>
75
 
</ul>
76
 
<!--+
77
 
    |end Tabs
78
 
    +-->
79
 
</div>
80
 
</div>
81
 
<div id="main">
82
 
<div id="publishedStrip">
83
 
<!--+
84
 
    |start Subtabs
85
 
    +-->
86
 
<div id="level2tabs"></div>
87
 
<!--+
88
 
    |end Endtabs
89
 
    +-->
90
 
<script type="text/javascript"><!--
91
 
document.write("Last Published: " + document.lastModified);
92
 
//  --></script>
93
 
</div>
94
 
<!--+
95
 
    |breadtrail
96
 
    +-->
97
 
<div class="breadtrail">
98
 
 
99
 
             &nbsp;
100
 
           </div>
101
 
<!--+
102
 
    |start Menu, mainarea
103
 
    +-->
104
 
<!--+
105
 
    |start Menu
106
 
    +-->
107
 
<div id="menu">
108
 
<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
109
 
<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
110
 
<div class="menuitem">
111
 
<a href="index.html">Overview</a>
112
 
</div>
113
 
<div onclick="SwitchMenu('menu_1.1.2', 'skin/')" id="menu_1.1.2Title" class="menutitle">Javadocs</div>
114
 
<div id="menu_1.1.2" class="menuitemgroup">
115
 
<div class="menuitem">
116
 
<a href="api/index.html">All</a>
117
 
</div>
118
 
<div class="menuitem">
119
 
<a href="api/core/index.html">Core</a>
120
 
</div>
121
 
<div class="menuitem">
122
 
<a href="api/demo/index.html">Demo</a>
123
 
</div>
124
 
<div onclick="SwitchMenu('menu_1.1.2.4', 'skin/')" id="menu_1.1.2.4Title" class="menutitle">Contrib</div>
125
 
<div id="menu_1.1.2.4" class="menuitemgroup">
126
 
<div class="menuitem">
127
 
<a href="api/contrib-analyzers/index.html">Analyzers</a>
128
 
</div>
129
 
<div class="menuitem">
130
 
<a href="api/contrib-ant/index.html">Ant</a>
131
 
</div>
132
 
<div class="menuitem">
133
 
<a href="api/contrib-bdb/index.html">Bdb</a>
134
 
</div>
135
 
<div class="menuitem">
136
 
<a href="api/contrib-bdb-je/index.html">Bdb-je</a>
137
 
</div>
138
 
<div class="menuitem">
139
 
<a href="api/contrib-benchmark/index.html">Benchmark</a>
140
 
</div>
141
 
<div class="menuitem">
142
 
<a href="api/contrib-highlighter/index.html">Highlighter</a>
143
 
</div>
144
 
<div class="menuitem">
145
 
<a href="api/contrib-lucli/index.html">Lucli</a>
146
 
</div>
147
 
<div class="menuitem">
148
 
<a href="api/contrib-memory/index.html">Memory</a>
149
 
</div>
150
 
<div class="menuitem">
151
 
<a href="api/contrib-misc/index.html">Miscellaneous</a>
152
 
</div>
153
 
<div class="menuitem">
154
 
<a href="api/contrib-queries/index.html">Queries</a>
155
 
</div>
156
 
<div class="menuitem">
157
 
<a href="api/contrib-regex/index.html">Regex</a>
158
 
</div>
159
 
<div class="menuitem">
160
 
<a href="api/contrib-snowball/index.html">Snowball</a>
161
 
</div>
162
 
<div class="menuitem">
163
 
<a href="api/contrib-spellchecker/index.html">Spellchecker</a>
164
 
</div>
165
 
<div class="menuitem">
166
 
<a href="api/contrib-surround/index.html">Surround</a>
167
 
</div>
168
 
<div class="menuitem">
169
 
<a href="api/contrib-swing/index.html">Swing</a>
170
 
</div>
171
 
<div class="menuitem">
172
 
<a href="api/contrib-wikipedia/index.html">Wikipedia</a>
173
 
</div>
174
 
<div class="menuitem">
175
 
<a href="api/contrib-wordnet/index.html">Wordnet</a>
176
 
</div>
177
 
<div class="menuitem">
178
 
<a href="api/contrib-xml-query-parser/index.html">XML Query Parser</a>
179
 
</div>
180
 
</div>
181
 
</div>
182
 
<div class="menuitem">
183
 
<a href="benchmarks.html">Benchmarks</a>
184
 
</div>
185
 
<div class="menuitem">
186
 
<a href="contributions.html">Contributions</a>
187
 
</div>
188
 
<div class="menuitem">
189
 
<a href="http://wiki.apache.org/lucene-java/LuceneFAQ">FAQ</a>
190
 
</div>
191
 
<div class="menuitem">
192
 
<a href="fileformats.html">File Formats</a>
193
 
</div>
194
 
<div class="menupage">
195
 
<div class="menupagetitle">Getting Started</div>
196
 
</div>
197
 
<div class="menuitem">
198
 
<a href="lucene-sandbox/index.html">Lucene Sandbox</a>
199
 
</div>
200
 
<div class="menuitem">
201
 
<a href="queryparsersyntax.html">Query Syntax</a>
202
 
</div>
203
 
<div class="menuitem">
204
 
<a href="scoring.html">Scoring</a>
205
 
</div>
206
 
<div class="menuitem">
207
 
<a href="http://wiki.apache.org/lucene-java">Wiki</a>
208
 
</div>
209
 
</div>
210
 
<div id="credit"></div>
211
 
<div id="roundbottom">
212
 
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
213
 
<!--+
214
 
  |alternative credits
215
 
  +-->
216
 
<div id="credit2"></div>
217
 
</div>
218
 
<!--+
219
 
    |end Menu
220
 
    +-->
221
 
<!--+
222
 
    |start content
223
 
    +-->
224
 
<div id="content">
225
 
<div title="Portable Document Format" class="pdflink">
226
 
<a class="dida" href="gettingstarted.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
227
 
        PDF</a>
228
 
</div>
229
 
<h1>
230
 
        Apache Lucene - Getting Started Guide
231
 
                </h1>
232
 
<div id="minitoc-area">
233
 
<ul class="minitoc">
234
 
<li>
235
 
<a href="#Getting Started">Getting Started</a>
236
 
</li>
237
 
</ul>
238
 
</div>
239
 
 
240
 
 
241
 
<a name="N10013"></a><a name="Getting Started"></a>
242
 
<h2 class="boxed">Getting Started</h2>
243
 
<div class="section">
244
 
<p>
245
 
This document is intended as a "getting started" guide.  It has three audiences: first-time users
246
 
looking to install Apache Lucene in their application or web server; developers looking to modify or base
247
 
the applications they develop on Lucene; and developers looking to become involved in and contribute
248
 
to the development of Lucene.  This document is written in tutorial and walk-through format.  The
249
 
goal is to help you "get started".  It does not go into great depth on some of the conceptual or
250
 
inner details of Lucene.
251
 
</p>
252
 
<p>
253
 
Each section listed below builds on one another.  More advanced users
254
 
may wish to skip sections.
255
 
</p>
256
 
<ul>
257
 
        
258
 
<li>
259
 
<a href="demo.html">About the command-line Lucene demo and its usage</a>.  This section
260
 
        is intended for anyone who wants to use the command-line Lucene demo.</li> 
261
 
<p></p>
262
 
 
263
 
        
264
 
<li>
265
 
<a href="demo2.html">About the sources and implementation for the command-line Lucene
266
 
        demo</a>.  This section walks through the implementation details (sources) of the
267
 
        command-line Lucene demo.  This section is intended for developers.</li> 
268
 
<p></p>
269
 
 
270
 
        
271
 
<li>
272
 
<a href="demo3.html">About installing and configuring the demo template web
273
 
        application</a>.  While this walk-through assumes Tomcat as your container of choice,
274
 
        there is no reason you can't (provided you have the requisite knowledge) adapt the
275
 
        instructions to your container.  This section is intended for those responsible for the
276
 
        development or deployment of Lucene-based web applications.</li> 
277
 
<p></p>
278
 
 
279
 
        
280
 
<li>
281
 
<a href="demo4.html">About the sources used to construct the demo template web
282
 
        application</a>.  Please note the template application is designed to highlight features of
283
 
        Lucene and is <b>not</b> an example of best practices.  (One would hopefully use MVC
284
 
        architecture such as provided by Jakarta Struts and taglibs, but showing you how to do that
285
 
        would be WAY beyond the scope of this guide.)  This section is intended for developers and
286
 
        those wishing to customize the demo template web application to their needs.  </li>
287
 
 
288
 
 
289
 
</ul>
290
 
</div>
291
 
 
292
 
 
293
 
</div>
294
 
<!--+
295
 
    |end content
296
 
    +-->
297
 
<div class="clearboth">&nbsp;</div>
298
 
</div>
299
 
<div id="footer">
300
 
<!--+
301
 
    |start bottomstrip
302
 
    +-->
303
 
<div class="lastmodified">
304
 
<script type="text/javascript"><!--
305
 
document.write("Last Published: " + document.lastModified);
306
 
//  --></script>
307
 
</div>
308
 
<div class="copyright">
309
 
        Copyright &copy;
310
 
         2006 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
311
 
</div>
312
 
<!--+
313
 
    |end bottomstrip
314
 
    +-->
315
 
</div>
316
 
</body>
317
 
</html>