SearchEngineKinoSearchPlugin

A plugin wrapper around the SearchEngineKinoSearchAddOn

Allows embedding a KinoSearch in any page with a custom format it will automatically update the index when saving, renaming or adding an attachment.

It can take a long time to update when dealing with large attachments

This Plugin now also adds restHandlers to index, update and search the kinoIndex - removing the need for external scripts.

USAGE

Integrating KinoSearch into TWiki's internal SEARCH

By setting $TWiki::cfg{RCS}{SearchAlgorithm} = 'TWiki::Store::SearchAlgorithms::Kino'; (a setting in the Store settings section in configure), TWiki will use the KinoSearch index for any inbuilt search (including WebSearch) that it can (for regex searches it will fall back to the Forking search algorithm).

If you want TWiki's WebSearch to also show you attachment results (when you select the 'search all' option), you need to also set {SearchEngineKinoSearchAddOn}{showAttachments}=1, and add kino to the front of your SKIN setting.

KINOSEARCH{...} -- search indexed topics and attachments

• The %KINOSEARCH{...}% variable is handled by the SearchEngineKinoSearchPlugin.
• Syntax: %KINOSEARCH{ "search string" format="..." }%
• Parameters:

  "..."	Search string
  format="..."	Format of a search hit. Supported variables: • $icon - An icon to display file type when showing attachments • $match - The TWiki Name of the page being displayed • $locked - Show if a page is locked • $texthead - Summary text

• Category: SearchingAndListingVariables
• Related: SEARCH, SearchEngineKinoSearchAddOn, SearchEngineKinoSearchPlugin

Rest Handler Usage (the rest handlers require that you are logged into TWiki)

These restHandlers can be called from te browser, or from the comman line (best done as the user that the web server is run as to make sure permissions are ok) - and thus from cron.

create Index

• http://cds.unistra.fr/twiki/bin/rest/SearchEngineKinoSearchPlugin/index
• cd twiki/bin ; rest SearchEngineKinoSearchPlugin.index

update Index

http://cds.unistra.fr/twiki/bin/rest/SearchEngineKinoSearchPlugin/update

search Index

TODO: while search works, the template it uses isn't useable as its tuned for the kinosearch cgi atm.

http://cds.unistra.fr/twiki/bin/rest/SearchEngineKinoSearchPlugin/search

| Help

Monitoring the Indexing log

To monitor the log - following variables can be used to display the lines from indexing or update indexing log files.

• %KINOSEARCH_INDEXLOGFILE% - display the last 10 lines from most recent log file of kinoindex script
• %KINOSEARCH_UPDATELOGFILE% - display the last 10 lines from most recent log file of kinoupdate script

If installed correctly, please see the log files below

Indexing Log File lines

%KINOSEARCH_INDEXLOGFILE%

Update log File lines

%KINOSEARCH_UPDATELOGFILE%

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = A plugin wrapper around the SearchEngineKinoSearchAddOn

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

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 TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Install CPAN Perl module CPAN:File::Tail
• Unzip SearchEngineKinoSearchPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/SearchEngineKinoSearchPlugin.txt	Plugin topic
  data/TWiki/SearchEngineKinoSearchPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/SearchEngineKinoSearchPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • Change the Plugin settings as needed

Plugin Info

Plugin Author:	TWiki:Main.DavidGuest, TWiki:Main.SvenDowideit, TWiki:Main.SopanShewale
Copyright:	© 2007-2009 TWiki:Main.DavidGuest © 2009 Twiki, Inc © 2009-2012 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2012-11-13
Change History:
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable KINOSEARCH -- TWiki:Main.PeterThoeny
08 Oct 2009:	Version 1.3 Added Index/Update Indexing Log feature to the plugin
20 Aug 2008:	Version 1.2, brought Plugin into SearchEngineKinoSearchAddOn package, and svn, and added restHandlers for indexing & searching - TWiki:Main.SvenDowideit
09 Apr 2008:	Version 1.1, Added auto index updater code
07 Apr 2008:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	SearchEngineKinoSearchAddOn, CPAN:File::Tail
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, SearchEngineKinoSearchPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SearchEngineKinoSearchPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SearchEngineKinoSearchPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SearchEngineKinoSearchPluginAppraisal

Related Topics: VarKINOSEARCH, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, SearchEngineKinoSearchAddOn, VarSEARCH