From 93f02d341ea8deb0da41171da2a5df210b82a9dc Mon Sep 17 00:00:00 2001 From: Mark Robert Miller Date: Mon, 7 Sep 2009 01:00:21 +0000 Subject: [PATCH] LUCENE-1873: Update documentation to reflect current Contrib area status git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@811959 13f79535-47bb-0310-9956-ffa450edef68 --- CHANGES.txt | 3 + build.xml | 3 + docs/contributions.html | 2 +- docs/demo.html | 2 +- docs/demo2.html | 2 +- docs/demo3.html | 2 +- docs/demo4.html | 2 +- docs/fileformats.html | 2 +- docs/gettingstarted.html | 2 +- docs/index.html | 2 +- docs/linkmap.html | 4 +- docs/linkmap.pdf | 24 +- .../index.html | 367 ++++---- docs/lucene-contrib/index.pdf | 819 ++++++++++++++++++ docs/lucene-sandbox/index.pdf | 494 ----------- docs/queryparsersyntax.html | 2 +- docs/scoring.html | 2 +- src/site/src/documentation/conf/cli.xconf | 2 + .../content/xdocs/lucene-contrib/index.xml | 167 ++++ .../content/xdocs/lucene-sandbox/index.xml | 166 ---- .../src/documentation/content/xdocs/site.xml | 2 +- 21 files changed, 1221 insertions(+), 850 deletions(-) rename docs/{lucene-sandbox => lucene-contrib}/index.html (51%) create mode 100644 docs/lucene-contrib/index.pdf delete mode 100644 docs/lucene-sandbox/index.pdf create mode 100644 src/site/src/documentation/content/xdocs/lucene-contrib/index.xml delete mode 100644 src/site/src/documentation/content/xdocs/lucene-sandbox/index.xml diff --git a/CHANGES.txt b/CHANGES.txt index ca26daabfd9..b2fff1cd904 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1292,6 +1292,9 @@ Documentation 3. LUCENE-1349: Fieldable can now be changed without breaking backward compatibility rules (within reason. See the note at the top of this file and also on Fieldable.java). (Grant Ingersoll) + + 4. LUCENE-1873: Update documentation to reflect current Contrib area status. + (Steven Rowe, Mark Miller) Build diff --git a/build.xml b/build.xml index 3f875a90aae..a2305bdd304 100644 --- a/build.xml +++ b/build.xml @@ -711,6 +711,9 @@ + + + diff --git a/docs/contributions.html b/docs/contributions.html index af84e65b011..0a0778ad63b 100644 --- a/docs/contributions.html +++ b/docs/contributions.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/demo.html b/docs/demo.html index d3d75f8aab6..d9e457d17b6 100644 --- a/docs/demo.html +++ b/docs/demo.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/demo2.html b/docs/demo2.html index 2b423dbb383..03eb83e02cb 100644 --- a/docs/demo2.html +++ b/docs/demo2.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/demo3.html b/docs/demo3.html index 449de1d729c..e97ed5ceb5f 100644 --- a/docs/demo3.html +++ b/docs/demo3.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/demo4.html b/docs/demo4.html index e48569b1ab1..cd8fc86bdd0 100644 --- a/docs/demo4.html +++ b/docs/demo4.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/fileformats.html b/docs/fileformats.html index 89eaf5f92ef..37ff8e1a5a5 100644 --- a/docs/fileformats.html +++ b/docs/fileformats.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/gettingstarted.html b/docs/gettingstarted.html index 8d71f8fbaae..667a0bba576 100644 --- a/docs/gettingstarted.html +++ b/docs/gettingstarted.html @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified);
Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/index.html b/docs/index.html index e225874cb9a..632eeb76f82 100644 --- a/docs/index.html +++ b/docs/index.html @@ -213,7 +213,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax diff --git a/docs/linkmap.html b/docs/linkmap.html index cd5650467d7..74113785dd1 100644 --- a/docs/linkmap.html +++ b/docs/linkmap.html @@ -213,7 +213,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-Lucene Sandbox +Lucene Contrib
Query Syntax @@ -482,7 +482,7 @@ document.write("Last Published: " + document.lastModified); diff --git a/docs/linkmap.pdf b/docs/linkmap.pdf index 37795cc15f4..d013a3928ad 100644 --- a/docs/linkmap.pdf +++ b/docs/linkmap.pdf @@ -20,10 +20,10 @@ endobj >> endobj 7 0 obj -<< /Length 1045 /Filter [ /ASCII85Decode /FlateDecode ] +<< /Length 1038 /Filter [ /ASCII85Decode /FlateDecode ] >> stream -GatUs>u03/'Sc)R.rmX&lM2ZJS4c-5UkqZQWPkSe9lB6^XD(SfPet2-o@:bgY,),"a,p%Dm%!*WE\j>8Sl$#,!582C!kn70Gu4Mb%hi;'1EtTh>C"HCB(Z'.WV4p[I;aUR]0=Vr4[KLKAWK(;>/$"$KcDdYlCW^/g;&813ei&#el$Td.R.IenL9!23VfPmJG*O5+SC"n/ZIs$AEsb+I=P%E!G:`W@LSp;TH97jZBNI"N'GSfKHW6Jc8grVMi3iECIp\MC731QHqBT+b"[cpC$Xa;,hQ9u^V8TJrN'^On$KEakELL6gDcV56+o-t+fA\VC#..5cAmW]\NiK.DVs$>LEajHd3Ai%oE)n,;/@_o(qDf=B@lmQaTt!F?\rDS%C9^9/4jE>(:.7_75=f&=J0"X2[rjB@Cg3-?)YJ#J\T@%W3<@Y2CaA0jQJ+\"C0grbk*Fr7BS7eYD-$NCg/^*42`o?*GZq+jWYd0C(\_k6-Q]0/!&r/Q$2+Q@]c**=Z:ZM$8ET&>W\T));bou'27]@7PTPSB*0Y,"_MK**J-TN;:tDL.mVNWRk(?S#0(FCatQ7-Zud!Mi4nXH3BhY1KY]@VsGK'r")"$?1bWW~> +GatUs?#SFN'Sc)P'u!p+nGEk[c=L4>8Q."=$W8@Se)U^#1I=E&.-9@4q'%PmM3Pm-1$$!.mJ$B82tP/S)$?6k"Qml6!ilV3aF#]be2)`IEQF7IjrMhJ+*n_WO!Z2Rpd=>;dWNQ.(076m`.Ol-1=L9=%[gXaSfafjr45JWS)85?-+Yd#`#s*EnY]Qi\'^j>5gJcpkFfC!(dMV`6/b5eA@_Pu=j1Va$@Tuf@Yg2Z4WUEQiCPBX'^iBSp??&!"c+TTcdq=-SjWcR4V9YH.QkZ6l9eS?'3h,b=Xab6qT)f9&+M^;W^SJZ0;f>5JCl(/S;1-VLm;C]8NgU1OfEeV8JNim[R?1`d2:l=`*$!Q^>H?sXDVtF['PAIAAG)0NAZW$9atJ!o\1^l)VT;;UL@I;d(o&9gFDGOO0`s#'nc?p!#&QbZ83"G$FdKWfCu&^-ot/b!SZV5:J5(;V'D`1eOJkMjm>rIOp:d):=^T'E"Ning/bb`V8kTcGj_OM4nf$*l6VD!.sRagtG=#7A@7k3mWCMh8BTOu*"3jL#p;PP\9@9c3k>$_IdM-Z endstream endobj 8 0 obj @@ -87,19 +87,19 @@ endobj xref 0 14 0000000000 65535 f -0000003161 00000 n -0000003225 00000 n -0000003275 00000 n +0000003154 00000 n +0000003218 00000 n +0000003268 00000 n 0000000015 00000 n 0000000071 00000 n 0000001255 00000 n 0000001361 00000 n -0000002498 00000 n -0000002604 00000 n -0000002716 00000 n -0000002826 00000 n -0000002937 00000 n -0000003045 00000 n +0000002491 00000 n +0000002597 00000 n +0000002709 00000 n +0000002819 00000 n +0000002930 00000 n +0000003038 00000 n trailer << /Size 14 @@ -107,5 +107,5 @@ trailer /Info 4 0 R >> startxref -3397 +3390 %%EOF diff --git a/docs/lucene-sandbox/index.html b/docs/lucene-contrib/index.html similarity index 51% rename from docs/lucene-sandbox/index.html rename to docs/lucene-contrib/index.html index f98545d146d..49ac25068f9 100644 --- a/docs/lucene-sandbox/index.html +++ b/docs/lucene-contrib/index.html @@ -6,8 +6,8 @@ - Apache Lucene - Lucene Sandbox - + Apache Lucene - Lucene Contrib + @@ -215,7 +215,7 @@ document.write("Last Published: " + document.lastModified); Getting Started
-
Lucene Sandbox
+
Lucene Contrib
Query Syntax @@ -250,206 +250,243 @@ document.write("Last Published: " + document.lastModified); PDF

