Tags:
performance1Add my vote for this tag search3Add my vote for this tag create new tag
, view all tags

KinoSearchPlugin

Note: this Package is now obsolete, as it has been integrated into the SearchEngineKinoSearchAddOn package

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

WARNING: This is very new code, it works for me but I have not extensively tested it.

Syntax Rules

%KINOSEARCH{'Search String' format='Formatting string'}%

format takes the following variables to place content.

  • $icon - An icon to display filetype when showing attachments
  • $match - The Twiki Name of the page being displayed
  • $locked - Show if a page is locked
  • $texthead - Summary text

Plugin Settings

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

  • 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)
  • Unzip KinoSearchPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/KinoSearchPlugin.txt Plugin topic
    data/TWiki/KinoSearchPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/KinoSearchPlugin.pm Plugin Perl module
  • Configure the Plugin:
    • Change the Plugin settings as needed

Plugin Info

Plugin Author: TWiki:Main.DavidGuest
Copyright: © 2007, TWiki:Main.DavidGuest
License: GPL (GNU General Public License)
Plugin Version: V1.1
Change History:  
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
Perl Version: 5.005
Benchmarks: GoodStyle nn%, FormattedSearch nn%, KinoSearchPlugin nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/KinoSearchPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/KinoSearchPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/KinoSearchPluginAppraisal

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

Topic attachments
I Attachment History Action Size Date Who Comment
Compressed Zip archivetgz KinoSearchPlugin.tgz r2 r1 manage 3.3 K 2008-04-09 - 04:21 DavidGuest Version 1.1
Compressed Zip archivezip KinoSearchPlugin.zip r2 r1 manage 5.1 K 2008-04-09 - 04:21 DavidGuest Version 1.1
Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r6 - 2009-04-10 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.