django-terms¶

Mandatory¶

• Python 2.7, 3.3, 3.4, or 3.5
• Django 1.7, 1.8, or 1.9
• lxml

Optional¶

• django-tinymce (tested with 1.5.1b2) to type the definition in a beautiful GUI (see TERMS_DEFINITION_WIDGET)
• django-ckeditor (tested with 3.6.2.1) to type the definition in another beautiful GUI (see TERMS_DEFINITION_WIDGET)
• django-reversion (tested with 1.6.0) to recover changes and deletions
• django-CMS (tested with 2.3) because django-terms has an apphook, a menu, a plugin processor and a plugin
• django-haystack (tested with 1.2.7 and 2.1.0) because django-terms has a search index
• django.contrib.sitemaps because django-terms has a sitemap
• South (tested with 0.8.1) because django-terms has migrations

Middleware¶

A middleware is available to automatically add links on all your website. It is not recommended to use it in production because it parses and rebuilds whole pages, which can be an overkill in most cases (even though django-terms has excellent performances).

It is also perfect for development: it never fails silently, unlike filters (see Exceptions for more details).

1. Add 'terms.middleware.TermsMiddleware', to your MIDDLEWARE_CLASSES
2. If the middleware applies to unwanted Django applications, HTML tags, classes, or IDs, set the corresponding Common settings

Template filter¶

A template filter is available to add links only on desired parts of your website.

1. Choose one of your existing templates
2. Add {% load terms %} to the beginning of the file (just after {% extends '[file]' %} if you have one)
3. Use the filter replace_terms like every normal filter
4. If the filter applies to unwanted HTML tags, classes, or IDs, set the corresponding :ref:Common settings

Example:

Suppose you have such a template:

{% extends 'base.html' %}

{% block article_header %}
  {{ article.header }}
{% endblock %}

{% block article_content %}
  {{ article.section1 }}
  {{ article.section2 }}
{% endblock %}

Here is how you can modify it:

{% extends 'base.html' %}
{% load terms %}

{% block article_header %}
  {{ article.header|replace_terms }}
{% endblock %}

{% block article_content %}
  {% filter replace_terms %}
    {{ article.section1 }}
    {{ article.section2 }}
  {% endfilter %}
{% endblock %}

Now, suppose you have an HTML class code-snippet in article.section2 where you do not want to add links on terms. Go to Common settings, and you will find the solution:

Add this line in settings.py:

TERMS_ADDITIONAL_IGNORED_CLASSES = ['code-snippet']

With django-CMS¶

A few tools are available to make your life easier if you use django-CMS.

CMS_PLUGIN_PROCESSORS = (
    ...
    'terms.cms_plugin_processors.TermsProcessor',
    ...
)

Common settings¶

Advanced settings¶

These settings should not be used, unless you know perfectly what you are doing.

Side effects¶

Performance¶

Exceptions¶

Status¶

Write your translation¶

Localization is done directly on our Transifex page. There is no access restriction, so feel free to spend two minutes translating django-terms to your language :o)

Get & Compile¶

1. Make sure you have transifex-client installed: [sudo] pip install transifex-client
2. Pull all translations from Transifex: tx pull -a
3. Compile them: cd terms && django-admin.py compilemessages

Bounty¶

django-terms was originally developed for a french website, Criminocorpus. Now that it is finished, I don’t have credits to continue development on django-terms.

Maybe you want a new feature in django-terms but don’t want to code anything. First, open an issue on github so that we can publicly decide whether it’s a desirable feature. Then send me an email to privately discuss the cost of such a demand.

No donations…¶

I don’t accept donations for the time being.

Others would ask for donations in such cases, but in my opinion that would be quite dishonest because:

• I’ve been paid to develop something that became django-terms, even though I was not supposed to make it open source, nor to make docs and tests.
• I’m not a street mime, I can’t develop properly on the basis of a few bucks donated from time to time.
• I don’t believe in Santa Claus.

If you’re still willing to help with money, see the next paragraph.

…but you can still help¶

The obvious help is to contribute to the code.

If you’re really willing to help but you can’t code, you can send me an email to say that you like django-terms, that’s always heartwarming :)

If you want to help me with money, please donate to PyPy (especially STM/AME). I’m not part of it, but that’s an awesome project that probably is the future of Python. It’s Python, but way faster. In a few years, maybe PyPy will become the main Python implementation, as was attempted with Unladen Swallow. Then django-terms will probably be much faster.