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> "razz (stick out tongue)" </td>
  77   </tr>
  78   <tr>
  79     <td> :rolleyes: </td>
  80     <td><img alt="rolleyes.gif" src="http://www.dementia.org/twiki//view/rolleyes.gif" /></td>
  81     <td> "roll eyes (sarcastic)" </td>
  82   </tr>
  83   <tr>
  84     <td> :mad: </td>
  85     <td><img alt="mad.gif" src="http://www.dementia.org/twiki//view/mad.gif" /></td>
  86     <td> "mad!" </td>
  87   </tr>
  88   <tr>
  89     <td> :eek: </td>
  90     <td><img alt="eek.gif" src="http://www.dementia.org/twiki//view/eek.gif" /></td>
  91     <td> "eek!" </td>
  92   </tr>
  93   <tr>
  94     <td> :confused: </td>
  95     <td><img alt="confused.gif" src="http://www.dementia.org/twiki//view/confused.gif" /></td>
  96     <td> "confused" </td>
  97   </tr>
  98 </table>
  99
 100 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
 101
 102 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>
 103
 104 - One line description, shown in the [[TextFormattingRules]] topic:
 105   - Set SHORTDESCRIPTION = Render smilies as icons, like ` :-)` for :-) or ` :cool:` for :cool:
 106
 107 - Set DEBUG to 1 to get debug messages in `data/debug.txt`. Default: `0`
 108   - Set DEBUG = 0
 109
 110 - The name of the topic containig your Smilies. Default: <code>**%WEB%.SmiliesPlugin**</code>
 111   - #Set TOPIC = [[SmiliesPlugin]]
 112
 113 - 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" /&gt;**</code>
 114
 115           * #Set FORMAT = <img src="$url" alt="$emoticon" />
 116
 117 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 118
 119 - Download the ZIP file from the Plugin web (see below)
 120 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
 121   <tr>
 122     <th bgcolor="#99CCCC"><strong> File: </strong></th>
 123     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 124   </tr>
 125   <tr>
 126     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
 127     <td> Plugin topic </td>
 128   </tr>
 129   <tr>
 130     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
 131     <td> Plugin topic repository </td>
 132   </tr>
 133   <tr>
 134     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
 135     <td> Plugin Perl module </td>
 136   </tr>
 137   <tr>
 138     <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
 139     <td> Plugin icon files </td>
 140   </tr>
 141 </table>
 142 - Test if the plugin is correctly installed:
 143   - You will see a series of icons on next line: <br /> :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused:
 144
 145 ## <a name="Plugin Info"></a> Plugin Info
 146
 147 <table border="1" cellpadding="0" cellspacing="0">
 148   <tr>
 149     <td align="right"> Plugin Author: </td>
 150     <td>[[TWiki/AndreaSterbini]]</td>
 151   </tr>
 152   <tr>
 153     <td align="right"> Plugin Version: </td>
 154     <td> 26 Feb 2003 </td>
 155   </tr>
 156   <tr>
 157     <td align="right"> Change History: </td>
 158     <td>  </td>
 159   </tr>
 160   <tr>
 161     <td align="right"> 26 Feb 2003: </td>
 162     <td> Added "indifferent" smilie </td>
 163   </tr>
 164   <tr>
 165     <td align="right"> 20 Oct 2002: </td>
 166     <td> Fixed STDERR warning for non-initialized Plugin </td>
 167   </tr>
 168   <tr>
 169     <td align="right"> 20 Apr 2002: </td>
 170     <td> Improved performance; removed non-standard Plugin API dependencies; added standard plugin topic content -- [[TWiki/PeterThoeny]]</td>
 171   </tr>
 172   <tr>
 173     <td align="right"> 23 Nov 2001: </td>
 174     <td> Added TOPIC and FORMAT setting </td>
 175   </tr>
 176   <tr>
 177     <td align="right"> 10 Jun 2001: </td>
 178     <td> Packaged into ZIP </td>
 179   </tr>
 180   <tr>
 181     <td align="right"> 28 Feb 2001: </td>
 182     <td> Initial version </td>
 183   </tr>
 184   <tr>
 185     <td align="right"> CPAN Dependencies: </td>
 186     <td> none </td>
 187   </tr>
 188   <tr>
 189     <td align="right"> Other Dependencies: </td>
 190     <td> none </td>
 191   </tr>
 192   <tr>
 193     <td align="right"> Perl Version: </td>
 194     <td> 5.0 </td>
 195   </tr>
 196   <tr>
 197     <td align="right"> Plugin Home: </td>
 198     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 199   </tr>
 200   <tr>
 201     <td align="right"> Feedback: </td>
 202     <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>
 203   </tr>
 204 </table>
 205
 206 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
 207
 208 -- [[AndreaSterbini]] - 28 Dec 2000 <br /> -- [[PeterThoeny]] - 26 Feb 2003