1<!-- 2 Licensed to the Apache Software Foundation (ASF) under one or more 3 contributor license agreements. See the NOTICE file distributed with 4 this work for additional information regarding copyright ownership. 5 The ASF licenses this file to You under the Apache License, Version 2.0 6 the "License"); you may not use this file except in compliance with 7 the License. You may obtain a copy of the License at 8 9 http://www.apache.org/licenses/LICENSE-2.0 10 11 Unless required by applicable law or agreed to in writing, software 12 distributed under the License is distributed on an "AS IS" BASIS, 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 See the License for the specific language governing permissions and 15 limitations under the License. 16 --> 17 18 19 20# Apache Lucene™ ${project.version} Documentation 21 22Lucene is a Java full-text search engine. Lucene is not a complete application, 23but rather a code library and API that can easily be used to add search capabilities 24to applications. 25 26This is the official documentation for **Apache Lucene ${project.version}**. 27Additional documentation is available in the 28[Wiki](https://cwiki.apache.org/confluence/display/lucene). 29 30## Getting Started 31 32The following section is intended as a "getting started" guide. It has three 33audiences: first-time users looking to install Apache Lucene in their 34application; developers looking to modify or base the applications they develop 35on Lucene; and developers looking to become involved in and contribute to the 36development of Lucene. The goal is to help you "get started". It does not go into great depth 37on some of the conceptual or inner details of Lucene: 38 39* [Lucene demo, its usage, and sources](demo/overview-summary.html#overview.description): 40 Tutorial and walk-through of the command-line Lucene demo. 41* [Introduction to Lucene's APIs](core/overview-summary.html#overview.description): 42 High-level summary of the different Lucene packages. </li> 43* [Analysis overview](core/org/apache/lucene/analysis/package-summary.html#package.description): 44 Introduction to Lucene's analysis API. See also the 45 [TokenStream consumer workflow](core/org/apache/lucene/analysis/TokenStream.html). 46 47## Reference Documents 48 49* [Changes](changes/Changes.html): List of changes in this release. 50* [System Requirements](SYSTEM_REQUIREMENTS.html): Minimum and supported Java versions. 51* [Migration Guide](MIGRATE.html): What changed in Lucene ${project.majorVersion()}; how to migrate code from 52 Lucene ${project.majorVersion()-1}.x. 53* [JRE Version Migration](JRE_VERSION_MIGRATION.html): Information about upgrading between major JRE versions. 54* [File Formats](core/org/apache/lucene/codecs/${defaultCodecPackage}/package-summary.html#package.description): 55 Guide to the supported index format used by Lucene. This can be customized by using 56 [an alternate codec](core/org/apache/lucene/codecs/package-summary.html#package.description). 57* [Search and Scoring in Lucene](core/org/apache/lucene/search/package-summary.html#package.description): 58 Introduction to how Lucene scores documents. 59* [Classic Scoring Formula](core/org/apache/lucene/search/similarities/TFIDFSimilarity.html): 60 Formula of Lucene's classic [Vector Space](https://en.wikipedia.org/wiki/Vector_Space_Model) implementation 61 (look [here](core/org/apache/lucene/search/similarities/package-summary.html#package.description) for other models). 62* [Classic QueryParser Syntax](queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description): 63 Overview of the Classic QueryParser's syntax and features. 64 65## API Javadocs 66 67${projectList} 68 69## Tools 70 71* Luke - Lucene Toolbox GUI tool: A Swing app for browsing documents, indexed terms and posting lists, searching an index, and so on. Type "/path/to/lucene-${project.version}/bin/luke.{sh|cmd}" to launch Luke. 72
