django-terms 0.3.2

Mandatory

• Django (tested with 1.4).

Optional

• django-ckeditor (tested with 3.6.2.1) to type the definition in a beautiful GUI;

• django-reversion (tested with 1.6.0) to recover changes and deletions;

• django-CMS (tested with 2.3), because django-terms has an apphook and a menu.

Global use

A middleware is available to automatically add links on all your website. It is not recommended to use it, since it will add links in all your applications, including django.contrib.admin. But since it only requires one line of change, it is a perfect way to start using django-terms.

1. Just add 'terms.middleware.TermsMiddleware', to your MIDDLEWARE_CLASSES.

Local use

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.

Example:

{% 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 %}

Common settings

TERMS_ADDITIONAL_IGNORED_APPS

Default: ()

A list or tuple of ignored Django apps (expressed as strings). This setting extends TERMS_IGNORED_APPS (see Advanced settings).

TERMS_ADDITIONAL_IGNORED_TAGS

Default: ()

A list or tuple of ignored HTML tags (expressed as strings). This setting extends TERMS_IGNORED_TAGS (see Advanced settings).

TERMS_ADDITIONAL_IGNORED_CLASSES

Default: ()

A list or tuple of ignored HTML classes (expressed as strings). This setting extends TERMS_IGNORED_CLASSES (see Advanced settings).

TERMS_ADDITIONAL_IGNORED_IDS

Default: ()

A list or tuple of ignored HTML IDs (expressed as strings). This setting extends TERMS_IGNORED_IDS (see Advanced settings).

TERMS_REPLACE_FIRST_ONLY

Default: True

If set to True, add a link only on the first occurrence of each term.

TERMS_CACHE_TIMEOUT

Default: 30

Cache timeout of django-terms (in seconds).

Advanced settings

TERMS_IGNORED_APPS

Default: see terms/settings.py

A list or tuple of ignored Django apps (expressed as strings).

TERMS_IGNORED_TAGS

Default: see terms/settings.py

A list or tuple of ignored HTML tags (expressed as strings). This is already set, so you should use TERMS_ADDITIONAL_IGNORED_TAGS (see Common settings) if you do not want to break the default behavior.

TERMS_IGNORED_CLASSES

Default: see terms/settings.py

A list or tuple of ignored HTML classes (expressed as strings).

TERMS_IGNORED_IDS

Default: see terms/settings.py

A list or tuple of ignored HTML IDs (expressed as strings).

Why?

When using django-terms, your HTML pages are totally or partially reconstructed:

• totally reconstructed if you use the middleware (see Global Use);

• partially reconstructed if you use the filter (see Local Use).

The content is parsed with HTMLParser, then rebuilt. See NeutralHTMLReconstructor and TermsHTMLReconstructor in tems/html.py to understand exactly how it is rebuilt.

List of known side effects

A few side effects are therefore happening during HTML reconstruction:

• Entity names and numbers (e.g. é, é, …) are unescaped. This means they are replaced with their unicode characters (e.g. é -> é);

• Additional spaces inside HTML tags are stripped:

  • Start tags <a href = "url" > -> <a href="url">;

  • End tags </ a > -> </a>;

  • “Start-end” tags <input style = "text" /> -> <input style="text" />.

Status

Write your translation

Localization is done directly on our Transifex page. Ask for a new language, and you’ll get it ready for translation within a couple of days.

Compile it

First, you need to get it from Transifex, then to compile it:

1. Make sure you have transifex-client installed: [sudo] pip install transifex-client;

2. Pull your translation: tx pull -l [lang];

3. Compile it: msgfmt terms/locale/[lang]/LC_MESSAGES/django.po -o terms/locale/[lang]/LC_MESSAGES/django.mo.