Smilies Plugin

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
8-)	/pub/TWiki/SmiliesPlugin/cool.gif	"cool!"
:(	/pub/TWiki/SmiliesPlugin/frown.gif	"frown"
:)	/pub/TWiki/SmiliesPlugin/smile.gif	"smile"
:-(	/pub/TWiki/SmiliesPlugin/frown.gif	"frown"
:-)	/pub/TWiki/SmiliesPlugin/smile.gif	"smile"
:-D	/pub/TWiki/SmiliesPlugin/biggrin.gif	"big grin"
:-I	/pub/TWiki/SmiliesPlugin/indifferent.gif	"indifferent"
:-p	/pub/TWiki/SmiliesPlugin/tongue.gif	"stick out tongue"
:-X	/pub/TWiki/SmiliesPlugin/sealed.gif	"sealed lips"
:confused:	/pub/TWiki/SmiliesPlugin/confused.gif	"confused"
:cool:	/pub/TWiki/SmiliesPlugin/cool.gif	"cool!"
:D	/pub/TWiki/SmiliesPlugin/biggrin.gif	"big grin"
:devil:	/pub/TWiki/SmiliesPlugin/devil.gif	"hehe!"
:devilish:	/pub/TWiki/SmiliesPlugin/devilwink.gif	"hehe! (friendly)"
:eek:	/pub/TWiki/SmiliesPlugin/eek.gif	"eek!"
:love:	/pub/TWiki/SmiliesPlugin/love.gif	"in love"
:mad:	/pub/TWiki/SmiliesPlugin/mad.gif	"mad!"
:no:	/pub/TWiki/SmiliesPlugin/no.gif	"no"
:o	/pub/TWiki/SmiliesPlugin/redface.gif	"embarrassment"
:ok:	/pub/TWiki/SmiliesPlugin/thumbs.gif	"thumbs up"
:p	/pub/TWiki/SmiliesPlugin/tongue.gif	"stick out tongue"
:rolleyes:	/pub/TWiki/SmiliesPlugin/rolleyes.gif	"roll eyes (sarcastic)"
:scull:	/pub/TWiki/SmiliesPlugin/scull.gif	"scull"
:yes:	/pub/TWiki/SmiliesPlugin/yes.gif	"yes"
;)	/pub/TWiki/SmiliesPlugin/wink.gif	"wink"
;-)	/pub/TWiki/SmiliesPlugin/wink.gif	"wink"
>:-)	/pub/TWiki/SmiliesPlugin/devil.gif	"hehe!"
>;-)	/pub/TWiki/SmiliesPlugin/devilwink.gif	"hehe! (friendly)"

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 :cool:

• 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" 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

• Test if the plugin is correctly installed:
  • You will see a series of icons on next line:
    :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: >:-) >;-) :-X :ok: :yes: :no: :love: :scull:

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.AndreaSterbini - 28 Dec 2000
-- TWiki:Main.PeterThoeny - 21 Aug 2004