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> "razz (stick out tongue)" </td>
80 <td><img alt="rolleyes.gif" src="http://www.dementia.org/twiki//view/rolleyes.gif" /></td>
81 <td> "roll eyes (sarcastic)" </td>
85 <td><img alt="mad.gif" src="http://www.dementia.org/twiki//view/mad.gif" /></td>
90 <td><img alt="eek.gif" src="http://www.dementia.org/twiki//view/eek.gif" /></td>
95 <td><img alt="confused.gif" src="http://www.dementia.org/twiki//view/confused.gif" /></td>
100 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
102 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
104 - One line description, shown in the [[TextFormattingRules]] topic:
105 - Set SHORTDESCRIPTION = Render smilies as icons, like ` :-)` for :-) or ` :cool:` for :cool:
107 - Set DEBUG to 1 to get debug messages in `data/debug.txt`. Default: `0`
110 - The name of the topic containig your Smilies. Default: <code>**%WEB%.SmiliesPlugin**</code>
111 - #Set TOPIC = [[SmiliesPlugin]]
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>**<img src="$url" alt="$tooltip" />**</code>
115 * #Set FORMAT = <img src="$url" alt="$emoticon" />
117 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
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">
122 <th bgcolor="#99CCCC"><strong> File: </strong></th>
123 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
126 <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
127 <td> Plugin topic </td>
130 <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
131 <td> Plugin topic repository </td>
134 <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
135 <td> Plugin Perl module </td>
138 <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
139 <td> Plugin icon files </td>
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:
145 ## <a name="Plugin Info"></a> Plugin Info
147 <table border="1" cellpadding="0" cellspacing="0">
149 <td align="right"> Plugin Author: </td>
150 <td>[[TWiki/AndreaSterbini]]</td>
153 <td align="right"> Plugin Version: </td>
154 <td> 26 Feb 2003 </td>
157 <td align="right"> Change History: </td>
161 <td align="right"> 26 Feb 2003: </td>
162 <td> Added "indifferent" smilie </td>
165 <td align="right"> 20 Oct 2002: </td>
166 <td> Fixed STDERR warning for non-initialized Plugin </td>
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>
173 <td align="right"> 23 Nov 2001: </td>
174 <td> Added TOPIC and FORMAT setting </td>
177 <td align="right"> 10 Jun 2001: </td>
178 <td> Packaged into ZIP </td>
181 <td align="right"> 28 Feb 2001: </td>
182 <td> Initial version </td>
185 <td align="right"> CPAN Dependencies: </td>
189 <td align="right"> Other Dependencies: </td>
193 <td align="right"> Perl Version: </td>
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>
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>
206 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
208 -- [[AndreaSterbini]] - 28 Dec 2000 <br /> -- [[PeterThoeny]] - 26 Feb 2003