Changeset 4915


Ignore:
Timestamp:
09/14/09 16:19:56 (3 years ago)
Author:
AndrewJones
Message:

Item1363: updated and simplified docs

Location:
trunk/SearchEngineKinoSearchAddOn/data/System
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/SearchEngineKinoSearchAddOn/data/System/KinoSearch.txt

    r4838 r4915  
    1111%WEBLIST{"     <option>$name</option>"}% 
    1212   </select> <p /> 
    13    %TWISTYBUTTON{ id="searchOptions" showlink="&#43; Show search options..." hidelink="&#8722; Hide search options" remember="on"}% 
     13   %TWISTYBUTTON{ id="searchOptions" showlink="<strong>&#43; Show search options...</strong>" hidelink="<strong>&#8722; Hide search options</strong>" remember="on"}% 
    1414   %TWISTYTOGGLE{ id="searchOptions" }% 
    1515   <br /> 

  • trunk/SearchEngineKinoSearchAddOn/data/System/SearchEngineKinoSearchAddOn.txt

    r4838 r4915  
    22%META:TOPICPARENT{name="Plugins"}% 
    33---+ Kino Search Engine Add-On 
     4 
    45%TOC% 
    56 
    6 [[http://www.rectangular.com/kinosearch/][KinoSearch]] is a Perl implementation of Lucene search engine (implemented 
    7 in Java). This is the base of this indexed search engine for Foswiki. With <nop>KinoSearch you create an index over all webs including attachments like Word, Excel and PDF. Based on that you get a really fast search over all topics and the attachments. You need this add-on 
    8    * if your wiki has grown so big, that normal search is too slow or 
    9    * if you want to do search not only on the topics but also the attachments. 
    10  
    11  
    12 ---++ Screenshot of a search results list 
     7[[http://www.rectangular.com/kinosearch/][KinoSearch]] is a Perl implementation of Lucene search engine (implemented in Java). This is the base of this indexed search engine for Foswiki. With !KinoSearch you create an index over all webs including attachments like Word, Excel and PDF. Based on that you get a really fast search over all topics and the attachments. You need this add-on if: 
     8   * your wiki has grown so big, that normal search is too slow or 
     9   * you want to do search not only on the topics but also the attachments. 
     10 
     11---++ Screenshot 
    1312 
    1413     <img src="%ATTACHURLPATH%/KinoSearchResult.jpg" alt="KinoSearchResult.jpg"   /> 
    1514 
    1615---++ Usage 
    17 See the KinoSearch topic for a quick Usage and setup. 
    18  
    19 ---+++ Searching with kinosearch 
    20  
    21 The ==kinosearch== script uses a template ==kinosearch.pattern.tmpl== (if you use the pattern skin). There is also a *KinoSearch* topic with a form ready to use with the *kinosearch* script. 
     16 
     17See the KinoSearch topic for user documentation. 
     18 
     19---+++ Searching With Kinosearch 
     20 
     21The ==kinosearch== script uses a template called ==kinosearch.tmpl== to render the results. You can override it in the same way as any other templates (i.e. create ==kinosearch.yourskin.tmpl==). 
     22 
     23There is also the *KinoSearch* topic with a form ready to use with the =kinosearch= script. 
    2224 
    2325If you have enabled the SearchEngineKinoSearchPlugin, you can use the rest handler either from a URL (this works only for a smaller wiki), or the command line. The syntax is identical to the =kinosearch= script. 
    … …  
    2527   * =cd foswiki/bin ; ./rest SearchEngineKinoSearchPlugin.search= 
    2628    
    27 The following form submits text to the ==kinosearch== script. The installation instructions are detailed below. 
     29The following form submits text to the =kinosearch= script. The installation instructions are detailed below. 
    2830 
    2931<form action="%SCRIPTURLPATH%/kinosearch%SCRIPTSUFFIX%/%INTURLENCODE{"%INCLUDINGWEB%"}%/"> 
    30    <input type="text" name="search" size="32" /> <input type="submit" value="Search text" /> | [[%SYSTEMWEB%.KinoSearch][Help]] 
     32   <input type="text" name="search" size="32" class="foswikiInputField" /> <input type="submit" value="Search text" class="foswikiSubmit" /> | [[%SYSTEMWEB%.KinoSearch][Help]] 
    3133</form> 
    3234 
    3335%INCLUDE{"VarKINOSEARCH"}% 
    3436 
    35 ---+++ (experimental) Integrating KinoSearch into Foswiki's internals =SEARCH=  
     37---+++ Integrating KinoSearch into Foswiki's Internal =SEARCH= (experimental) 
    3638 
    3739<div style="float:right"><a href="%ATTACHURLPATH%/KinoSEARCH.jpg"><img src="%ATTACHURLPATH%/KinoSEARCH.jpg" alt="integrated SEARCH results" width='400' /></a></div> 
    38  
    3940 
    4041By setting =$Foswiki::cfg{RCS}{SearchAlgorithm} = 'Foswiki::Store::SearchAlgorithms::Kino';= (a setting in the _Store settings_ section in =configure=),  
    … …  
    4546The reason this feature is experimental, is that kinosearch does not do partial matching, so searching for =TAG= will not match text like =%TAG{"something"}%=, only instances where the word TAG is seperated by whitespace. Foswiki's SEARCH expects total partial matching. 
    4647 
    47 ---++++ Query syntax 
    48  
    49    * To search for a word, just put that word into the Search box. (Alternatively, add the prefix ==text:== before the word.) 
    50    * To search for a phrase, put the phrase in "double quotes". 
    51    * Use the ==+== and ==-== operators, just as in Google query syntax, to indicate _required_ and _forbidden_ terms, respectively. 
    52    * To search on metadata, prefix the search term with ==field:== where _&lt;field&gt;_ is the field name in the metadata (for instance, _author_). 
    53  
    54 _NOTE_: !KinoSearch tries to split the single words from composed 
    55 things. Thus it reads "something-combined-together" as three words: 
    56 "something combined together". The same is true for combinations with 
    57 underscore. Thus "something_with_underscore" will be treated as 
    58 "something with underscore". This feature is extremely usefull, as you 
    59 can search for the single words and need not know the complete word 
    60 (Note: !KinoSearch has no possibility to search with wildcards!). But 
    61 of course you need to know about it. If you want so search for 
    62 "something-combined-together", you need to search for "something 
    63 combined together". If you add also the " to the search string, you 
    64 are sure, that the three words are in that order one after the other.  
    65  
    66 ---++++ Query examples 
    67  
    68    * ==text:kino== or just ==kino== 
    69    * ==text:"search engine"== or just =="search engine"== 
    70    * ==author:MarkusHesse== &mdash; note that to search for an author, use their login name 
    71    * ==form:WebFormName== to get all topics with that form attached. 
    72    * ==CONTACTINFO:MarkusHesse== if you have declared ==CONTACTINFO== as a variable to be indexed 
    73    * ==type:doc== to get all attachments of given type 
    74    * ==web:Main== to get all the topics in a given web 
    75    * ==topic:WebHome== to get all the topics of a given name 
    76    * ==+web:Sandbox +topic:Test== to get all the topics containing "Test" in their titles and belonging to the Sandbox web. 
    77  
    78 _Note:_ The current version of !KinoSearch does not support wildcards. 
    79  
    80 ---++++ RSS Feeds 
     48---+++ RSS Feeds 
    8149 
    8250RSS 2.0 feeds can be set up for any search results. To access the feed append =&rss=on;skin=none= to the end of the search url. There is a link to the feed from the results page in the default templates. 
    8351 
    8452---++ Indexing 
    85 __Note:__ The =kinoindex=, =kinoupdate= and =kinosearch= scripts will be deprecated over time in favour of the restHandlers, both for security reasons, and to make compatibility with Foswiki 1.0 easier. 
    86 ---+++ Creating a new Index 
     53 
     54---+++ Creating a New Index 
    8755 
    8856Each topic's text body, title, form fields and attached documents are indexed. 
    … …  
    9462If you have enabled the SearchEngineKinoSearchPlugin, you can use the rest handler either from a URL (this works only for a smaller wiki), or the command line 
    9563   * =%SCRIPTURL{rest}%/SearchEngineKinoSearchPlugin/index= 
    96    * =cd foswiki/bin ; ./rest SearchEngineKinoSearchPlugin.index= 
    97  
    98 ---+++ Updating your Index 
    99  
    100 The ==kinoupdate== script uses the web's ==.changes== files to know about topic modifications.  
    101 Also, a ==.kinoupdate== file is used on each web directory storing the last timestamp the script was run on it.  
    102 So when this script is executed, it first checks if there are any topic updates since last execution.  
    103 The most recent topic updates are removed from the index and then reindexed again. 
     64   * =cd foswiki/bin ; ./rest !SearchEngineKinoSearchPlugin.index= 
     65 
     66---+++ Updating the Index 
     67 
     68The ==kinoupdate== script uses the web's ==.changes== files to know about topic modifications. Also, a ==.kinoupdate== file is used on each web directory storing the last timestamp the script was run on it. So when this script is executed, it first checks if there are any topic updates since last execution. The most recent topic updates are removed from the index and then reindexed again. 
    10469   * =cd foswiki/kinosearch/bin ; ./kinoupdate= 
    10570 
    10671If you have enabled the SearchEngineKinoSearchPlugin, you can use the rest handler either from a URL (this works only for a smaller wiki), or the command line 
    10772   * =%SCRIPTURL{rest}%/SearchEngineKinoSearchPlugin/update= 
    108    * =cd foswiki/bin ; ./rest SearchEngineKinoSearchPlugin.update= 
     73   * =cd foswiki/bin ; ./rest !SearchEngineKinoSearchPlugin.update= 
    10974 
    11075This script should be executed by an hourly crontab. As before, this script has been placed out of the public bin folder. 
    11176<verbatim> 
    11277# m h  dom mon dow   command 
    113 35  *  *   *   *     cd /path/to/you/foswiki/bin ; ./rest SearchEngineKinoSearchPlugin.update 
     7835  *  *   *   *     cd /path/to/your/foswiki/bin ; ./rest SearchEngineKinoSearchPlugin.update 
    11479</verbatim> 
    11580 
    11681You can also optionally use SearchEngineKinoSearchPlugin's updateHandlers to automatically update the index whenever a topic is modified (or an attachment uploaded) by setting ={SearchEngineKinoSearchPlugin}{EnableOnSaveUpdates}= to true in the _Extensions_ section of configure. __Warning__ this can cause topic saves and attachments to become unacceptably slow, as the index update happens before the browser operation has completed. 
    11782 
    118 ---+++ Attachment file types to be indexed 
    119  
    120 All the PDF, HTML, DOC, XLS and text attachments are indexed by default. If you want to override this setting you can use a Foswiki preference ==KINOSEARCHINDEXEXTENSIONS==. You can copy & paste the next lines in your [[%USERSWEB%.SitePreferences]] topic 
    121 <verbatim> 
    122    * KinoSearch settings 
    123       * Set KINOSEARCHINDEXEXTENSIONS = .pdf, .html, .txt, .doc, .xls 
    124 </verbatim> 
    125 or whatever extensions you want. If you add other file extensions, they are treated as ASCII files. If needed, you can add more specialised stringifiers for further document types ( see [[SearchEngineKinoSearchAddOn#Indexing_further_document_types][Indexing further document types]]). 
    126  
    127 ---+++ Indexing of form fields 
     83---+++ Attachment File Types to be Indexed 
     84 
     85By default, the following file types are indexed: 
     86  * =.txt= 
     87  * =.html= 
     88  * =.xml= 
     89  * =.doc= 
     90  * =.docx= 
     91  * =.xls= 
     92  * =.xlsx= 
     93  * =.ppt= 
     94  * =.pptx= 
     95  * =.pdf= 
     96 
     97You can change this with the =$Foswiki::cfg{SearchEngineKinoSearchAddOn}{IndexExtensions}= setting in =configure=. 
     98 
     99If you add other file extensions, they are treated as ASCII files. If needed, you can add more specialised stringifiers for further document types ( see [[%TOPIC%#Indexing_further_document_types][Indexing further document types]]). 
     100 
     101---+++ Indexing of Form Fields 
    128102 
    129103All form fields are indexed. For this, the form templates are checked and the included fields are indexed. Additionally the name of the form of a topic is stored in the field =form_name=. How to search for this is described below. 
    130104 
    131  
    132 __Note__: With =kinoupdate= only the form fields that existed at the 
    133  time the initial index was created are indexed. Thus if you add a 
    134  form or if you add a new field to an existing form, you should create a new index with =kinoindex=. 
    135  
    136  
    137 ---++ Indexing further document types 
     105__Note__: With =kinoupdate= only the form fields that existed at the time the initial index was created are indexed. Thus if you add a form or if you add a new field to an existing form, you should create a new index with =kinoindex=. 
     106 
     107---++ Indexing Further Document Types 
    138108 
    139109The indexing of attached documents is realised in two steps:  
    140110   1 the content of the document is changed to an ASCII string. This is called stringification.  
    141    2 this ASCII string is indexed with <nop>KinoSearch. This is the normal way in all index applications.   
    142  
    143 To index different types of documents, it is necessary to have 
    144 specialised stringifiers, i.e. classes to extract the ASCII text out 
    145 of the document.  In this add-on, a plug-in mechanism is implemented, 
    146 so that additional stringifiers can be added without changing the 
    147 existing code. All stringifier plugins are stored in the directory 
    148 =lib/Foswiki/Contrib/KinoSearch/StringifierPlugins=.   
     111   1 this ASCII string is indexed with <nop>KinoSearch. This is the normal way in all index applications.   
     112 
     113To index different types of documents, it is necessary to have specialised stringifiers, i.e. classes to extract the ASCII text out of the document.  In this add-on, a plug-in mechanism is implemented, so that additional stringifiers can be added without changing the existing code. All stringifier plugins are stored in the directory =lib/Foswiki/Contrib/KinoSearch/StringifierPlugins=.  
    149114 
    150115You can add new stringifier plugins by just adding new files here. The minimum things to be implemented are: 
    … …  
    153118   * The plugin must implement the method =$text = stringForFile ($filename)= 
    154119 
    155 Then you should add to the list in =KINOSEARCHINDEXEXTENSIONS= in %USERSWEB%.SitePreferences. Now 
    156 the defined document type should be indexed and the new stringifier should be used.  
    157  
    158 NOTE: If you just extend the list without having a special stringifier 
    159 in place, this document type is treaded like an ASCII file. For binary 
    160 document types, this may lead to problems (inpropper search results, 
    161 long indexing times and potential indexing break downs).  
     120Then you should add to the list in =$Foswiki::cfg{SearchEngineKinoSearchAddOn}{IndexExtensions}= in =configure=. Now the defined document type should be indexed and the new stringifier should be used. 
     121 
     122NOTE: If you just extend the list without having a special stringifier in place, this document type is treaded like an ASCII file. For binary document types, this may lead to problems (inpropper search results, long indexing times and potential indexing break downs). 
    162123 
    163124---++ Add-On Installation Instructions 
    164125 
    165 __Note:__ You do not need to install anything on the browser to use 
    166 this add-on. The following instructions are for the administrator who 
    167 installs the add-on on the server where Foswiki is running.   
    168  
    169 ---+++ Backend for indexing Word documents 
    170  
    171 Install a backend to stringify Word documents if you want to index 
    172 Word documents. For this either install antiword, abiword or !wvWare. 
    173  
    174 __Note:__ This add-on comes with stringifiers for all three of 
    175 them. Depending on what is installed, the right stringifiers is used.  
    176  
    177 __Note2:__ If you install more than one of the three backends, you must select one of them in the configure ={SearchEngineKinoSearchAddOn}{WordIndexer}= setting. 
    178  
    179 __Note2:__ If you do not install any of the mentioned backends, you 
    180 should remove =.doc= from the =KINOSEARCHINDEXEXTENSIONS= variable.  
    181  
    182 To install antiword for Debian you can: 
    183    * =apt-get install antiword= 
    184  
    185 To install abiword for Debian you can: 
    186    * =apt-get install abiword= 
    187  
    188 To install !wvWare for Debian you can: 
    189    * =apt-get install wv= 
    190  
    191 ---+++ Backends for PDF, PPT 
    192  
    193 Install xpdf and ppthtml, if you want to index attached PDF and PPT files: 
    194    * For Debian you can use =apt-get install xpdf-utils ppthtml= 
    195    * If you do not install =xpdf=, you should remove =.pdf= from the =KINOSEARCHINDEXEXTENSIONS= variable. 
    196    * If you do not install =ppthtml=, you should remove =.ppt= from the =KINOSEARCHINDEXEXTENSIONS= variable. 
    197  
    198 ---+++ Installation of additional CPAN modules 
    199  
    200 You need to install the following modules: <nop>KinoSearch, 
    201  File::MMagic, Module::Pluggable, HTML::TreeBuilder and 
    202  Spreadsheet::ParseExcel 
    203  
    204 You can do that by running: 
    205 <noautolink> 
    206 <verbatim> 
    207 perl -MCPAN -e "install KinoSearch" 
    208 perl -MCPAN -e "install File::MMagic" 
    209 perl -MCPAN -e "install Module::Pluggable" 
    210 perl -MCPAN -e "install HTML::TreeBuilder" 
    211 perl -MCPAN -e "install Spreadsheet::ParseExcel" 
    212 perl -MCPAN -e "install CharsetDetector" 
    213 perl -MCPAN -e "install Encode" 
    214 </verbatim> 
    215 </noautolink> 
    216  
    217 _Note for Windows_: For Windows, make sure you have a C-compiler in place. This is normally part of Visual Studio etc.  
    218  
    219 ---+++ Installation of the add on itself 
    220  
    221 Like many other Foswiki extensions, this module is shipped with a automatic installer script written using the BuildContrib. 
     126---+++ Backend for Indexing Word 2003 Documents 
     127 
     128Install a backend to stringify Word documents if you want to index Word documents. For this either install antiword, abiword or !wvWare. 
     129 
     130__Note:__ This add-on comes with stringifiers for all three of them. Select the right stringifier is in =configure=. 
     131 
     132---+++ Backend for PDF 
     133 
     134To index =.pdf= files you need to install =xpdf-utils=. 
     135 
     136---+++ Backend for PPT 
     137 
     138To index =.ppt= files you need to install =ppthtml=. 
     139 
     140---+++ Backends for DOCX, PPTX 
     141 
     142To index these file types, you will need to install the following tools from Sourceforge: 
     143   * [[http://sourceforge.net/projects/docx2txt/][docx2txt]] for =.docx= 
     144   * [[http://sourceforge.net/projects/pptx2txt/][pptx2txt]] for =.pptx= 
     145 
     146Then set the command path to these tools in =configure=. 
     147 
     148_Note for Windows_: For Windows, make sure you have a C-compiler in place. This is normally part of Visual Studio. 
     149 
     150---+++ Instaling the !AddOn 
    222151 
    223152%$INSTALLER_INSTRUCTIONS% 
    224153 
    225    * use =configure= to configure the advanced features  
    226       * enable SearchEngineKinoSearchPlugin 
    227       * ={SearchEngineKinoSearchAddOn}{showAttachments}= 
    228       * ={SearchEngineKinoSearchPlugin}{EnableOnSaveUpdates}= 
    229       * ={SearchEngineKinoSearchAddOn}{WordIndexer}= 
    230       * =$Foswiki::cfg{RCS}{SearchAlgorithm} = 'Foswiki::Store::SearchAlgorithms::Kino';=  
    231       * <nop>Set <nop>SKIN=kino,%SKIN% 
    232  
    233  
    234 %$INSTALL_INSTRUCTIONS% 
    235  
    236154---+++ Configuration 
    237155 
    238 This add-on uses several preferences which should be set at [[%USERSWEB%.SitePreferences]]. All these preferences are optional. If you are fine with the default values given below, you need not change anything. 
    239 <verbatim> 
    240 (Note, these are not where the defaults are set) 
    241    *  KinoSearch settings 
    242       * Set KINOSEARCHINDEXEXTENSIONS = .pdf, .doc, .xml, .html, .txt, .xls, .ppt 
    243       * Set KINOSEARCHSEARCHATTACHMENTSONLY = 0 
    244       * Set KINOSEARCHSEARCHATTACHMENTSONLYLABEL = Display only attachments 
    245       * Set KINOSEARCHINDEXSKIPWEBS = Trash, Sandbox 
    246       * Set KINOSEARCHINDEXSKIPATTACHMENTS = Web.SomeTopic.AnAttachment.txt, Web.OtherTopic.OtherAttachment.pdf 
    247       * Set KINOSEARCHANALYSERLANGUAGE = en 
    248       * Set KINOSEARCHSUMMARYLENGTH = 300 
    249       * Set KINOSEARCHDEBUG = 0 
    250       * Set KINOSEARCHMAXLIMIT = 2000 
    251 </verbatim> 
    252  
    253 You can also =configure= (The Extensions:SearchEngineKinoSearchAddOn section) where the index and log files are created.  
    254 *Note*: The directories must exist.  
    255 <verbatim> 
    256 $Foswiki::cfg{KinoSearchLogDir} = '/home/httpd/foswiki/kinosearch/logs'; 
    257 $Foswiki::cfg{KinoSearchIndexDir} = '/home/httpd/foswiki/kinosearch/index'; 
    258 </verbatim> 
    259  
    260 Remember to edit the file ==kinosearch/bin/LocalLib.cfg== and modify ==foswikiLibPath== accordingly to your configuration 
    261  
    262 ---+++ Test of the installation 
     156There are a number of settings that need to be set in =configure=. 
     157 
     158You only need to enable the SearchEngineKinoSearchPlugin if you are using the =rest= handlers, or the =%<nop>KINOSEARCH%= macro. 
     159 
     160---+++ Test of the Installation 
    263161 
    264162   * Test if the installation was successful: 
    … …  
    271169      * Just type a query and check the results. 
    272170 
    273 ---+++ Test of stringification with =ks_test= 
    274  
    275 Some users report problems with the stringification: The =kinoindex= 
    276 scipts fails, takes too long on attachments or =kinosearch= does not yield correct 
    277 results. Some times this may result from installation errors esp. of 
    278 the installation of the backends for the stringification. 
    279  
    280 =ks_test= give you the opportunity to test the stringification in 
    281 advance. 
     171---+++ Test of Stringification with =ks_test= 
     172 
     173Some users report problems with the stringification: The =kinoindex= scipts fails, takes too long on attachments or =kinosearch= does not yield correct results. Some times this may result from installation errors esp. of the installation of the backends for the stringification. 
     174 
     175=ks_test= give you the opportunity to test the stringification in advance. 
    282176 
    283177Usage: =ks_test stringify file_name= 
    284178 
    285 (I plan to extend ks_test, but at the moment the only possible second 
    286 parameter is stringify). 
    287  
    288 In the result you see, which stringifier is used and the result of the 
    289 stringification. 
     179(I plan to extend ks_test, but at the moment the only possible second parameter is stringify). 
     180 
     181In the result you see, which stringifier is used and the result of the stringification. 
    290182 
    291183Example: 
    292184 
    293185<verbatim> 
    294 /home/httpd/foswiki/kinosearch/bin$ ./ks_test stringify /home/httpd/foswiki_svn/SearchEngineKinoSearchAddOn/test/unit/SearchEngineKinoSearchAddOn/attachement_examples/Simple_example.doc 
     186/path/to/foswiki/kinosearch/bin$ ./ks_test stringify /path/to/foswiki/SearchEngineKinoSearchAddOn/test/unit/SearchEngineKinoSearchAddOn/attachement_examples/Simple_example.doc 
    295187 
    296188Used stringifier: Foswiki::Contrib::SearchEngineKinoSearchAddOn::StringifyPlugins::DOC_antiword 
    … …  
    298190Stringified text: 
    299191 
    300   Simple example  Keyword: dummy  Umlaute: Größer, Überschall, Änderung 
     192  Simple example  Keyword: dummy  Umlaute: Grober, Uberschall, Anderung 
    301193</verbatim> 
    302194 
    303195You see that the stringifier DOC_antiword is used and the resulting 
    304 text seems to be O.K.  
     196text seems to be O.K. 
     197 
     198---+++ Upgrading From the TWiki Version 
     199 
     200If you previously used the TWiki version (< 1.21) of this !AddOn (either on TWiki or on Foswiki) then you will need to move your settings from [[%LOCALSITEPREFS%]] into =configure=. 
     201 
     202Also the following settings have been renamed, for consistency: 
     203 
     204   * =$Foswiki::cfg{KinoSearchLogDir}= => =$Foswiki::cfg{SearchEngineKinoSearchAddOn}{LogDirectory}= 
     205   * =$Foswiki::cfg{KinoSearchIndexDir}= => =$Foswiki::cfg{SearchEngineKinoSearchAddOn}{IndexDirectory}= 
    305206 
    306207---++ Add-On Info 
    307208 
     209<!-- 
    308210   * Set SHORTDESCRIPTION = Fast indexed SEARCH of topics and attachments (eg Word, Excel, PDF and PPT) 
    309  
    310 |  Add-on Author: | TWiki:Main/MarkusHesse and Foswiki:Main.SvenDowideit | 
    311 |  Add-on Version: | %$VERSION% | 
    312 |  Update note | If you update from an older version to v1.15 or higher, remove the old index and create a complete new one with kinoindex| 
     211--> 
     212 
     213|  Author(s): | Foswiki:Main.MarkusHesse and Foswiki:Main.SvenDowideit | 
     214|  Copyright:  | &copy; 2009, Foswiki:Main.MarkusHesse; &copy; 2009, Foswiki Contributors | 
     215|  Version: | %$VERSION% | 
    313216|  Change History: | <!-- versions below in reverse order -->&nbsp; | 
    314 |  24 Mar 2009:  | port to Foswiki -- Foswiki:Main.WillNorris | 
     217|   Sep 2009:  | v 1.21 Foswikitask:Item1363 - port to Foswiki; add stringifiers for =.docx=, =.pptx= and =.xlsx=; change the =kinosearch= script to work with [[Foswiki:Development.FoswikiStandAlone][FSA]]; Moved settings into =configure=; Commands now set in =configure=; Replaced =system()= calls with =Foswiki::Sandbox->sysCommand()=; updated and simplified docs; Foswikitask:Item8246 - fix checking of access controls -- Foswiki:Main.AndrewJones, Foswiki:Main.WillNorris | 
    315218|  06 Nov 2008:  | v 1.20, minor revert to stop crash | 
    316219|  05 Nov 2008:  | v 1.19, fixes for (nex)twiki/trunk | 
    317220|  20 Aug 2008:  | v 1.18, added Integrated SEARCH, SearchEngineKinoSearchPlugin, restHandlers, updated code and tests -- TWiki:Main.SvenDowideit | 
    318 |  6 Aug 2008:   | v 1.17, Bugs:Item5717: persist use form choices, Bugs:Item5647: cope better with attachment problems -- TWiki:Main.SvenDowideit | 
    319 |  4 Jun 2008:   | v 1.16, Bugs:Item5646: Problem with attachments with capital letter suffix | 
    320 |  12 May 2008:  | v 1.15, Bugs:Item5579, Bugs:Item5580, Bugs:Item5619: Problem with ALLOWWEBVIEW and Forms fixed | 
    321 |  23 Apr 2008:  | v 1.14, Bugs:Item5273, Bugs:Item5546, Bugs:Item5550, Bugs:Item5552: Use current user in search script | 
    322 |  27 Jan 2008:  | v 1.13, Bugs:Item5271: Option "show locked topics" now works | 
    323 |  19 Jan 2008:  | v 1.12, Bugs:Item5270: Enhancement of stringifiers | 
     221|  6 Aug 2008:   | v 1.17, TWikibug:Item5717: persist use form choices, TWikibug:Item5647: cope better with attachment problems -- TWiki:Main.SvenDowideit | 
     222|  4 Jun 2008:   | v 1.16, TWikibug:Item5646: Problem with attachments with capital letter suffix | 
     223|  12 May 2008:  | v 1.15, TWikibug:Item5579, TWikibug:Item5580, TWikibug:Item5619: Problem with ALLOWWEBVIEW and Forms fixed | 
     224|  23 Apr 2008:  | v 1.14, TWikibug:Item5273, TWikibug:Item5546, TWikibug:Item5550, TWikibug:Item5552: Use current user in search script | 
     225|  27 Jan 2008:  | v 1.13, TWikibug:Item5271: Option "show locked topics" now works | 
     226|  19 Jan 2008:  | v 1.12, TWikibug:Item5270: Enhancement of stringifiers | 
    324227|  19 Dec 2007:  | v 1.11, Additions on stringifiers, modification of output format | 
    325228|  17 Nov 2007:  | v 1.10, PPT stringifier added | 
    … …  
    327230|  3 Nov 2007:  | v 1.08, Some bugfixing | 
    328231|  7 Oct 2007:  | v 1.07, Some bugfixing | 
    329 |  6 Oct 2007:  | v 1.06, Upgrade for 4.1, Release with <nop>BuildContrib| 
     232|  6 Oct 2007:  | v 1.06, Upgrade for 4.1, Release with Foswiki:Extensions.BuildContrib | 
    330233|  29 Sep 2007: | v 1.05, Indexing of form fields | 
    331234|  16 Sep 2007: | v 1.04, Stringifier plugins for doc, xls and html | 
    … …  
    334237|  24 Aug 2007: | v 1.01, Update script included, Result uses highlighter | 
    335238|  14 Aug 2007: | Initial version (v1.000) | 
    336 |  CPAN Dependencies: | CPAN:KinoSearch | 
    337 |                                | CPAN:File::MMagic | 
    338 |                                | CPAN:Module::Pluggable | 
    339 |                                | CPAN:HTML::TreeBuilder | 
    340 |                                | CPAN:Spreadsheet::ParseExcel | 
    341 |                                | CPAN:CharsetDetector | 
    342 |                                 | CPAN:Encode | 
    343 |  Other Dependencies: | pdftotext (part of xpdf-utils) | 
    344 |                                 | antiword, abiword or !wvWare | 
    345 |                                 | ppthtml  | 
    346 |  Perl Version: | Tested with 5.8.0 | 
    347 |  License: | GPL | 
     239|  Dependencies: | %$DEPENDENCIES% | 
    348240|  Add-on Home: | http://foswiki.org/Extensions/%TOPIC% | 
    349 |  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev | 
    350 |  Appraisal: | http://foswiki.org/Extensions/%TOPIC%Appraisal | 
    351  
    352  
    353  
     241|  Support: | http://foswiki.org/Support/%TOPIC% | 
    354242 
    355243%META:FILEATTACHMENT{name="KinoSearchResult.jpg" attachment="KinoSearchResult.jpg" attr="" comment="" date="1208389508" path="KinoSearchResult.jpg" size="112106" stream="KinoSearchResult.jpg" tmpFilename="" user="ProjectContributor" version="1"}% 

  • trunk/SearchEngineKinoSearchAddOn/data/System/SearchEngineKinoSearchPlugin.txt

    r4838 r4915  
    55_A plugin wrapper around the SearchEngineKinoSearchAddOn_ 
    66 
    7 Allows embedding a KinoSearch in any page with a custom format it will automatically update the index when saving, 
    8 renaming or adding an attachment. 
     7Allows embedding a !KinoSearch in any page with a custom format it will automatically update the index when saving, renaming or adding an attachment. 
    98 
    109It can take a long time to update when dealing with large attachments 
    1110 
    12 This Plugin now also adds restHandlers to index, update and search the kinoIndex - removing the need for external scripts. 
     11This Plugin also adds restHandlers to index, update and search the index. In the future, these will replace the custom scripts provided by SearchEngineKinoSearchAddOn. 
    1312 
    1413%TOC% 
    … …  
    2625    
    2726---++ Rest Handler Usage (the rest handlers require that you are logged in) 
    28 These restHandlers can be called from te browser, or from the comman line 
    29 (best done as the user that the web server is run as to make sure permissions are ok) - and thus from cron. 
     27 
     28These restHandlers can be called from the browser, or from the command line (best done as the user that the web server is run as to make sure permissions are ok) - and thus from cron. 
     29 
    3030---+++ create Index 
     31 
    3132   * %SCRIPTURL{rest}%/SearchEngineKinoSearchPlugin/index 
    3233   * cd foswiki/bin ; rest SearchEngineKinoSearchPlugin.index 
     34 
    3335---+++ update Index 
     36 
    3437%SCRIPTURL{rest}%/SearchEngineKinoSearchPlugin/update 
     38 
    3539---+++ search Index 
    36 __TODO:__ while search works, the template it uses isn't useable as its tuned for the =kinosearch= cgi atm. 
     40 
     41__Note:__ the search rest handler will only be executed if you are authenticated. Currently it is probably better to use the =kinosearch= script with included with SearchEngineKinoSearchAddOn. 
    3742 
    3843%SCRIPTURL{rest}%/SearchEngineKinoSearchPlugin/search 
    … …  
    5459---++ Plugin Installation Instructions 
    5560 
    56 __Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the FoswWiki server.  
    57  
    58    * Download the ZIP file from the Plugin Home (see below) 
    59    * Unzip ==%TOPIC%.zip== in your foswiki installation directory. Content: 
    60      | *File:* | *Description:* | 
    61      | ==data/System/%TOPIC%.txt== | Plugin topic | 
    62      | ==data/System/%TOPIC%.txt,v== | Plugin topic repository | 
    63      | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module | 
    64    * Configure the Plugin: 
    65       * Change the Plugin settings as needed 
     61%$INSTALLER_INSTRUCTIONS% 
    6662 
    6763---++ Plugin Info 
    6864 
    6965|  Plugin Author: | TWiki:Main.DavidGuest and Foswikii:Main.SvenDowideit| 
    70 |  Copyright: | &copy; 2007, TWiki:Main.DavidGuest | 
     66|  Copyright: | &copy; 2007, TWiki:Main.DavidGuest; &copy; 2009, Foswiki Contributors | 
    7167|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | 
    72 |  Plugin Version: | 20 Aug 2008 (V1.200) | 
     68|  Plugin Version: | 24 Mar 2009 (V1.3) | 
    7369|  Change History: | <!-- versions below in reverse order -->&nbsp; | 
    74 |  24 Mar 2009: | port to Foswiki  -- Foswiki:Main.WillNorris | 
    75 |  20 Aug 2008: | Version 1.2, brought Plugin into SearchEngineKinoSearchAddOn package, and svn, and added restHandlers for indexing & searching - TWiki:Main.SvenDowideit | 
     70|  24 Mar 2009: | Version 1.3, port to Foswiki  -- Foswiki:Main.WillNorris | 
     71|  20 Aug 2008: | Version 1.2, brought Plugin into SearchEngineKinoSearchAddOn package, and svn, and added restHandlers for indexing & searching - Foswiki:Main.SvenDowideit | 
    7672|  09 Apr 2008: | Version 1.1, Added auto index updater code | 
    7773|  07 Apr 2008: | Initial version | 
    78 |  Foswiki Dependency: | $TWiki::Plugins::VERSION 2.0 | 
    79 |  CPAN Dependencies: | none | 
    80 |  Other Dependencies: | %SYSTEMWEB%.SearchEngineKinoSearchAddOn | 
    81 |  Perl Version: | 5.005 | 
     74|  Dependencies: | %SYSTEMWEB%.SearchEngineKinoSearchAddOn | 
    8275|  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% | 
    83 |  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev | 
     76|  Support: | http://foswiki.org/Support/%TOPIC% | 
    8477 
    8578__Related Topics:__ [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, SearchEngineKinoSearchAddOn 

  • trunk/SearchEngineKinoSearchAddOn/data/System/VarKINOSEARCH.txt

    r4838 r4915  
    33 
    44---+++ KINOSEARCH tag 
    5 If SearchEngineKinoSearchPlugin is enabled, you will be able to use the KINOSEARCH tag to search indexed topics and attachments: 
     5If the SearchEngineKinoSearchPlugin is enabled, you will be able to use the KINOSEARCH tag to search indexed topics and attachments: 
    66   * =%<nop>KINOSEARCH{'Search String' format='Formatting string'}%= 
    77    
Note: See TracChangeset for help on using the changeset viewer.