TWiki/SmiliesPlugin.mdwn

   1 # <a name="The Smilies Plugin :-)"></a> The Smilies Plugin :-)
   2
   3 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.
   4
   5 Here is the list of smilies supported by this plugin. To add others, attach new icons to this topic and tweak the table below.
   6
   7 <table border="1" cellpadding="0" cellspacing="0">
   8   <tr>
   9     <th bgcolor="#99CCCC"><strong> You type </strong></th>
  10     <th bgcolor="#99CCCC"><strong> You see </strong></th>
  11     <th bgcolor="#99CCCC"><strong> Emotion </strong></th>
  12   </tr>
  13   <tr>
  14     <td> :-) </td>
  15     <td><img alt="smile.gif" src="http://www.dementia.org/twiki//view/smile.gif" /></td>
  16     <td> "smile" </td>
  17   </tr>
  18   <tr>
  19     <td> :) </td>
  20     <td><img alt="smile.gif" src="http://www.dementia.org/twiki//view/smile.gif" /></td>
  21     <td> "smile" </td>
  22   </tr>
  23   <tr>
  24     <td> 8-) </td>
  25     <td><img alt="cool.gif" src="http://www.dementia.org/twiki//view/cool.gif" /></td>
  26     <td> "cool!" </td>
  27   </tr>
  28   <tr>
  29     <td> :cool: </td>
  30     <td><img alt="cool.gif" src="http://www.dementia.org/twiki//view/cool.gif" /></td>
  31     <td> "cool!" </td>
  32   </tr>
  33   <tr>
  34     <td> :-I </td>
  35     <td><img alt="indifferent.gif" src="http://www.dementia.org/twiki//view/indifferent.gif" /></td>
  36     <td> "indifferent" </td>
  37   </tr>
  38   <tr>
  39     <td> :( </td>
  40     <td><img alt="frown.gif" src="http://www.dementia.org/twiki//view/frown.gif" /></td>
  41     <td> "frown" </td>
  42   </tr>
  43   <tr>
  44     <td> :-( </td>
  45     <td><img alt="frown.gif" src="http://www.dementia.org/twiki//view/frown.gif" /></td>
  46     <td> "frown" </td>
  47   </tr>
  48   <tr>
  49     <td> :o </td>
  50     <td><img alt="redface.gif" src="http://www.dementia.org/twiki//view/redface.gif" /></td>
  51     <td> "embarrassment" </td>
  52   </tr>
  53   <tr>
  54     <td> :D </td>
  55     <td><img alt="biggrin.gif" src="http://www.dementia.org/twiki//view/biggrin.gif" /></td>
  56     <td> "big grin" </td>
  57   </tr>
  58   <tr>
  59     <td> :-D </td>
  60     <td><img alt="biggrin.gif" src="http://www.dementia.org/twiki//view/biggrin.gif" /></td>
  61     <td> "big grin" </td>
  62   </tr>
  63   <tr>
  64     <td> ;) </td>
  65     <td><img alt="wink.gif" src="http://www.dementia.org/twiki//view/wink.gif" /></td>
  66     <td> "wink" </td>
  67   </tr>
  68   <tr>
  69     <td> ;-) </td>
  70     <td><img alt="wink.gif" src="http://www.dementia.org/twiki//view/wink.gif" /></td>
  71     <td> "wink" </td>
  72   </tr>
  73   <tr>
  74     <td> :p </td>
  75     <td><img alt="tongue.gif" src="http://www.dementia.org/twiki//view/tongue.gif" /></td>
  76     <td> "stick out tongue" </td>
  77   </tr>
  78   <tr>
  79     <td> :-p </td>
  80     <td><img alt="tongue.gif" src="http://www.dementia.org/twiki//view/tongue.gif" /></td>
  81     <td> "stick out tongue" </td>
  82   </tr>
  83   <tr>
  84     <td> :rolleyes: </td>
  85     <td><img alt="rolleyes.gif" src="http://www.dementia.org/twiki//view/rolleyes.gif" /></td>
  86     <td> "roll eyes (sarcastic)" </td>
  87   </tr>
  88   <tr>
  89     <td> :mad: </td>
  90     <td><img alt="mad.gif" src="http://www.dementia.org/twiki//view/mad.gif" /></td>
  91     <td> "mad!" </td>
  92   </tr>
  93   <tr>
  94     <td> :eek: </td>
  95     <td><img alt="eek.gif" src="http://www.dementia.org/twiki//view/eek.gif" /></td>
  96     <td> "eek!" </td>
  97   </tr>
  98   <tr>
  99     <td> :confused: </td>
 100     <td><img alt="confused.gif" src="http://www.dementia.org/twiki//view/confused.gif" /></td>
 101     <td> "confused" </td>
 102   </tr>
 103   <tr>
 104     <td>  &gt;:-) </td>
 105     <td><img alt="devil.gif" src="http://www.dementia.org/twiki//view/devil.gif" /></td>
 106     <td> "hehe!" </td>
 107   </tr>
 108   <tr>
 109     <td> :devil: </td>
 110     <td><img alt="devil.gif" src="http://www.dementia.org/twiki//view/devil.gif" /></td>
 111     <td> "hehe!" </td>
 112   </tr>
 113   <tr>
 114     <td>  &gt;;-) </td>
 115     <td><img alt="devilwink.gif" src="http://www.dementia.org/twiki//view/devilwink.gif" /></td>
 116     <td> "hehe! (friendly)" </td>
 117   </tr>
 118   <tr>
 119     <td> :devilish: </td>
 120     <td><img alt="devilwink.gif" src="http://www.dementia.org/twiki//view/devilwink.gif" /></td>
 121     <td> "hehe! (friendly)" </td>
 122   </tr>
 123   <tr>
 124     <td> :-X </td>
 125     <td><img alt="sealed.gif" src="http://www.dementia.org/twiki//view/sealed.gif" /></td>
 126     <td> "sealed lips" </td>
 127   </tr>
 128   <tr>
 129     <td> :ok: </td>
 130     <td><img alt="thumbs.gif" src="http://www.dementia.org/twiki//view/thumbs.gif" /></td>
 131     <td> "thumbs up" </td>
 132   </tr>
 133   <tr>
 134     <td> :yes: </td>
 135     <td><img alt="yes.gif" src="http://www.dementia.org/twiki//view/yes.gif" /></td>
 136     <td> "yes" </td>
 137   </tr>
 138   <tr>
 139     <td> :no: </td>
 140     <td><img alt="no.gif" src="http://www.dementia.org/twiki//view/no.gif" /></td>
 141     <td> "no" </td>
 142   </tr>
 143   <tr>
 144     <td> :love: </td>
 145     <td><img alt="love.gif" src="http://www.dementia.org/twiki//view/love.gif" /></td>
 146     <td> "in love" </td>
 147   </tr>
 148   <tr>
 149     <td> :skull: </td>
 150     <td><img alt="skull.gif" src="http://www.dementia.org/twiki//view/skull.gif" /></td>
 151     <td> "skull" </td>
 152   </tr>
 153 </table>
 154
 155 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
 156
 157 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
 158
 159 - One line description, shown in the [[TextFormattingRules]] topic:
 160 - Set SHORTDESCRIPTION = Render smilies as icons, like ` :-)` for :-) or ` :cool:` for :cool:
 161
 162 - The name of the topic containig your Smilies. Default: <code>**%WEB%.SmiliesPlugin**</code>
 163 - #Set TOPIC = [[SmiliesPlugin]]
 164
 165 - The way the _emoticon_ is displayed. You can use <code>**$emoticon**</code> (e.g. `:D`), <code>**$url**</code> (e.g. `%ATTACHURL%/biggrin.gif`) and <code>**$tooltip**</code> (e.g. `"big grin"`). Default: <code>**&lt;img src="$url" alt="$tooltip" title="$tooltip" border="0" /&gt;**</code>
 166
 167        * #Set FORMAT = <img src="$url" alt="$emoticon" title="$emoticon" border="0" />
 168
 169 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 170
 171 This plugin is installed by default with a TWiki release. You should not need to install the plugin unless it is for an upgrade.
 172
 173 - Download the ZIP file from the Plugin web (see below)
 174 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
 175   <tr>
 176     <th bgcolor="#99CCCC"><strong> File: </strong></th>
 177     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 178   </tr>
 179   <tr>
 180     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
 181     <td> Plugin topic </td>
 182   </tr>
 183   <tr>
 184     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
 185     <td> Plugin topic repository </td>
 186   </tr>
 187   <tr>
 188     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
 189     <td> Plugin Perl module </td>
 190   </tr>
 191   <tr>
 192     <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
 193     <td> Plugin icon files </td>
 194   </tr>
 195 </table>
 196 - (Dakar) Visit `configure` in your TWiki installation, and enable the plugin in the \{Plugins\} section.
 197 - Test if the plugin is correctly installed:
 198 - You will see a series of icons on next line: <br /> :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: &gt;:-) &gt;;-) :-X :ok: :yes: :no: :love: :skull:
 199
 200 ## <a name="Plugin Info"></a> Plugin Info
 201
 202 <table border="1" cellpadding="0" cellspacing="0">
 203   <tr>
 204     <td align="right"> Plugin Author: </td>
 205     <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny </td>
 206   </tr>
 207   <tr>
 208     <td align="right"> Plugin Version: </td>
 209     <td> 1.004 </td>
 210   </tr>
 211   <tr>
 212     <td align="right"> Change History: </td>
 213     <td>  </td>
 214   </tr>
 215   <tr>
 216     <td align="right"> 16 Mar 2005: </td>
 217     <td> Fixed typo "scull" </td>
 218   </tr>
 219   <tr>
 220     <td align="center"> 5 Mar 2005 </td>
 221     <td> 1.004 Crawford Currie prepared for Dakar </td>
 222   </tr>
 223   <tr>
 224     <td align="right"> 21 Nov 2004: </td>
 225     <td> Added benchmarks (no code changes) </td>
 226   </tr>
 227   <tr>
 228     <td align="right"> 21 Aug 2004: </td>
 229     <td> Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "skull" </td>
 230   </tr>
 231   <tr>
 232     <td align="right"> 16 Feb 2004: </td>
 233     <td> Added "devil" and "devilwink" smilies (by TWiki:Main.CrawfordCurrie) </td>
 234   </tr>
 235   <tr>
 236     <td align="right"> 26 Feb 2003: </td>
 237     <td> Added "indifferent" smilie </td>
 238   </tr>
 239   <tr>
 240     <td align="right"> 20 Oct 2002: </td>
 241     <td> Fixed STDERR warning for non-initialized Plugin </td>
 242   </tr>
 243   <tr>
 244     <td align="right"> 20 Apr 2002: </td>
 245     <td> Improved performance; removed non-standard Plugin API dependencies; added standard plugin topic content -- TWiki:Main.PeterThoeny </td>
 246   </tr>
 247   <tr>
 248     <td align="right"> 23 Nov 2001: </td>
 249     <td> Added TOPIC and FORMAT setting </td>
 250   </tr>
 251   <tr>
 252     <td align="right"> 10 Jun 2001: </td>
 253     <td> Packaged into ZIP </td>
 254   </tr>
 255   <tr>
 256     <td align="right"> 28 Feb 2001: </td>
 257     <td> Initial version </td>
 258   </tr>
 259   <tr>
 260     <td align="right"> CPAN Dependencies: </td>
 261     <td> none </td>
 262   </tr>
 263   <tr>
 264     <td align="right"> Other Dependencies: </td>
 265     <td> none </td>
 266   </tr>
 267   <tr>
 268     <td align="right"> Perl Version: </td>
 269     <td> 5.0 </td>
 270   </tr>
 271   <tr>
 272     <td align="right"> TWiki:Plugins/Benchmark: </td>
 273     <td>[[TWiki/GoodStyle]] 96%, [[TWiki/FormattedSearch]] 98%, [[Main/SmiliesPlugin]] 96% </td>
 274   </tr>
 275   <tr>
 276     <td align="right"> Plugin Home: </td>
 277     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 278   </tr>
 279   <tr>
 280     <td align="right"> Feedback: </td>
 281     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
 282   </tr>
 283   <tr>
 284     <td align="right"> Appraisal: </td>
 285     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
 286   </tr>
 287 </table>
 288
 289 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]