lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cutt...@apache.org
Subject cvs commit: jakarta-lucene/xdocs/stylesheets project.xml
Date Tue, 02 Oct 2001 15:54:16 GMT
cutting     01/10/02 08:54:16

  Modified:    .        build.xml
               docs     index.html powered.html resources.html
                        whoweare.html
               xdocs/stylesheets project.xml
  Added:       src/java overview.html
  Removed:     api      overview.html
               docs     applications.html background.html
  Log:
  moved api.html into javadoc as overview; fixed links to javadoc
  
  Revision  Changes    Path
  1.10      +2 -1      jakarta-lucene/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/build.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- build.xml	2001/09/25 19:07:06	1.9
  +++ build.xml	2001/10/02 15:54:16	1.10
  @@ -267,7 +267,8 @@
     <target name="javadocs" depends="compile" if="javacc.present">
       <mkdir dir="${build.javadocs}"/>
       <javadoc
  -      sourcepath="${src.dir}:${build.src}" 
  +      sourcepath="${src.dir}:${build.src}"
  +      overview="${src.dir}/overview.html"
         packagenames="${packages}"
         destdir="${build.javadocs}"
         author="true"
  
  
  
  1.4       +2 -2      jakarta-lucene/docs/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/index.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- index.html	2001/09/28 20:47:30	1.3
  +++ index.html	2001/10/02 15:54:16	1.4
  @@ -29,7 +29,7 @@
   <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif"
border="0"/></a>
   </td>
   <td align="right">
  -<a href="http://jakarta.apache.org/lucene/docs/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
  +<a href="http://jakarta.apache.org/lucene/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
   </td>
                   </tr>
               </table>
  @@ -60,7 +60,7 @@
   </li>
                       <li>    <a href="./resources.html">Articles</a>
   </li>
  -                    <li>    <a href="../api/overview.html">Javadoc</a>
  +                    <li>    <a href="./api/index.html">Javadoc</a>
   </li>
                   </ul>
               <p><strong>Download</strong></p>
  
  
  
  1.4       +2 -2      jakarta-lucene/docs/powered.html
  
  Index: powered.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/powered.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- powered.html	2001/09/28 20:47:30	1.3
  +++ powered.html	2001/10/02 15:54:16	1.4
  @@ -27,7 +27,7 @@
   <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif"
border="0"/></a>
   </td>
   <td align="right">
  -<a href="http://jakarta.apache.org/lucene/docs/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
  +<a href="http://jakarta.apache.org/lucene/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
   </td>
                   </tr>
               </table>
  @@ -58,7 +58,7 @@
   </li>
                       <li>    <a href="./resources.html">Articles</a>
   </li>
  -                    <li>    <a href="../api/overview.html">Javadoc</a>
  +                    <li>    <a href="./api/index.html">Javadoc</a>
   </li>
                   </ul>
               <p><strong>Download</strong></p>
  
  
  
  1.4       +2 -2      jakarta-lucene/docs/resources.html
  
  Index: resources.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/resources.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- resources.html	2001/09/28 20:47:30	1.3
  +++ resources.html	2001/10/02 15:54:16	1.4
  @@ -27,7 +27,7 @@
   <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif"
border="0"/></a>
   </td>
   <td align="right">
  -<a href="http://jakarta.apache.org/lucene/docs/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
  +<a href="http://jakarta.apache.org/lucene/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
   </td>
                   </tr>
               </table>
  @@ -58,7 +58,7 @@
   </li>
                       <li>    <a href="./resources.html">Articles</a>
   </li>
  -                    <li>    <a href="../api/overview.html">Javadoc</a>
  +                    <li>    <a href="./api/index.html">Javadoc</a>
   </li>
                   </ul>
               <p><strong>Download</strong></p>
  
  
  
  1.4       +2 -2      jakarta-lucene/docs/whoweare.html
  
  Index: whoweare.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/whoweare.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- whoweare.html	2001/09/28 20:47:30	1.3
  +++ whoweare.html	2001/10/02 15:54:16	1.4
  @@ -27,7 +27,7 @@
   <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif"
