(r11) SmiliesPlugin < TWiki

TWiki Web>SmiliesPlugin (revision 11) (raw view)~~EditAttach~~
---+!! The Smilies Plugin <nop>:-)
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/SmiliesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/SmiliesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky>
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
</sticky>
%SHORTDESCRIPTION%

---++ Introduction

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.

---++ Smilies Table

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        | "I love it!" |
| <nop>:skull:    | %ATTACHURL%/skull.gif       | "dead!" |
| <nop>:red:      | %ATTACHURL%/red.gif         | "red" |
| <nop>:yellow:   | %ATTACHURL%/yellow.gif      | "yellow" |
| <nop>:green:    | %ATTACHURL%/green.gif       | "green" |
| <nop>:blue:     | %ATTACHURL%/blue.gif        | "blue" |

---++ <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 %SYSTEMWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Render smilies as icons, like =&nbsp;:-)= for :-) or =&nbsp;:eek:= for :eek:

   * The name of the topic containig your Smilies. Default: ==%WEB%.SmiliesPlugin==
      * Set TOPIC = %SYSTEMWEB%.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"=).%BR% Default: ==&lt;img src="$url" alt="$tooltip" title="$tooltip" border="0" /&gt;==
<verbatim>
      * Set FORMAT = <img src="$url" alt="$tooltip" title="$tooltip" border="0" />
</verbatim>

---++ Plugin Installation Instructions

This plugin is installed by default with a TWiki release. You should not need to install the plugin unless it is for an upgrade.

   * 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 |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
     | ==pub/TWiki/%TOPIC%/*.gif== | Plugin icon files |
   * 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: <br />
     :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: >:-) >;-) :-X :ok: :yes: :no: :love: :skull: :red: :green:

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
|  Copyright: | &copy; 2001-2007 Andrea Sterbini,%BR% &copy; 2001-2011 Peter Thoeny,%BR% &copy; 2001-2011 TWiki:TWiki.TWikiContributor |
|  Plugin Version: | 21625 (2011-08-20) |
|  Change History: | <!-- specify latest version first -->&nbsp; |
|  2011-07-09: | TWikibug:Item6725: Change global package variables from "use vars" to "our" |
|  2010-09-20: | TWikibug:Item6580: Added "red", "yellow", "green", "blue" smilies |
|  2010-05-15: | TWikibug:Item6433: Doc improvements; replacing TWIKIWEB with SYSTEMWEB |
|  21 Nov 2007: | Doc improvements |
|  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: | %SYSTEMWEB%.GoodStyle 96%, %SYSTEMWEB%.FormattedSearch 98%, SmiliesPlugin 96% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins
Topic revision: r11 - 2011-07-10 - TWikiContributor
TWiki
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.SmiliesPlugin.