Creating Emotion Sets for Joo!BB
Since version 0.5.5 emotions are manageable in a xml file only. Database is not more needed.
Here you can download the Sample Emotion Set Package.
How To?
Emotion sets in Joo!BB are located in "JOOMLA_ROOT/components/com_joobb/designs/smilies/*".
There are 3-4 steps creating a emotion set:
- Creating emotion set folder
- Creating a emotion set xml file
- Designing emotions
- Creating Translation(s) (optional)
1. Creating emotion set folder
For the first you need to create a unique folder. This folder stands for the name of your emotion set.
For example "joobb_sample".
2. Creating a emotion set xml file
In a second step a xml file is needed. The name of this file MUST be the same as the folder.
In this documentation "joobb_sample.xml" In the xml file are all important information stored.
There are for the first many standard tags also used creating templates in Joomla.
If you are not familiar to them, please check out tutorial how to create a template on www.joomla.org.
NOTE:
An installation of a emotion set will not work with the Joomla extensions installer!
There will be an Joo!BB installer provided in the future. At the moment you will need
to copy the whole folder in emotion set root folder.
Joo!BB emotion set sample xml file:
<?xml version=
"1.0" encoding=
"utf-8"?>
<install version=
"1.5" type=
"emotionset">
<!-- It is important to set type to "emotionset" -->
<name>Joo!BB - Emotion Set Sample</name>
<author>Joo!BB - Sample Author</author>
<creationDate>01/15/2008</creationDate>
<copyright>(C) 2007 Joo!BB. All rights reserved.</copyright>
<license>GNU/GPL</license>
<authoremail>n/a</authoremail>
<authorurl>http://www.sonixsoft.de</authorurl>
<version>1.0.0</version>
<description>Joo!BB - Sample Emotion Set for Joo!BB.</description>
<!-- This tag opens the emotion set container -->
<emotionset>
<!--
In the emotion tag you are able to set up the attributes needed to describe an emotion. There three of them.
1. filename: file name of the emotion image
2. codes: define the codes assigned to the emotion separated with comma
NOTE: the first code is the one, which will be added to the text by clicking an emotion on editing.
all others are optional codes. For example, when a user types the emotion code in the editor.
3. emotion: this is the description of the emotion. You can use a localisation string if you decided to
make you emotion set translateable or just use a simple string if not.
-->
<emotion filename="emotion_smile.png" codes=":smile:,:),:-)" emotion="JOOBB_EMOTIONSMILE" />
<!-- optional as a not translateable emotion -->
<emotion filename="emotion_smile.png" codes=":smile:,:),:-)" emotion="Smile" />
<!-- ... define all other emotions of your emotion set here ... -->
</emotionset>
</install>
3. Designing emotions
Sorry, but I'am not a designer. It's up to you creating nice smilies! All you need to know is, that you can
use all popular web formats (jpeg, gif, png etc.).
NOTE:
Please assign your image files correctly in the xml file!
4. Creating Translation(s) (optional)
Making your Emotion Set localizeable needs to create a localization folder. In this example "en-GB".
After that you have to create an ini file. It is importent that the name of this file is the same as
the Emotion Set folder (joobb_sample.ini). In this file you can make your translation as follow:
JOOBB_EMOTIONSMILE=Smile
... other strings to translate
NOTE:
Please save this file as UTF-8.