- Apache Lucene - Lucene Sandbox -

+ Apache Lucene - Lucene Contrib +
- - -

Lucene Sandbox

+ + +

Lucene Contrib

- Lucene project also contains a workspace, Lucene Sandbox, that is open to all Lucene committers, as well - as a few other developers. The purpose of the Sandbox is to host various third party contributions, - and to serve as a place to try out new ideas and prepare them for inclusion into the core Lucene - distribution.
- Users are free to experiment with the components developed in the Sandbox, but Sandbox components will - not necessarily be maintained, particularly in their current state. -

+ The Lucene Java project also contains a workspace, Lucene Contrib + (formerly known as the Lucene Sandbox), that is open both to all Lucene + Java core committers and to developers whose commit rights are + restricted to the Contrib workspace; these developers are referred to + as "Contrib committers". The Lucene Contrib workspace hosts the + following types of packages: +

+

- You can access the Lucene Sandbox repository at - http://svn.apache.org/repos/asf/lucene/java/trunk/contrib/. -

- -

Snowball Stemmers for Lucene

-

- This project provides pre-compiled versions of the Snowball stemmers - for Lucene. -

-

- -The - repository for the Snowball contribution. - -

-

- -Background information on Snowball, - which is a language for stemmers developed by Martin Porter. -

