SmiliesPlugin < TWiki/

---+ The Smilies Plugin <nop>:-)

Smilies are common in e-mail messages and bulletin board posts. They are used to convey an emotion, such as a smile :<nop>-) or a frown :<nop>-( . 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* |
| <nop>:-)        | %ATTACHURL%/smile.gif    | "smile" |
| <nop>:)         | %ATTACHURL%/smile.gif    | "smile" |
| <nop>8-)        | %ATTACHURL%/cool.gif     | "cool!" |
| <nop>:cool:     | %ATTACHURL%/cool.gif     | "cool!" |
| <nop>:-I        | %ATTACHURL%/indifferent.gif | "indifferent" |
| <nop>:(         | %ATTACHURL%/frown.gif    | "frown" |
| <nop>:-(        | %ATTACHURL%/frown.gif    | "frown" |
| <nop>:o         | %ATTACHURL%/redface.gif  | "embarrassment" |
| <nop>:D         | %ATTACHURL%/biggrin.gif  | "big grin" |
| <nop>:-D        | %ATTACHURL%/biggrin.gif  | "big grin" |
| <nop>;)         | %ATTACHURL%/wink.gif     | "wink" |
| <nop>;-)        | %ATTACHURL%/wink.gif     | "wink" |
| <nop>:p         | %ATTACHURL%/tongue.gif   | "stick out tongue" |
| <nop>:-p         | %ATTACHURL%/tongue.gif   | "stick out tongue" |
| <nop>:rolleyes: | %ATTACHURL%/rolleyes.gif | "roll eyes (sarcastic)" |
| <nop>:mad:      | %ATTACHURL%/mad.gif      | "mad!" |
| <nop>:eek:      | %ATTACHURL%/eek.gif      | "eek!" |
| <nop>:confused: | %ATTACHURL%/confused.gif | "confused" |
| <nop>&nbsp;>:-) | %ATTACHURL%/devil.gif    | "hehe!" |
| <nop>:devil:    | %ATTACHURL%/devil.gif    | "hehe!" |
| <nop>&nbsp;>;-) | %ATTACHURL%/devilwink.gif | "hehe! (friendly)" |
| <nop>:devilish: | %ATTACHURL%/devilwink.gif | "hehe! (friendly)" |
| <nop>:-X        | %ATTACHURL%/sealed.gif   | "sealed lips" |
| <nop>:ok:       | %ATTACHURL%/thumbs.gif   | "thumbs up" |
| <nop>:yes:      | %ATTACHURL%/yes.gif      | "yes" |
| <nop>:no:       | %ATTACHURL%/no.gif       | "no" |
| <nop>:love:     | %ATTACHURL%/love.gif     | "in love" |
| <nop>:scull:    | %ATTACHURL%/scull.gif    | "scull" |


---++ <nop>%TOPIC% Global Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==

   * One line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Render smilies as icons, like =&nbsp;:-)= for :-) or =&nbsp;: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: ==%WEB%.SmiliesPlugin==
      * #Set TOPIC = TWiki.SmiliesPlugin

   * The way the _emoticon_ is displayed. You can use ==$emoticon== (e.g. =:<nop>D=), ==$url== (e.g. =%<nop>ATTACHURL%/biggrin.gif=) and ==$tooltip== (e.g. ="big grin"=). Default: ==&lt;img src="$url" alt="$tooltip" title="$tooltip" border="0" /&gt;==
<verbatim>
      * #Set FORMAT = <img src="$url" alt="$emoticon" title="$emoticon" border="0" />
</verbatim>


---++ Plugin Installation Instructions

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
     | ==pub/TWiki/%TOPIC%/*.gif== | Plugin icon files |
   * Test if the plugin is correctly installed:
      * You will see a series of icons on next line: <br />
        :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: >:-) >;-) :-X :ok: :yes: :no: :love: :scull:

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
|  Plugin Version: | 21 Aug 2004 (v1.003) |
|  Change History: | <!-- specify latest version first -->&nbsp; |
|  21 Aug 2004: | Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "scull" |
|  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 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins

-- TWiki:Main.AndreaSterbini - 28 Dec 2000 <br />
-- TWiki:Main.PeterThoeny - 21 Aug 2004
This topic: TWiki/ > SmiliesPlugin
Topic revision: r3 - 21 Aug 2004 - 18:46:12 - PeterThoeny
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback