Features

• Strict pattern matching: you can specify very strict patterns for your smileys

• Regular expression pattern matching: if you need a little more power in your pattern matching capabilities, you can specify that your patterns are regular expressions (on a per-smiley basis) and the filter should know what to do.

Requirements

This application was built on Django 1.0.2, and it should work with any version of Django that uses the admin.site.register method for telling the Django admin that a model should appear in the admin (as opposed to the class Admin: method).

Installation

Download django-smileys using one of the following methods:

easy_install django-smileys
pip install -U django-smileys

hg clone http://bitbucket.org/codekoala/django-smileys
git clone http://github.com/codekoala/django-smileys.git
hg clone http://django-smileys.googlecode.com/hg django-smileys

Configuration

First of all, you must add this project to your list of INSTALLED_APPS in settings.py:

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
    ...
    'smileys',
    ...
)

You can also define a path to upload smileys, instead of the default one.

SMILEYS_PATH = ‘your_path’ # defaults to ‘smiley’ is not set

Run manage.py syncdb. This creates a the table in your database that is necessary for operation.

Usage

Open the template file that you want to have your smileys appear in and make sure it has something like this in it:

{% load smiley_tags %}

{% block content %}
{{ some_content_var|smileys }}
{% endblock %}

The smiley_tags library provides you with a smileys filter, which will examine your database for all active smileys. It then runs though some_content_var (in this example) and replaces the patterns it finds with the respective smileys. More recent versions also contain a textile_smileys tag for users of Textile formatting. Pretty simple huh!

And useless! w00t.