GuestBookPlugin

The GuestBookPlugin gives a guestbook support on the TWiki. The guestbook is based on the Ardent PHP based guestbook. Captures the e-mail, url of the user along with the comment.

Syntax Rules

• Edit the topic where you want to display the Guest Book
• Write the word %GUEST_PLUGIN% in this Topic.
• Click Preview, you should see the Write the word %GUEST_PLUGIN% in this Topic.

Examples

• Refer to Demo URL for getting feel of the Plugin.

GuestBookPlugin Global 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 = This will create the guestbook on the TWiki site by writing just one word.

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

• My own setting:
  • Set GUESTBOOK_DIR = Directory Location to go here (e.g. /home/web/twiki/pub/main/guestbook)

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 server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip GuestBookPlugin.zip in your twiki installation directory. Content:

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

• Test if the installation was successful:
  • Configure the Plugin Settings and check the page where you want the guestbook to appear.

Plugin Info

Plugin Author:	TWiki:Main/RahulMundke, TWiki:Main/DevenPuri
Plugin Version:	20 Nov 2003 (V1.000)
Change History:
20 Nov 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/GuestBookPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/GuestBookPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/RahulMundke - 20 Nov 2003