Skip to content

Latest commit

 

History

History
329 lines (230 loc) · 8.94 KB

README.rst

File metadata and controls

329 lines (230 loc) · 8.94 KB
Raw

django-terms

Site-wide adds a definition or a link for specialized terms.

Requirements

Mandatory

Optional

Installation

  1. [sudo] pip install django-terms
  2. Add 'terms', to your INSTALLED_APPS
  3. Add terms to your urls:
    • add url(r'^terms/', include('terms.urls')), to your urls.py
    • or, if you are using django-CMS, add a page and use the apphook and menu

Usage

  1. Add some terms in the admin
  2. Choose how django-terms should apply to your website:

The added terms should now be automatically linked to their definitions.

Global use

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

Local use

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

Note

If an error occurs, like every filter, it will fail silently. If this filter mysteriously has no effect, remove it, use the middleware, switch to DEBUG mode and see Exceptions.

  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 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']

Settings

Common settings

TERMS_ADDITIONAL_IGNORED_APPS

Default

()

Definition

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

Used in

Global use

Extends

TERMS_IGNORED_APPS

Syntax example

['cms']

TERMS_ADDITIONAL_IGNORED_TAGS

Default

()

Definition

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

Used in

Global use, Local use

Extends

TERMS_IGNORED_TAGS

Syntax example

['h1', 'h2', 'h3', 'footer']

TERMS_ADDITIONAL_IGNORED_CLASSES

Default

()

Definition

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

Used in

Global use, Local use

Extends

TERMS_IGNORED_CLASSES

Syntax example

['footnote', 'text-caption']

TERMS_ADDITIONAL_IGNORED_IDS

Default

()

Definition

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

Used in

Global use, Local use

Extends

TERMS_IGNORED_IDS

Syntax example

['article-footer', 'side-content']

TERMS_REPLACE_FIRST_ONLY

Default

True

Definition

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

Used in

Global use, Local use

Advanced settings

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

TERMS_IGNORED_APPS

Default

see terms/settings.py

Definition

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

Used in

Global use

TERMS_IGNORED_TAGS

Default

see terms/settings.py

Definition

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

Used in

Global use, Local use

TERMS_IGNORED_CLASSES

Default

see terms/settings.py

Definition

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

Used in

Global use, Local use

TERMS_IGNORED_IDS

Default

see terms/settings.py

Definition

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

Used in

Global use, Local use

Troubleshooting

Side effects

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" />

Warning

This implies one bad side effect: the unescaping breaks the special characters rendering in some complex form fields like django-ckeditor. django.contrib.admin is already ignored, so you should not encounter any problem. Otherwise, using filters instead of the middleware and/or ignore the correct apps/tags/classes/ids using Common settings will ensure a proper rendering.

Exceptions

These exceptions are only happening in Global use, since Django filters should always fail silently.

Resolver404

Raised in

DEBUG mode. Otherwise the page is ignored by django-terms.

Reason

This happens when django-terms is unable to resolve the current request.path to determine whether the application of the current page is in TERMS_IGNORED_APPS.

Encountered

In django-CMS 2.3, when adding a plugin in frontend editing.

HTMLValidationWarning

Raised in

DEBUG mode. Otherwise we try to make terms replacements work anyway.

Reason

This happens when django-terms finds a problem in the architecture of the current HTML page.

Encountered

If you forget the final / of a “start-end” tag.

Translations

Status

image

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