django-idioticon

Idioticon is a module that allows to disseminate html templates with clickable question marks (idioticons)

Documentation

The full documentation is at https://django-idioticon.readthedocs.org.

Quickstart

Install django-idioticon:

pip install idioticon

Add idioticon to settings.INSTALLED_APPS, then use it in a project:

>>> import idioticon
>>> idioticon.get_term(key='not-existing-term', soft_error=True)
None

>>> term = idioticon.add_term('my-term', 'My term')
>>> idioticon.add_term('my-term', 'My term')
False

>>> idioticon.set_term('my-term', 'My new term').name
'My new term'

>>> idioticon.update_term('my-term', 'My term').name
'My term'
>>> idioticon.update_term('not-existing-term', 'My term')
False

>>> idioticon.delete_term('my-term').name
'My term'

>>> alias = idioticon.add_alias('my-term', 'my-alias', 'My alias', 'description')
>>> alias.main_term == idioticon.get_term('my-term')

Template tags

{% load idioticon %}
{% term 'my-term' %}

<script>
$(document).ready(function(){
    // activate popover
    $('a[rel=info-popover]').popover();
});
</script>

Features

• Term aliases
• Idioticon administration
• Shortcuts ( get_term, )
• Tests for Django >= 1.5 and Python >= 2.6