Description

The emoticons plugin expands emoticon references such as :) or ;) to images like and .

Installation and Setup

In your global /WEB-INF/plugin.properties file, add the following line:

emoticons=org.blojsom.plugin.emoticons.EmoticonsPlugin

You may then add "emoticons" to one of the flavor-based plugin chains. These plugin chains can be found in the individual blog's plugin.properties file. For example:

html.blojsom-plugin-chain=emoticons

The emoticons plugin has its own configuration file, emoticons.properties, that is referenced in /WEB-INF/web.xml.

<init-param>
    <param-name>plugin-emoticons</param-name>
    <param-value>emoticons.properties</param-value>
</init-param>

The emoticons.properties file will be located in the respective /WEB-INF/(blog-id) directory and contains key=value pairs like the following:

happy=/images/emoticons/happy.gif

sad=/images/emoticons/sad.gif

grin=/images/emoticons/grin.gif

love=/images/emoticons/love.gif

mischief=/images/emoticons/mischief.gif

cool=/images/emoticons/cool.gif

devil=/images/emoticons/devil.gif

silly=/images/emoticons/silly.gif

angry=/images/emoticons/angry.gif

laugh=/images/emoticons/laugh.gif

wink=/images/emoticons/wink.gif

blush=/images/emoticons/blush.gif

cry=/images/emoticons/cry.gif

confused=/images/emoticons/confused.gif

shocked=/images/emoticons/shocked.gif

plain=/images/emoticons/plain.gif

The directories referenced here are relative to the root context of the web application. They will be used in constructing the proper URL to the image by appending the proper image filename to the blog URL.

You may download the Jive Emoticons image pack for use in your weblog. Due to copyright restrictions, we cannot re-distribute the emoticons pack with blojsom. To use the Jive Emoticons image pack, unzip the jive-emoticons.zip and move the images sub-directory over to your web application's root context directory.

Usage and URL Parameters

Usage

The following table lists the strings that will generate the different image references.

URL Parameters

There are no URL parameters to control the operation of the emoticons plugin.