1*2329423eSUwe Schindler 2*2329423eSUwe Schindler 3*2329423eSUwe Schindler# Apache Lucene™ ${project.version} Documentation 4*2329423eSUwe Schindler 5*2329423eSUwe SchindlerLucene is a Java full-text search engine. Lucene is not a complete application, 6*2329423eSUwe Schindlerbut rather a code library and API that can easily be used to add search capabilities 7*2329423eSUwe Schindlerto applications. 8*2329423eSUwe Schindler 9*2329423eSUwe SchindlerThis is the official documentation for **Apache Lucene ${project.version}**. 10*2329423eSUwe SchindlerAdditional documentation is available in the 11*2329423eSUwe Schindler[Wiki](https://cwiki.apache.org/confluence/display/lucene). 12*2329423eSUwe Schindler 13*2329423eSUwe Schindler## Getting Started 14*2329423eSUwe Schindler 15*2329423eSUwe SchindlerThe following section is intended as a "getting started" guide. It has three 16*2329423eSUwe Schindleraudiences: first-time users looking to install Apache Lucene in their 17*2329423eSUwe Schindlerapplication; developers looking to modify or base the applications they develop 18*2329423eSUwe Schindleron Lucene; and developers looking to become involved in and contribute to the 19*2329423eSUwe Schindlerdevelopment of Lucene. The goal is to help you "get started". It does not go into great depth 20*2329423eSUwe Schindleron some of the conceptual or inner details of Lucene: 21*2329423eSUwe Schindler 22*2329423eSUwe Schindler* [Lucene demo, its usage, and sources](demo/overview-summary.html#overview.description): 23*2329423eSUwe Schindler Tutorial and walk-through of the command-line Lucene demo. 24*2329423eSUwe Schindler* [Introduction to Lucene's APIs](core/overview-summary.html#overview.description): 25*2329423eSUwe Schindler High-level summary of the different Lucene packages. </li> 26*2329423eSUwe Schindler* [Analysis overview](core/org/apache/lucene/analysis/package-summary.html#package.description): 27*2329423eSUwe Schindler Introduction to Lucene's analysis API. See also the 28*2329423eSUwe Schindler [TokenStream consumer workflow](core/org/apache/lucene/analysis/TokenStream.html). 29*2329423eSUwe Schindler 30*2329423eSUwe Schindler## Reference Documents 31*2329423eSUwe Schindler 32*2329423eSUwe Schindler* [Changes](changes/Changes.html): List of changes in this release. 33*2329423eSUwe Schindler* [System Requirements](SYSTEM_REQUIREMENTS.html): Minimum and supported Java versions. 34*2329423eSUwe Schindler* [Migration Guide](MIGRATE.html): What changed in Lucene ${project.majorVersion()}; how to migrate code from 35*2329423eSUwe Schindler Lucene ${project.majorVersion()-1}.x. 36*2329423eSUwe Schindler* [JRE Version Migration](JRE_VERSION_MIGRATION.html): Information about upgrading between major JRE versions. 37*2329423eSUwe Schindler* [File Formats](core/org/apache/lucene/codecs/${defaultCodecPackage}/package-summary.html#package.description): 38*2329423eSUwe Schindler Guide to the supported index format used by Lucene. This can be customized by using 39*2329423eSUwe Schindler [an alternate codec](core/org/apache/lucene/codecs/package-summary.html#package.description). 40*2329423eSUwe Schindler* [Search and Scoring in Lucene](core/org/apache/lucene/search/package-summary.html#package.description): 41*2329423eSUwe Schindler Introduction to how Lucene scores documents. 42*2329423eSUwe Schindler* [Classic Scoring Formula](core/org/apache/lucene/search/similarities/TFIDFSimilarity.html): 43*2329423eSUwe Schindler Formula of Lucene's classic [Vector Space](https://en.wikipedia.org/wiki/Vector_Space_Model) implementation 44*2329423eSUwe Schindler (look [here](core/org/apache/lucene/search/similarities/package-summary.html#package.description) for other models). 45*2329423eSUwe Schindler* [Classic QueryParser Syntax](queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description): 46*2329423eSUwe Schindler Overview of the Classic QueryParser's syntax and features. 47*2329423eSUwe Schindler 48*2329423eSUwe Schindler## API Javadocs 49*2329423eSUwe Schindler 50*2329423eSUwe Schindler${projectList} 51
