You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/04/21 19:34:47 UTC
svn commit: r1328715 - in /lucene/dev/trunk/lucene:
analysis/common/src/java/ analysis/icu/src/java/
analysis/kuromoji/src/java/ analysis/morfologik/src/java/
analysis/phonetic/src/java/ analysis/smartcn/src/java/
analysis/uima/src/java/ queryparser/sr...
Author: rmuir
Date: Sat Apr 21 17:34:46 2012
New Revision: 1328715
URL: http://svn.apache.org/viewvc?rev=1328715&view=rev
Log:
improve overview.htmls
Modified:
lucene/dev/trunk/lucene/analysis/common/src/java/overview.html
lucene/dev/trunk/lucene/analysis/icu/src/java/overview.html
lucene/dev/trunk/lucene/analysis/kuromoji/src/java/overview.html
lucene/dev/trunk/lucene/analysis/morfologik/src/java/overview.html
lucene/dev/trunk/lucene/analysis/phonetic/src/java/overview.html
lucene/dev/trunk/lucene/analysis/smartcn/src/java/overview.html
lucene/dev/trunk/lucene/analysis/uima/src/java/overview.html
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/package.html
lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/package.html
lucene/dev/trunk/lucene/suggest/src/java/overview.html
Modified: lucene/dev/trunk/lucene/analysis/common/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/common/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/common/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/common/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -19,5 +19,15 @@
<title>Apache Lucene Analyzers</title>
</head>
<body>
+ Analyzers for indexing content in different languages and domains.
+ <p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
+ <p>
+ This module contains concrete components ({@link org.apache.lucene.analysis.charfilter.CharFilter}s,
+ {@link org.apache.lucene.analysis.Tokenizer}s, and ({@link org.apache.lucene.analysis.TokenFilter}s) for
+ analyzing different types of content. It also provides a number of {@link org.apache.lucene.analysis.Analyzer}s
+ for different languages that you can use to get started quickly.
+ </p>
</body>
</html>
\ No newline at end of file
Modified: lucene/dev/trunk/lucene/analysis/icu/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/icu/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/icu/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/icu/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -27,7 +27,11 @@ This module exposes functionality from
<a href="http://site.icu-project.org/">ICU</a> to Apache Lucene. ICU4J is a Java
library that enhances Java's internationalization support by improving
performance, keeping current with the Unicode Standard, and providing richer
-APIs. This module exposes the following functionality:
+APIs.
+<p>
+For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+<p>
+This module exposes the following functionality:
</p>
<ul>
<li><a href="#segmentation">Text Segmentation</a>: Tokenizes text based on
Modified: lucene/dev/trunk/lucene/analysis/kuromoji/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/kuromoji/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/kuromoji/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/kuromoji/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -17,10 +17,21 @@
<html>
<head>
<title>
- analyzers-kuromoji
+ Apache Lucene Kuromoji Analyzer
</title>
</head>
<body>
- analyzers-kuromoji
+ Kuromoji is a morphological analyzer for Japanese text.
+ <p>
+ This module provides support for Japanese text analysis, including features
+ such as part-of-speech tagging, lemmatization, and compound word analysis.
+ </p>
+ <p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
+ <!-- TODO: give a high level overview of the features, how they are supported
+ by the attributes api, which components do what, etc. Also would be nice
+ to show some examples for some Japanese strings, we could show the various
+ attributes resulting from analysis in a table -->
</body>
</html>
Modified: lucene/dev/trunk/lucene/analysis/morfologik/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/morfologik/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/morfologik/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/morfologik/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -27,6 +27,9 @@
by Dawid Weiss and Marcin MiÅkowski.
</p>
<p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
+ <p>
The MorfologikFilter yields one or more terms for each token. Each
of those terms is given the same position in the index.
</p>
Modified: lucene/dev/trunk/lucene/analysis/phonetic/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/phonetic/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/phonetic/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/phonetic/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -21,6 +21,13 @@
</title>
</head>
<body>
- analyzers-phonetic
+ Analysis for indexing phonetic signatures (for sounds-alike search)
+ <p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
+ <p>
+ This module provides analysis components (using encoders from <a href="http://commons.apache.org/codec/">Apache Commons Codec</a>)
+ that index and search phonetic signatures.
+ </p>
</body>
</html>
Modified: lucene/dev/trunk/lucene/analysis/smartcn/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/smartcn/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/smartcn/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/smartcn/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -21,6 +21,9 @@
</title>
</head>
<body>
- smartcn
+ Analyzer for Simplified Chinese, which indexes words.
+ <p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
</body>
</html>
\ No newline at end of file
Modified: lucene/dev/trunk/lucene/analysis/uima/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/analysis/uima/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/analysis/uima/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/analysis/uima/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -21,6 +21,9 @@
</title>
</head>
<body>
- analyzers-uima
+ Analysis integration with <a href="http://uima.apache.org/">Apache UIMA</a>.
+ <p>
+ For an introduction to Lucene's analysis API, see the {@link org.apache.lucene.analysis} package documentation.
+ </p>
</body>
</html>
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/package.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/package.html (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/package.html Sat Apr 21 17:34:46 2012
@@ -28,7 +28,7 @@ Sorry.
<p>Note that because JavaCC defines a class named <tt>Token</tt>, <tt>org.apache.lucene.analysis.Token</tt>
must always be fully qualified in source code in this package.
-<p><b>NOTE</b>: contrib/queryparser has an alternative queryparser that matches the syntax of this one, but is more modular,
+<p><b>NOTE</b>: {@link org.apache.lucene.queryparser.flexible.standard} has an alternative queryparser that matches the syntax of this one, but is more modular,
enabling substantial customization to how a query is created.
</body>
Modified: lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/package.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/package.html (original)
+++ lucene/dev/trunk/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/package.html Sat Apr 21 17:34:46 2012
@@ -15,6 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<!--
+TODO: this documentation is NOT VISIBLE because there are no classes in this package.
+merge into overview.html with descriptions of the other QPs -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
@@ -25,7 +28,7 @@
<h2>Apache Lucene Flexible Query Parser</h2>
<p>
-This contrib project contains the new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.
+This project contains the new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.
</p>
<p>
Modified: lucene/dev/trunk/lucene/suggest/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/suggest/src/java/overview.html?rev=1328715&r1=1328714&r2=1328715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/suggest/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/suggest/src/java/overview.html Sat Apr 21 17:34:46 2012
@@ -17,10 +17,10 @@
<html>
<head>
<title>
- spellchecker
+ suggest
</title>
</head>
<body>
- spellchecker
+ Auto-suggest and spellchecking support.
</body>
</html>
\ No newline at end of file