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		"stick out tongue"
:-p		"stick out tongue"
:rolleyes:		"roll eyes (sarcastic)"
:mad:		"mad!"
:eek:		"eek!"
:confused:		"confused"
>:-)		"hehe!"
:devil:		"hehe!"
>;-)		"hehe! (friendly)"
:devilish:		"hehe! (friendly)"
:-X		"sealed lips"
:ok:		"thumbs up"
:yes:		"yes"
:no:		"no"
:love:		"in love"
:skull:		"skull"

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 for  :eek:

• 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" title="$tooltip" border="0" />

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

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

  • (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the plugin is correctly installed:
  • You will see a series of icons on next line:
    

  Plugin Info

  Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
  Plugin Version:	1.004
  Change History:
  16 Mar 2005:	Fixed typo "scull"
  5 Mar 2005	1.004 Crawford Currie prepared for Dakar
  21 Nov 2004:	Added benchmarks (no code changes)
  21 Aug 2004:	Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "skull"
  16 Feb 2004:	Added "devil" and "devilwink" smilies (by TWiki:Main.CrawfordCurrie)
  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 -- TWiki:Main.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
  TWiki:Plugins/Benchmark:	GoodStyle 96%, FormattedSearch 98%, SmiliesPlugin 96%
  Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SmiliesPlugin
  Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SmiliesPluginDev
  Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SmiliesPluginAppraisal

  Related Topics: TWikiPreferences, TWikiPlugins