GoogleSearchPlugin

Overview

This plugin allows the topic creator to specify if he/she wants to create link to search in Google for the meaning of the topic. It divides the topic name into various parts for the search.

Syntax Rules

• %GOOGLE_SEARCH% creates a link to a Google search for the current topic.
• %GOOGLE_SEARCH{topic="AnyName"}% creates a link to a Google search on any topic or keyword in Wiki notation.

Examples

• %GOOGLE_SEARCH% returns:
  %GOOGLE_SEARCH%
• %GOOGLE_SEARCH{topic="AnyName"}% returns:
  %GOOGLE_SEARCH{topic="AnyName"}%

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Create Google search links in topics

• Debug plugin: (See output in data/debug.txt) set it to (0 or 1)
  • 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.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip GoogleSearchPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/GoogleSearchPlugin.txt	Plugin topic
    lib/TWiki/Plugins/GoogleSearchPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful: See examples above.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins