- Timestamp:
- 11/25/08 00:57:30 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SearchEnginePluceneAddOn/data/Plugins/SearchEnginePluceneAddOn.txt
r878 r929 2 2 ---++ Plucene Search Engine Add-On 3 3 4 TWiki original search engine is a simple yet powerful tool. However, it can not search within attached documents. That has been discused in many topics in the Codev web: 5 * TWiki:Codev/ImprovedSearchByKeywordIndex 6 * TWiki:Codev/SearchAttachmentContent 7 * TWiki:Codev/SearchAttachments 8 * TWiki:SearchEngineVsGrepSearch 9 * and many others, just look at TWiki:Codev/SearchEnhancements which lists more than 100 topics about search issues 4 Foswiki original search engine is a simple yet powerful tool. However, it can not search within attached documents. 10 5 11 6 I'm not a Perl guru, however I found [[http://www.kasei.com/archives/001039.html][Plucene]], which is a Perl port of the java library [[http://jakarta.apache.org/lucene/][Lucene]], so I tried to implement a new search engine, using Plucene as its backend. … … 15 10 ---+++ Indexing with plucindex 16 11 17 The ==plucindex== script indexes all the content of your data folder, and it uses some TWiki code to retrieve the list of available webs and to retrieve their topic list. For each topic, the meta data is inspected and indexed, as the text body. Also, if the topic has attachments, those are indexed (see below for more details).12 The ==plucindex== script indexes all the content of your data folder, and it uses some Foswiki code to retrieve the list of available webs and to retrieve their topic list. For each topic, the meta data is inspected and indexed, as the text body. Also, if the topic has attachments, those are indexed (see below for more details). 18 13 19 14 By now, you should run this script manually after installation to create the index files used by ==plucsearch==. If you want, you can also schedule a weekly or monthly crontab job to create the index files again, or maybe execute it manually when you take down your server for maintenance tasks. It should not be invoked by browser. … … 51 46 ---+++ Attachment file types to be indexed 52 47 53 All the PDF, HTML and text attachments are also indexed by default. If you want to override this setting you can use a TWiki preference ==PLUCENEINDEXEXTENSIONS==. You can copy & paste the next lines in your [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] topic48 All the PDF, HTML and text attachments are also indexed by default. If you want to override this setting you can use a Foswiki preference ==PLUCENEINDEXEXTENSIONS==. You can copy & paste the next lines in your [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] topic 54 49 <verbatim> 55 50 * Plucene settings … … 62 57 ---++ Add-On Installation Instructions 63 58 64 __Note:__ You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the server where TWiki is running.59 __Note:__ You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the server where Foswiki is running. 65 60 66 61 * Once you have compiled and installed all the requirements … … 73 68 | ==templates/plucsearch.pattern.tmpl== | template used by new search script for the pattern skin | 74 69 | ==templates/plucsearch.tmpl== | template used by new search script for the standard skin | 75 | ==data/ TWiki/PluceneSearch.txt== | Plucene search topic |76 | ==data/ TWiki/PluceneSearch.txt,v== | Plucene search topic repository |77 | ==data/ Plugins/SearchEnginePluceneAddOn.txt== | Add-on topic |78 | ==data/ Plugins/SearchEnginePluceneAddOn.txt,v== | Add-on topic repository |70 | ==data/System/PluceneSearch.txt== | Plucene search topic | 71 | ==data/System/PluceneSearch.txt,v== | Plucene search topic repository | 72 | ==data/System/SearchEnginePluceneAddOn.txt== | Add-on topic | 73 | ==data/System/SearchEnginePluceneAddOn.txt,v== | Add-on topic repository | 79 74 | ==index/== | directory for index files to be stored | 80 * %RED% ATTENTION! %ENDCOLOR% Now the ==$idxpath== variable is loaded with the new TWikipreference ==PLUCENEINDEXPATH== value, so you should add to your [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] topic the next text75 * %RED% ATTENTION! %ENDCOLOR% Now the ==$idxpath== variable is loaded with the new System preference ==PLUCENEINDEXPATH== value, so you should add to your [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] topic the next text 81 76 <verbatim> 82 77 * Plucene settings … … 86 81 * change the working directory to your ==bin== twiki installation directory 87 82 * run ./plucindex 88 * once finished, open a browser window and point it to the == TWiki/PluceneSearch== topic83 * once finished, open a browser window and point it to the ==System/PluceneSearch== topic 89 84 * just type a query and check the results 90 85 * Just create a new hourly crontab entry for the ==bin/plucupdate== script.
Note: See TracChangeset
for help on using the changeset viewer.
