You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by dn...@apache.org on 2004/10/30 14:16:10 UTC
cvs commit: jakarta-lucene/xdocs demo2.xml demo4.xml
dnaber 2004/10/30 05:16:09
Modified: docs demo2.html demo4.html
xdocs demo2.xml demo4.xml
Log:
mostly spelling fixes, some small clarifications
Revision Changes Path
1.26 +8 -8 jakarta-lucene/docs/demo2.html
Index: demo2.html
===================================================================
RCS file: /home/cvs/jakarta-lucene/docs/demo2.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- demo2.html 18 May 2004 13:32:00 -0000 1.25
+++ demo2.html 30 Oct 2004 12:16:08 -0000 1.26
@@ -188,7 +188,7 @@
of IndexWriter. It passes a string called "index" and a new instance of a class called
"StandardAnalyzer". The "index" string is the name of the directory that all index information
should be stored in. Because we're not passing any path information, one must assume this
-will be created as a subdirectory of the current directory (if does not already exist). On
+will be created as a subdirectory of the current directory (if it does not already exist). On
some platforms this may actually result in it being created in other directories (such as
the user's home directory).
</p>
@@ -199,18 +199,18 @@
must a also pass an instance of <b>org.apache.analysis.Analyzer</b>.
</p>
<p>
-The <b>Analyzer</b>, in this case, the <b>Stop Analyzer</b> is little more than a standard Java
-Tokenizer, converting all strings to lowercase and filtering out useless words from the index.
-By useless words I mean common language words such as articles (a,an,the) and other words that
-would be useless for searching. It should be noted that there are different rules for every
-language, and you should use the proper analyzer for each. Lucene currently provides Analyzers
-for English and German.
+The <b>Analyzer</b>, in this case, the <b>StandardAnalyzer</b> is little more than a standard Java
+Tokenizer, converting all strings to lowercase and filtering out useless words and characters from the index.
+By useless words and characters I mean common language words such as articles (a, an, the, etc.) and other
+strings that would be useless for searching (e.g. <b>'s</b>) . It should be noted that there are different
+rules for every language, and you should use the proper analyzer for each. Lucene currently
+provides Analyzers for English and German, more can be found in the Lucene Sandbox.
</p>
<p>
Looking down further in the file, you should see the indexDocs() code. This recursive function
simply crawls the directories and uses FileDocument to create Document objects. The Document
is simply a data object to represent the content in the file as well as its creation time and
-location. These instances are added to the indexWriter. Take a look inside FileDocument. Its
+location. These instances are added to the indexWriter. Take a look inside FileDocument. It's
not particularly complicated, it just adds fields to the Document.
</p>
<p>
1.26 +5 -5 jakarta-lucene/docs/demo4.html
Index: demo4.html
===================================================================
RCS file: /home/cvs/jakarta-lucene/docs/demo4.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- demo4.html 18 May 2004 13:32:00 -0000 1.25
+++ demo4.html 30 Oct 2004 12:16:08 -0000 1.26
@@ -224,7 +224,7 @@
<blockquote>
<p>
The results.jsp had a lot more functionality. Much of it is for paging the search results we'll not
-cover this as its commented well enough. It does not peform any optimizations such as caching results,
+cover this as it's commented well enough. It does not perform any optimizations such as caching results,
etc. as that would make this a more complex example. The first thing in this page is the actual imports
for the Lucene classes and Lucene demo classes. These classes are loaded from the jars included in the
WEB-INF/lib directory in the final war file.
@@ -232,7 +232,7 @@
<p>
You'll notice that this file includes the same header and footer as the "index.jsp". From there the jsp
constructs an IndexSearcher with the "indexLocation" that was specified in the "configuration.jsp". If there
-is an error of any kind in opening the index, it is diplayed ot the user and a boolean flag is set to tell
+is an error of any kind in opening the index, it is diplayed to the user and a boolean flag is set to tell
the rest of the sections of the jsp not to continue.
</p>
<p>
@@ -245,12 +245,12 @@
<p>
The jsp moves on to construct a StandardAnalyzer just as in the simple demo, to analyze the search critieria, it
is passed to the QueryParser along with the criteria to construct a Query object. You'll also notice the
-string literal "contents" included. This is to specify the search should include the the contents and not
+string literal "contents" included. This is to specify the search should include the contents and not
the title, url or some other field in the indexed documents. If there is any error in constructing a Query
object an error is displayed to the user.
</p>
<p>
-In the next section of the jsp the IndexSearcher is asked to search given the query object. the results are
+In the next section of the jsp the IndexSearcher is asked to search given the query object. The results are
returned in a collection called "hits". If the length property of the hits collection is 0 then an error
is displayed to the user and the error flag is set.
</p>
@@ -323,7 +323,7 @@
<p>
Please resist the urge to contact the authors of this document (without bribes of fame and fortune attached). First
contact the <a href="http://jakarta.apache.org/site/mail.html">mailing lists</a>. That being said feedback,
-and modifications to this document and samples are ever so greatly appreciatedThey are just best sent to the
+and modifications to this document and samples are ever so greatly appreciated. They are just best sent to the
lists so that everyone can share in them. Certainly you'll get the most help there as well.
Thanks for understanding.
</p>
1.2 +8 -8 jakarta-lucene/xdocs/demo2.xml
Index: demo2.xml
===================================================================
RCS file: /home/cvs/jakarta-lucene/xdocs/demo2.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- demo2.xml 26 Jan 2002 15:01:32 -0000 1.1
+++ demo2.xml 30 Oct 2004 12:16:09 -0000 1.2
@@ -38,7 +38,7 @@
of IndexWriter. It passes a string called "index" and a new instance of a class called
"StandardAnalyzer". The "index" string is the name of the directory that all index information
should be stored in. Because we're not passing any path information, one must assume this
-will be created as a subdirectory of the current directory (if does not already exist). On
+will be created as a subdirectory of the current directory (if it does not already exist). On
some platforms this may actually result in it being created in other directories (such as
the user's home directory).
</p>
@@ -49,18 +49,18 @@
must a also pass an instance of <b>org.apache.analysis.Analyzer</b>.
</p>
<p>
-The <b>Analyzer</b>, in this case, the <b>Stop Analyzer</b> is little more than a standard Java
-Tokenizer, converting all strings to lowercase and filtering out useless words from the index.
-By useless words I mean common language words such as articles (a,an,the) and other words that
-would be useless for searching. It should be noted that there are different rules for every
-language, and you should use the proper analyzer for each. Lucene currently provides Analyzers
-for English and German.
+The <b>Analyzer</b>, in this case, the <b>StandardAnalyzer</b> is little more than a standard Java
+Tokenizer, converting all strings to lowercase and filtering out useless words and characters from the index.
+By useless words and characters I mean common language words such as articles (a, an, the, etc.) and other
+strings that would be useless for searching (e.g. <b>'s</b>) . It should be noted that there are different
+rules for every language, and you should use the proper analyzer for each. Lucene currently
+provides Analyzers for English and German, more can be found in the Lucene Sandbox.
</p>
<p>
Looking down further in the file, you should see the indexDocs() code. This recursive function
simply crawls the directories and uses FileDocument to create Document objects. The Document
is simply a data object to represent the content in the file as well as its creation time and
-location. These instances are added to the indexWriter. Take a look inside FileDocument. Its
+location. These instances are added to the indexWriter. Take a look inside FileDocument. It's
not particularly complicated, it just adds fields to the Document.
</p>
<p>
1.2 +5 -5 jakarta-lucene/xdocs/demo4.xml
Index: demo4.xml
===================================================================
RCS file: /home/cvs/jakarta-lucene/xdocs/demo4.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- demo4.xml 26 Jan 2002 15:01:32 -0000 1.1
+++ demo4.xml 30 Oct 2004 12:16:09 -0000 1.2
@@ -54,7 +54,7 @@
<section name="results.jsp (developers)">
<p>
The results.jsp had a lot more functionality. Much of it is for paging the search results we'll not
-cover this as its commented well enough. It does not peform any optimizations such as caching results,
+cover this as it's commented well enough. It does not perform any optimizations such as caching results,
etc. as that would make this a more complex example. The first thing in this page is the actual imports
for the Lucene classes and Lucene demo classes. These classes are loaded from the jars included in the
WEB-INF/lib directory in the final war file.
@@ -62,7 +62,7 @@
<p>
You'll notice that this file includes the same header and footer as the "index.jsp". From there the jsp
constructs an IndexSearcher with the "indexLocation" that was specified in the "configuration.jsp". If there
-is an error of any kind in opening the index, it is diplayed ot the user and a boolean flag is set to tell
+is an error of any kind in opening the index, it is diplayed to the user and a boolean flag is set to tell
the rest of the sections of the jsp not to continue.
</p>
<p>
@@ -75,12 +75,12 @@
<p>
The jsp moves on to construct a StandardAnalyzer just as in the simple demo, to analyze the search critieria, it
is passed to the QueryParser along with the criteria to construct a Query object. You'll also notice the
-string literal "contents" included. This is to specify the search should include the the contents and not
+string literal "contents" included. This is to specify the search should include the contents and not
the title, url or some other field in the indexed documents. If there is any error in constructing a Query
object an error is displayed to the user.
</p>
<p>
-In the next section of the jsp the IndexSearcher is asked to search given the query object. the results are
+In the next section of the jsp the IndexSearcher is asked to search given the query object. The results are
returned in a collection called "hits". If the length property of the hits collection is 0 then an error
is displayed to the user and the error flag is set.
</p>
@@ -123,7 +123,7 @@
<p>
Please resist the urge to contact the authors of this document (without bribes of fame and fortune attached). First
contact the <a href="http://jakarta.apache.org/site/mail.html">mailing lists</a>. That being said feedback,
-and modifications to this document and samples are ever so greatly appreciatedThey are just best sent to the
+and modifications to this document and samples are ever so greatly appreciated. They are just best sent to the
lists so that everyone can share in them. Certainly you'll get the most help there as well.
Thanks for understanding.
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org