The Smilies Plugin

Smilies are common in e-mail messages and bulletin board posts. They are used to convey an emotion, such as a smile :-) or a frown :-( . This plugin automatically converts certain smilies to a nice small icon.

Here is the list of smilies supported by this plugin. To add others, attach new icons to this topic and tweak the table below.

You type	You see	Emotion
:-)		"smile"
:)		"smile"
8-)		"cool!"
:cool:		"cool!"
:-I		"indifferent"
:(		"frown"
:-(		"frown"
:o		"embarrassment"
:D		"big grin"
:-D		"big grin"
;)		"wink"
;-)		"wink"
:p		"razz (stick out tongue)"
:rolleyes:		"roll eyes (sarcastic)"
:mad:		"mad!"
:eek:		"eek!"
:confused:		"confused"

SmiliesPlugin Global Settings

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

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Render smilies as icons, like  :-) for or  :cool: for

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

• The name of the topic containig your Smilies. Default: TWiki.SmiliesPlugin
  • #Set TOPIC = SmiliesPlugin

• The way the emoticon is displayed. You can use $emoticon (e.g. :D), $url (e.g. %ATTACHURL%/biggrin.gif) and $tooltip (e.g. "big grin"). Default: <img src="$url" alt="$tooltip" />

      * #Set FORMAT = <img src="$url" alt="$emoticon" />

Plugin Installation Instructions

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

  File:	Description:
  data/TWiki/SmiliesPlugin.txt	Plugin topic
  data/TWiki/SmiliesPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/SmiliesPlugin.pm	Plugin Perl module
  pub/TWiki/SmiliesPlugin/*.gif	Plugin icon files

• Test if the plugin is correctly installed:
  • You will see a series of icons on next line:
    

Plugin Info

Plugin Author:	AndreaSterbini
Plugin Version:	26 Feb 2003
Change History:
26 Feb 2003:	Added "indifferent" smilie
20 Oct 2002:	Fixed STDERR warning for non-initialized Plugin
20 Apr 2002:	Improved performance; removed non-standard Plugin API dependencies; added standard plugin topic content -- PeterThoeny
23 Nov 2001:	Added TOPIC and FORMAT setting
10 Jun 2001:	Packaged into ZIP
28 Feb 2001:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SmiliesPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SmiliesPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- AndreaSterbini - 28 Dec 2000
-- PeterThoeny - 26 Feb 2003