1 # <a name="The Smilies Plugin :-)"></a> The Smilies Plugin :-)
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.
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.
7 <table border="1" cellpadding="0" cellspacing="0">
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>
15 <td><img alt="smile.gif" src="http://www.dementia.org/twiki//view/smile.gif" /></td>
20 <td><img alt="smile.gif" src="http://www.dementia.org/twiki//view/smile.gif" /></td>
25 <td><img alt="cool.gif" src="http://www.dementia.org/twiki//view/cool.gif" /></td>
30 <td><img alt="cool.gif" src="http://www.dementia.org/twiki//view/cool.gif" /></td>
35 <td><img alt="indifferent.gif" src="http://www.dementia.org/twiki//view/indifferent.gif" /></td>
36 <td> "indifferent" </td>
40 <td><img alt="frown.gif" src="http://www.dementia.org/twiki//view/frown.gif" /></td>
45 <td><img alt="frown.gif" src="http://www.dementia.org/twiki//view/frown.gif" /></td>
50 <td><img alt="redface.gif" src="http://www.dementia.org/twiki//view/redface.gif" /></td>
51 <td> "embarrassment" </td>
55 <td><img alt="biggrin.gif" src="http://www.dementia.org/twiki//view/biggrin.gif" /></td>
60 <td><img alt="biggrin.gif" src="http://www.dementia.org/twiki//view/biggrin.gif" /></td>
65 <td><img alt="wink.gif" src="http://www.dementia.org/twiki//view/wink.gif" /></td>
70 <td><img alt="wink.gif" src="http://www.dementia.org/twiki//view/wink.gif" /></td>
75 <td><img alt="tongue.gif" src="http://www.dementia.org/twiki//view/tongue.gif" /></td>
76 <td> "stick out tongue" </td>
80 <td><img alt="tongue.gif" src="http://www.dementia.org/twiki//view/tongue.gif" /></td>
81 <td> "stick out tongue" </td>
85 <td><img alt="rolleyes.gif" src="http://www.dementia.org/twiki//view/rolleyes.gif" /></td>
86 <td> "roll eyes (sarcastic)" </td>
90 <td><img alt="mad.gif" src="http://www.dementia.org/twiki//view/mad.gif" /></td>
95 <td><img alt="eek.gif" src="http://www.dementia.org/twiki//view/eek.gif" /></td>
100 <td><img alt="confused.gif" src="http://www.dementia.org/twiki//view/confused.gif" /></td>
101 <td> "confused" </td>
105 <td><img alt="devil.gif" src="http://www.dementia.org/twiki//view/devil.gif" /></td>
110 <td><img alt="devil.gif" src="http://www.dementia.org/twiki//view/devil.gif" /></td>
115 <td><img alt="devilwink.gif" src="http://www.dementia.org/twiki//view/devilwink.gif" /></td>
116 <td> "hehe! (friendly)" </td>
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>
125 <td><img alt="sealed.gif" src="http://www.dementia.org/twiki//view/sealed.gif" /></td>
126 <td> "sealed lips" </td>
130 <td><img alt="thumbs.gif" src="http://www.dementia.org/twiki//view/thumbs.gif" /></td>
131 <td> "thumbs up" </td>
135 <td><img alt="yes.gif" src="http://www.dementia.org/twiki//view/yes.gif" /></td>
140 <td><img alt="no.gif" src="http://www.dementia.org/twiki//view/no.gif" /></td>
145 <td><img alt="love.gif" src="http://www.dementia.org/twiki//view/love.gif" /></td>
146 <td> "I love it!" </td>
150 <td><img alt="skull.gif" src="http://www.dementia.org/twiki//view/skull.gif" /></td>
155 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
157 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
159 - One line description, shown in the [[TextFormattingRules]] topic:
160 - Set SHORTDESCRIPTION = Render smilies as icons, like :-) for ` :-)` or :eek: for ` :eek:`
162 - The name of the topic containig your Smilies. Default: <code>**%WEB%.SmiliesPlugin**</code>
163 - #Set TOPIC = [[SmiliesPlugin]]
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>**<img src="$url" alt="$tooltip" title="$tooltip" border="0" />**</code>
167 * #Set FORMAT = <img src="$url" alt="$emoticon" title="$emoticon" border="0" />
169 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
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.
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">
176 <th bgcolor="#99CCCC"><strong> File: </strong></th>
177 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
180 <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
181 <td> Plugin topic </td>
184 <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
185 <td> Plugin topic repository </td>
188 <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
189 <td> Plugin Perl module </td>
192 <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
193 <td> Plugin icon files </td>
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: >:-) >;-) :-X :ok: :yes: :no: :love: :skull:
200 ## <a name="Plugin Info"></a> Plugin Info
202 <table border="1" cellpadding="0" cellspacing="0">
204 <td align="right"> Plugin Author: </td>
205 <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny </td>
208 <td align="right"> Copyright: </td>
209 <td> © 2001-2007, Andrea Sterbini, Peter Thoeny, TWiki Contributors </td>
212 <td align="right"> Plugin Version: </td>
213 <td> 21 Nov 2007 </td>
216 <td align="right"> Change History: </td>
220 <td align="right"> 21 Nov 2007: </td>
221 <td> Doc improvements </td>
224 <td align="right"> 16 Mar 2005: </td>
225 <td> Fixed typo "scull" </td>
228 <td align="center"> 5 Mar 2005 </td>
229 <td> 1.004 Crawford Currie prepared for Dakar </td>
232 <td align="right"> 21 Nov 2004: </td>
233 <td> Added benchmarks (no code changes) </td>
236 <td align="right"> 21 Aug 2004: </td>
237 <td> Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "skull" </td>
240 <td align="right"> 16 Feb 2004: </td>
241 <td> Added "devil" and "devilwink" smilies (by TWiki:Main.CrawfordCurrie) </td>
244 <td align="right"> 26 Feb 2003: </td>
245 <td> Added "indifferent" smilie </td>
248 <td align="right"> 20 Oct 2002: </td>
249 <td> Fixed STDERR warning for non-initialized Plugin </td>
252 <td align="right"> 20 Apr 2002: </td>
253 <td> Improved performance; removed non-standard Plugin API dependencies; added standard plugin topic content -- TWiki:Main.PeterThoeny </td>
256 <td align="right"> 23 Nov 2001: </td>
257 <td> Added TOPIC and FORMAT setting </td>
260 <td align="right"> 10 Jun 2001: </td>
261 <td> Packaged into ZIP </td>
264 <td align="right"> 28 Feb 2001: </td>
265 <td> Initial version </td>
268 <td align="right"> CPAN Dependencies: </td>
272 <td align="right"> Other Dependencies: </td>
276 <td align="right"> Perl Version: </td>
280 <td align="right"> TWiki:Plugins/Benchmark: </td>
281 <td>[[TWiki/GoodStyle]] 96%, [[TWiki/FormattedSearch]] 98%, [[Main/SmiliesPlugin]] 96% </td>
284 <td align="right"> Plugin Home: </td>
285 <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
288 <td align="right"> Feedback: </td>
289 <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>
292 <td align="right"> Appraisal: </td>
293 <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>
297 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]