lucene-java-3.4.0/lucene/src/site/src/documentation/content/xdocs/lucene-contrib/index.xml

   1 <?xml version="1.0"?>
   2 <document>
   3           <header>
   4           <title>
   5                 Apache Lucene - Lucene Contrib
   6                   </title>
   7           </header>
   8       <body>
   9
  10       <section id="Contrib"><title>Lucene Contrib</title>
  11                 <p>
  12                   The Lucene Java project also contains a workspace, Lucene Contrib
  13                   (formerly known as the Lucene Sandbox), that is open both to all Lucene
  14                   Java core committers and to developers whose commit rights are
  15                   restricted to the Contrib workspace; these developers are referred to
  16                   as "Contrib committers".  The Lucene Contrib workspace hosts the
  17                   following types of packages:
  18                 </p>
  19                 <ul>
  20                   <li>Various third party contributions.</li>
  21                   <li>
  22                     Contributions with third party dependencies - the Lucene Java core
  23                     distribution has no external runtime dependencies.
  24                   </li>
  25                   <li>
  26                     New ideas that are intended for eventual inclusion into the Lucene
  27                     Java core.
  28                   </li>
  29                  </ul>
  30                 <p>
  31                   Users are free to experiment with the components developed in the
  32                   Contrib workspace, but Contrib packages will not necessarily be
  33                   maintained, particularly in their current state. The Lucene Java core
  34                   backwards compatibility commitments (see
  35                   <a href="http://wiki.apache.org/lucene-java/BackwardsCompatibility"
  36                     >http://wiki.apache.org/lucene-java/BackwardsCompatibility</a>)
  37                   do not necessarily extend to the packages in the Contrib workspace.
  38                   See the README.txt file for each Contrib package for details.  If the
  39                   README.txt file does not address its backwards compatibility
  40                   commitments, users should assume it does not make any compatibility
  41                   commitments.
  42                 </p>
  43                         <p>
  44                           See <a href="../changes/Contrib-Changes.html">Contrib CHANGES</a> for changes included in the current release.
  45                         </p>
  46
  47
  48             <p>
  49                 You can access the current trunk Contrib repository at
  50                 <a href="http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/contrib/">http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/contrib/</a>.
  51             </p>
  52
  53             <section id="analyzers"><title>analyzers</title>
  54                 <p>Contributed Analyzers, Tokenizers, and Filters for various uses and languages.</p>
  55                 <p>See <a href="../api/contrib-analyzers/index.html">analyzers javadoc</a></p>
  56             </section>
  57
  58             <section id="benchmark"><title>benchmark</title>
  59                 <p>The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora.</p>
  60                 <p>See <a href="../api/contrib-benchmark/index.html">benchmark javadoc</a></p>
  61             </section>
  62
  63             <section id="demo"><title>demo</title>
  64                 <p>The demo contrib contains the Lucene demo: IndexFiles and SearchFiles, described under
  65                    <a href="../gettingstarted.html">Getting Started</a>.</p>
  66                 <p>See <a href="../api/contrib-demo/index.html">demo javadoc</a></p>
  67             </section>
  68
  69             <section id="facet"><title>facet</title>
  70                 <p>Provides faceted indexing and search capabilities</p>
  71                 <p>See <a href="../api/contrib-facet/index.html">facet javadoc</a></p>
  72             </section>
  73
  74             <section id="grouping"><title>grouping</title>
  75                 <p>Groups search results according to a specified field</p>
  76                 <p>See <a href="../api/contrib-grouping/index.html">grouping javadoc</a></p>
  77             </section>
  78
  79             <section id="highlighter"><title>highlighter</title>
  80                 <p>A set of classes for highlighting matching terms in search results.</p>
  81                 <p>See <a href="../api/contrib-highlighter/index.html">highlighter javadoc</a></p>
  82             </section>
  83
  84             <section id="icu"><title>icu</title>
  85                 <p>Provides integration with ICU (International Components for Unicode) for
  86                 stronger Unicode and internationalization support. </p>
  87                 <p>See <a href="../api/contrib-icu/index.html">icu javadoc</a></p>
  88             </section>
  89
  90             <section id="instantiated"><title>instantiated</title>
  91                 <p>RAM-based index that enables much faster searching than RAMDirectory in certain situations.</p>
  92                 <p>See <a href="../api/contrib-instantiated/index.html">instantiated javadoc</a></p>
  93             </section>
  94
  95             <section id="join"><title>join</title>
  96                 <p>Enables joining of parent and child documents when indexed as a doc block</p>
  97                 <p>See <a href="../api/contrib-join/index.html">join javadoc</a></p>
  98             </section>
  99
 100             <section id="memory"><title>memory</title>
 101                 <p>High-performance single-document main memory index.</p>
 102                 <p>See <a href="../api/contrib-memory/index.html">memory javadoc</a></p>
 103             </section>
 104
 105             <section id="misc"><title>misc</title>
 106                 <p>A variety of miscellaneous files, including QueryParsers, and other alternate Lucene class implementations and tools.</p>
 107                 <p>See <a href="../api/contrib-misc/index.html">misc javadoc</a></p>
 108             </section>
 109
 110             <section id="queryparser"><title>queryparser</title>
 111                 <p>A new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.</p>
 112                 <p>See <a href="../api/contrib-queryparser/index.html">queryparser javadoc</a></p>
 113             </section>
 114
 115             <section id="queries"><title>queries</title>
 116                 <p>Additional queries for Lucene.</p>
 117                 <p>See <a href="../api/contrib-queries/index.html">queries javadoc</a></p>
 118             </section>
 119
 120             <section id="remote"><title>remote</title>
 121                 <p>Classes to help use Lucene with RMI.</p>
 122                 <p>See <a href="../api/contrib-remote/index.html">remote javadoc</a></p>
 123             </section>
 124
 125             <section id="spatial"><title>spatial</title>
 126                 <p>Classes to help with efficient distance based sorting.</p>
 127                 <p>See <a href="../api/contrib-spatial/index.html">spatial javadoc</a></p>
 128             </section>
 129
 130             <section id="spellchecker"><title>spellchecker</title>
 131                 <p>Provides tools for spellchecking and suggestions with Lucene.</p>
 132                 <p>See <a href="../api/contrib-spellchecker/index.html">spellchecker javadoc</a></p>
 133             </section>
 134
 135             <section id="xml-query-parser"><title>xml-query-parser</title>
 136                 <p>A QueryParser that can read queries written in an XML format.</p>
 137                 <p>See <a href="../api/contrib-xml-query-parser/index.html">xml-query-parser javadoc</a></p>
 138             </section>
 139
 140                 </section>
 141     </body>
 142 </document>