django-smileys

Django-smileys is a django application providing utilities to add smiley images in your templates.

Contents

Install
Examples
- Filter Usage
- Tag Usage
Settings

Install

Install the package in your PYTHON_PATH by getting the sources and run setup.py or use pip

$> pip install -e git://github.com/Fantomas42/django-smileys.git#egg=django-smileys

Then register the smileys app in your INSTALLED_APPS project's section.

Examples

Filter Usage

For our example we will make a template who display the field content of a model, this field has this value :

Coding is fun and sexy :D

So in our templates we will load the smiley_tags library and use the smileys filter :

{% load smiley_tags %}

{{ object.content|smileys }}

Which will render :

Coding is fun and sexy

Tag Usage

The smileys app also provides a tag named smileys for converting raw text.

{% load smiley_tags %}
{% smileys %}
Documenting is boring but usefull :p
{% endsmileys %}

Which will render :

Documenting is boring but usefull

Pretty easy, no ?

Settings

You can use differents settings for customizing the application.

SMILEYS_URL

The url where the smileys files are located, use this as default

os.path.join(settings.MEDIA_URL, 'smileys/'))

SMILEYS_CLASS

The class wo will be applied to the img markup of the smileys.

SMILEYS_LIST

The list of the smileys who will be converted. It's something like that

((':)', 'smile.gif'),
 (':D', 'mrgreen.gif'),
 (':(', 'sad.gif'),
 (':|', 'neutral.gif'),
 (';)', 'wink.gif'),
 (':p', 'razz.gif'),
 (':P', 'razz.gif'),
 (':o', 'surprised.gif'),
 (':O', 'surprised.gif'),
 (':s', 'confused.gif'),
 (':S', 'confused.gif'),
 (':$', 'confused.gif'),
 ('o_O', 'eek.gif'),
 )