- -

Analyzers, Tokenizers, Filters

-

- Contributed Analyzers, Tokenizers, and Filters for various languages. -

-

- -The - repository for the Analyzers contribution. - -

- -

Ant

-

- The Ant project is a useful Ant task that creates a Lucene index out of an Ant fileset. It also - contains an example HTML parser that uses JTidy. -

-

- -The - repository for the Ant contribution. - -

- -

WordNet/Synonyms

-

- The Lucene WordNet code consists of a single class which parses a prolog file - from the WordNet site that contains a list of English words and synonyms. - The class builds a Lucene index from the synonyms file. Your querying code could - hit this index to build up a set of synonyms for the terms in the - search query. -

-

- More information on the Lucene WordNet package. - WordNet is an online database of English language words that contains - synonyms, definitions, and various relationships between synonym sets. -

-

- -The - repository for the WordNet module. - -

- -

Lucli - Lucene Command-line Interface

-

- The Lucli application allows index manipulation from the - command-line. -

-

- -The - repository for the Lucli contribution. - -

- -

Term Highlighter

-

- A small set of classes for highlighting matching terms in - search results. -

-The - repository for the Highlighter contribution. -

Fast Vector Highlighter

-

- An alternative set of classes for highlighting matching terms in search results. -

-The - repository for the Fast Vector Highlighter contribution. -

Javascript Query Constructor

-

- Javascript library to support client-side query-building. Provides support for a user interface similar to - Google's Advanced Search. -

-

- - -The - repository for the Javascript Query Constructor files. - -

