Menu
▾
▴
[ jEdit-commits ] SF.net SVN: jedit:[16711] plugins/LucenePlugin/trunk/docs/LucenePlugin.html
|
From: <sh...@us...> - 2009-12-23 02:01:46
|
Revision: 16711
http://jedit.svn.sourceforge.net/jedit/?rev=16711&view=rev
Author: shlomy
Date: 2009-12-23 02:01:37 +0000 (Wed, 23 Dec 2009)
Log Message:
-----------
Added some usage documentation.
Modified Paths:
--------------
plugins/LucenePlugin/trunk/docs/LucenePlugin.html
Modified: plugins/LucenePlugin/trunk/docs/LucenePlugin.html
===================================================================
--- plugins/LucenePlugin/trunk/docs/LucenePlugin.html 2009-12-23 01:09:29 UTC (rev 16710)
+++ plugins/LucenePlugin/trunk/docs/LucenePlugin.html 2009-12-23 02:01:37 UTC (rev 16711)
@@ -4,6 +4,90 @@
</head>
<body>
-Lucene plugin provides an interface to the Lucene engine.
+LucenePlugin provides an interface to the Lucene engine.
+Information about Lucene is available on the
+<a href="http://lucene.apache.org/java/docs">Lucene website</a>.
+<p>
+The plugin allows you to create a Lucene index, using one of the built-in
+analyzers, and then search the index. Once created, the index remains updated
+when the files in it are changed.
+</p>
+<p>
+<h3> Creating an index: </h3>
+<ol>
+<li>
+Select the files to index.
+<ul>
+<li>
+To create an index for a project, right-click the project in the ProjectViewer
+dockable window, and select "Create/update Lucene index for project".
+<li>
+To create an index for a directory tree, right-click the root of the directory
+tree in the File System Browser dockable window, and select Plugins ->
+LucenePlugin -> Add selected file(s) to a new index.<br>
+You can later add more files / directories to an existing index by selecting
+"Add selected file(s) to an existing index".
+</ul>
+<li>
+The "New Lucene Index" dialog will show up. Fill-in the details.
+<ol>
+<li>
+If this is not a project index, specify the index name.
+<li>
+Select the type of index: Line-based or file-based. A file-based index creates
+a Lucene document for each file, whereas a line-based index creates a Lucene
+document for each line in each file. A line-based index is a lot larger than
+a file-based index; its only advantage is that there is no need to scan the file
+again later to find which lines contain the words you search for. Both types of
+index can produce the line numbers where the words occur, but the file-based
+index will require an additional scan of the files containing the words in order
+to produce the line numbers. A line-based index may be appropriate if you're
+indexing network files with very slow access.
+<li>
+Select the analyzer to use for indexing. If you are not familiar with analyzers,
+use "Java identifier" for source code, which allows you to look for precise
+identifier occurrences, and "Standard" for text, or check the Lucene website for
+information about the other analyzers.
+</ol>
+<li>
+Click Ok to start creating the index.
+</ol>
+</p>
+<p>
+<h3> Searching an index: </h3>
+<ol>
+<li>
+Open the "Search with Lucene" dockable window using Plugins -> LucenePlugin ->
+Search.
+<li>
+Select the index to search in the combo-box on the right of the dockable.
+<li>
+Specify the maximal number of results that you want to get for your search in
+the "Max results:" box.
+<li>
+If you'd like to see the line numbers where the search matches, select the
+'Line-based results' check-box. If the index is file-based, the files that
+match will be re-scanned to find the line numbers.
+<li>
+If you'd like to constrain the search to a specific file extension, enter the
+extension in the 'file type:' box.
+<li>
+Finally, enter the words to search for in the "Search for:" box. For those
+familiar with Lucene, this can be any Lucene query, not just words.
+Click [Enter] to perform the search.
+</ol>
+<p>
+The rightmost button in the dockable toggles between multiple results and a
+single-result, much like the "Hypersearch Results" dockable of jEdit. The
+button to its left clears all previous results that are currently shown.
+</p>
+<p>
+While an index is being created or updated, the word "Indexing" will show on
+the right of the dockable when that index is selected for searching, so you
+know that the index is not yet complete.
+</p>
+<h3> Deleting an index: </h3>
+Select Plugins -> Lucene -> Delete an index, then select the index you'd like to
+delete.
</body>
</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|