border="0"/></a>
   </td>
   <td align="right">
  -<a href="http://jakarta.apache.org/lucene/docs/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
  +<a href="http://jakarta.apache.org/lucene/"><img src="./images/lucene_green_300.gif"
alt="Jakarta Lucene" border="0"/></a>
   </td>
                   </tr>
               </table>
  @@ -58,7 +58,7 @@
   </li>
                       <li>    <a href="./resources.html">Articles</a>
   </li>
  -                    <li>    <a href="../api/overview.html">Javadoc</a>
  +                    <li>    <a href="./api/index.html">Javadoc</a>
   </li>
                   </ul>
               <p><strong>Download</strong></p>
  
  
  
  1.1                  jakarta-lucene/src/java/overview.html
  
  Index: overview.html
  ===================================================================
  <html>
  <head>
     <title>Jakarta Lucene API</title>
  </head>
  <body>
  
  <h1>Jakarta Lucene API</h1>
  The Jakarta Lucene API is divided into several packages:
  <ul>
  <li>
  <b><a href="org/apache/lucene/util/package-summary.html">com.lucene.util</a></b>
  contains a few handy data structures, e.g., <a href="org/apache/lucene/util/BitVector.html">BitVector</a>
  and <a href="org/apache/lucene/util/PriorityQueue.html">PriorityQueue</a>.</li>
  
  <li>
  <b><a href="org/apache/lucene/store/package-summary.html">com.lucene.store</a></b>
  defines an abstract class for storing persistent data, the <a href="org/apache/lucene/store/Directory.html">Directory</a>,
  a collection of named files written by an <a href="org/apache/lucene/store/OutputStream.html">OutputStream</a>
  and read by an <a href="org/apache/lucene/store/InputStream.html">InputStream</a>.&nbsp;
  Two implementations are provided, <a href="org/apache/lucene/store/FSDirectory.html">FSDirectory</a>,
  which uses a file system directory to store files, and <a href="org/apache/lucene/store/RAMDirectory.html">RAMDirectory</a>
  which implements files as memory-resident data structures.</li>
  
  <li>
  <b><a href="org/apache/lucene/document/package-summary.html">com.lucene.document</a></b>
  provides a simple <a href="org/apache/lucene/document/Document.html">Document</a>
  class.&nbsp; A document is simply a set of named <a href="org/apache/lucene/document/Field.html">Field</a>'s,
  whose values may be strings or instances of <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/io/Reader.html">java.io.Reader</a>.</li>
  
  <li>
  <b><a href="org/apache/lucene/analysis/package-summary.html">com.lucene.analysis</a></b>
  defines an abstract <a href="org/apache/lucene/analysis/Analyzer.html">Analyzer</a>
  API for converting text from a <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/io/Reader.html">java.io.Reader</a>
  into a <a href="org/apache/lucene/analysis/TokenStream.html">TokenStream</a>,
  an enumeration of&nbsp; <a href="org/apache/lucene/analysis/Token.html">Token</a>'s.&nbsp;
  A TokenStream is composed by applying <a href="org/apache/lucene/analysis/TokenFilter.html">TokenFilter</a>'s
  to the output of a <a href="org/apache/lucene/analysis/Tokenizer.html">Tokenizer</a>.&nbsp;
  A few simple implemenations are provided, including <a href="org/apache/lucene/analysis/StopAnalyzer.html">StopAnalyzer</a>
  and the grammar-based <a href="org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a>.</li>
  
  <li>
  <b><a href="org/apache/lucene/index/package-summary.html">com.lucene.index</a></b>
  provides two primary classes: <a href="org/apache/lucene/index/IndexWriter.html">IndexWriter</a>,
  which creates and adds documents to indices; and <a href="org/apache/lucene/index/IndexReader.html">IndexReader</a>,
  which accesses the data in the index.</li>
  
  <li>
  <b><a href="org/apache/lucene/search/package-summary.html">com.lucene.search</a></b>
  provides data structures to represent queries (<a href="org/apache/lucene/search/TermQuery.html">TermQuery</a>
  for individual words, <a href="org/apache/lucene/search/PhraseQuery.html">PhraseQuery</a>
  for phrases, and <a href="org/apache/lucene/search/BooleanQuery.html">BooleanQuery</a>
  for boolean combinations of queries) and the abstract <a href="org/apache/lucene/search/Searcher.html">Searcher</a>
  which turns queries into <a href="org/apache/lucene/search/Hits.html">Hits</a>.
  <a href="org/apache/lucene/search/IndexSearcher.html">IndexSearcher</a>
  implements search over a single IndexReader.</li>
  
  <li>
  <b><a href="org/apache/lucene/queryParser/package-summary.html">com.lucene.queryParser</a></b>
  uses <a href="http://www.suntest.com/JavaCC/">JavaCC</a> to implement a
  <a href="org/apache/lucene/queryParser/QueryParser.html">QueryParser</a>.</li>
  </ul>
  To use Lucene, an application should:
  <ol>
  <li>
  Create <a href="org/apache/lucene/document/Document.html">Document</a>'s by
  adding
  <a href="org/apache/lucene/document/Field.html">Field</a>'s.</li>
  
  <li>
  Create an <a href="org/apache/lucene/index/IndexWriter.html">IndexWriter</a>
  and add documents to to it with <a href="org/apache/lucene/index/IndexWriter.html#addDocument(com.lucene.document.Document)">addDocument()</a>;</li>
  
  <li>
  Call <a href="org/apache/lucene/queryParser/QueryParser.html#parse(java.lang.String)">QueryParser.parse()</a>
  to build a query from a string; and</li>
  
  <li>
  Create an <a href="org/apache/lucene/search/IndexSearcher.html">IndexSearcher</a>
  and pass the query to it's <a href="org/apache/lucene/search/Searcher.html#search(com.lucene.search.Query)">search()</a>
  method.</li>
  </ol>
  Some simple examples of code which does this are:
  <ul>
  <li>
  &nbsp;<a href="../demo/FileDocument.java">FileDocument.java</a> contains
  code to create a Document for a file.</li>
  
  <li>
  &nbsp;<a href="../demo/IndexFiles.java">IndexFiles.java</a> creates an
  index for all the files contained in a directory.</li>
  
  <li>
  &nbsp;<a href="../demo/DeleteFiles.java">DeleteFiles.java</a> deletes some
  of these files from the index.</li>
  
  <li>
  &nbsp;<a href="../demo/SearchFiles.java">SearchFiles.java</a> prompts for
  queries and searches an index.</li>
  </ul>
  To demonstrate these, try:
  <blockquote><tt>F:\> <b>java demo.IndexFiles rec.food.recipes\soups</b></tt>
  <br><tt>adding rec.food.recipes\soups\abalone-chowder</tt>
  <br><tt>&nbsp; </tt>[ ... ]
  <p><tt>F:\> <b>java demo.SearchFiles</b></tt>
  <br><tt>Query: <b>chowder</b></tt>
  <br><tt>Searching for: chowder</tt>
  <br><tt>34 total matching documents</tt>
  <br><tt>0. rec.food.recipes\soups\spam-chowder</tt>
  <br><tt>&nbsp; </tt>[ ... thirty-four documents contain the word "chowder",
  "spam-chowder" with the greatest density.]
  <p><tt>Query: <b>path:chowder</b></tt>
  <br><tt>Searching for: path:chowder</tt>
  <br><tt>31 total matching documents</tt>
  <br><tt>0. rec.food.recipes\soups\abalone-chowder</tt>
  <br><tt>&nbsp; </tt>[ ... only thrity-one have "chowder" in the "path"
  field. ]
  <p><tt>Query: <b>path:"clam chowder"</b></tt>
  <br><tt>Searching for: path:"clam chowder"</tt>
  <br><tt>10 total matching documents</tt>
  <br><tt>0. rec.food.recipes\soups\clam-chowder</tt>
  <br><tt>&nbsp; </tt>[ ... only ten have "clam chowder" in the "path"
field.
  ]
  <p><tt>Query: <b>path:"clam chowder" AND manhattan</b></tt>
  <br><tt>Searching for: +path:"clam chowder" +manhattan</tt>
  <br><tt>2 total matching documents</tt>
  <br><tt>0. rec.food.recipes\soups\clam-chowder</tt>
  <br><tt>&nbsp; </tt>[ ... only two also have "manhattan" in the contents.
  ]
  <br>&nbsp;&nbsp;&nbsp; [ Note: "+" and "-" are canonical, but "AND", "OR"
  and "NOT" may be used. ]</blockquote>
  The <a href="../demo/IndexHTML.java">IndexHtml</a> demo is more sophisticated.&nbsp;
  It incrementally maintains an index of HTML files, adding new files as
  they appear, deleting old files as they disappear and re-indexing files
  as they change.
  <blockquote><tt>F:\><b>java demo.IndexHTML -create java\jdk1.1.6\docs\relnotes</b></tt>
  <br><tt>adding java/jdk1.1.6/docs/relnotes/SMICopyright.html</tt>
  <br><tt>&nbsp; </tt>[ ... create an index containing all the relnotes
]
  <p><tt>F:\><b>del java\jdk1.1.6\docs\relnotes\smicopyright.html</b></tt>
  <p><tt>F:\><b>java demo.IndexHTML java\jdk1.1.6\docs\relnotes</b></tt>
  <br><tt>deleting java/jdk1.1.6/docs/relnotes/SMICopyright.html</tt></blockquote>
  HTML indexes are searched using SUN's <a href="http://jserv.javasoft.com/products/webserver/index.html">JavaWebServer</a>
  (JWS) and <a href="../demo/Search.jhtml">Search.jhtml</a>.&nbsp; To use
  this:
  <ul>
  <li>
  copy <tt>Search.html</tt> and <tt>Search.jhtml</tt> to JWS's <tt>public_html</tt>
  directory;</li>
  
  <li>
  copy lucene.jar to JWS's lib directory;</li>
  
  <li>
  create and maintain your indexes with demo.IndexHTML in JWS's top-level
  directory;</li>
  
  <li>
  launch JWS, with the <tt>demo</tt> directory on CLASSPATH (only one class
  is actually needed);</li>
  
  <li>
  visit <a href="../demo/Search.html">Search.html</a>.</li>
  </ul>
  Note that indexes can be updated while searches are going on.&nbsp; <tt>Search.jhtml</tt>
  will re-open the index when it is updated so that the latest version is
  immediately available.
  <br>&nbsp;
  </body>
  </html>
  
  
  
  1.4       +2 -3      jakarta-lucene/xdocs/stylesheets/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/xdocs/stylesheets/project.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- project.xml	2001/09/28 20:47:31	1.3
  +++ project.xml	2001/10/02 15:54:16	1.4
  @@ -1,6 +1,5 @@
   <?xml version="1.0" encoding="ISO-8859-1"?>
  -<project name="Jakarta Lucene"
  -        href="http://jakarta.apache.org/lucene/docs/">
  +<project name="Jakarta Lucene" href="http://jakarta.apache.org/lucene/">
   
       <title>Jakarta Lucene</title>
       <logo href="/images/lucene_green_300.gif">Jakarta Lucene</logo>
  @@ -17,7 +16,7 @@
       <menu name="Documentation">
           <item name="FAQ"               href="http://www.lucene.com/cgi-bin/faq/faqmanager.cgi"
target="_blank"/>
           <item name="Articles"          href="/resources.html"/>
  -        <item name="Javadoc"            href="./api/overview.html"/>
  +        <item name="Javadoc"            href="/api/index.html"/>
       </menu>
   
       <menu name="Download">
  
  
  

Mime
View raw message