- -

Javascript Query Validator

-

- Javascript library to support client-side query validation. Lucene doesn't like malformed queries and tends to - throw ParseException, which are often difficult to interpret and pass on to the user. This library hopes to - alleviate that problem. -

-

- - -The - repository for the Javascript Query Validator files. - -

- -

High Frequency Terms

-

- The miscellaneous package is for classes that don't fit anywhere else. The only class in it right now determines - what terms occur the most inside a Lucene index. This could be useful for analyzing which terms may need to go - into a custom stop word list for better search results. -

-

- - -The - repository for miscellaneous classes. - -

- -

InstantiatedIndex

-

- RAM-based index that enables much faster searching than RAMDirectory. + Users are free to experiment with the components developed in the + Contrib workspace, but Contrib packages will not necessarily be + maintained, particularly in their current state. The Lucene Java core + backwards compatibility commitments (see + http://wiki.apache.org/lucene-java/BackwardsCompatibility) + do not necessarily extend to the packages in the Contrib workspace. + See the README.txt file for each Contrib package for details. If the + README.txt file does not address its backwards compatibility + commitments, users should assume it does not make any compatibility + commitments.

- -The - repository for instantiated index. - + See Contrib CHANGES for changes included in the current release. +

+

+ You can access the current trunk Contrib repository at + http://svn.apache.org/repos/asf/lucene/java/trunk/contrib/. +

+ +

analyzers

+

Contributed Analyzers, Tokenizers, and Filters for various uses and languages.

+

See analyzers javadoc +

+ +

ant

+

Ant task to create Lucene indexes.

+

See ant javadoc +

+ +

benchmark

+

The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora.

+

See benchmark javadoc +

+ +

collation

+

CollationKeyFilter/Analyzer and ICUCollationKeyFilter/Analyzer - can be used as an efficient replacement for Locale + sorting and Locale range queries as well as Locale-specific normalization

+

See collation javadoc +

+ +

db

+

Provides integration with Berkley DB.

+

See db javadoc +

+ +

highlighter

+

A set of classes for highlighting matching terms in search results.

+

See highlighter javadoc +

+ +

fast-vector-highlighter

+

An alternative set of classes for highlighting matching terms in search results that relies on stored term vectors. + This highlighter can be much faster than the standard highlighter, especially on large fields.

+

See fast-vector-highlighter javadoc +

+ +

instantiated

+

RAM-based index that enables much faster searching than RAMDirectory in certain situations.

+

See instantiated javadoc +

+ +

lucli

+

An application that allows Lucene index manipulation from the command-line.

+

See lucli javadoc +

+ +

memory

+

High-performance single-document main memory index.

+

See memory javadoc +

+ +

misc

+

A variety of miscellaneous files, including QueryParsers, and other alternate Lucene class implementations and tools.

+

See misc javadoc +

+ +

queryparser

+

A new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.

+

See queryparser javadoc +

+ +

regex

+

Queries with additional regex matching capabilities.

+

See regex javadoc +

+ +

remote

+

Classes to help use Lucene with RMI.

+

See remote javadoc +

+ +

snowball

+

Pre-compiled versions of the Snowball stemmers for Lucene.

+

See snowball javadoc +

+ +

spatial

+

Classes to help with efficient distance based sorting.

+

See spatial javadoc +

+ +

spellchecker

+

Provides tools for spellchecking and suggestions with Lucene.

+

See spellchecker javadoc +

+ +

surround

+

A QueryParser that supports the Span family of queries as well as pre and infix notation.

+

See surround javadoc +

+ +

swing

+

Swing components designed to integrate with Lucene.

+

See swing javadoc +

+ +

wikipedia

+

Tools for working with wikipedia content.

+

See wikipedia javadoc +

+ +

wordnet

+

Tools to help utilize wordnet synonyms with Lucene

+

See wordnet javadoc +

+ +

xml-query-parser

+

A QueryParser that can read queries written in an XML format.

+

See xml-query-parser javadoc

-