Permalink
Fetching contributors…
Cannot retrieve contributors at this time
130 lines (90 sloc) 3.12 KB

Settings

Common settings

TERMS_ENABLED

Default:True
Definition:If set to False, globally disabled django-terms.

TERMS_DEBUG

Default:DEBUG
Definition:If set to True, allows django-terms to raise minor exceptions (see :ref:`Exceptions`).

TERMS_REPLACE_FIRST_ONLY

Default:True
Definition:If set to True, adds a link only on the first occurrence of each term
Used by::ref:`Middleware`, :ref:`Template filter`

TERMS_ADDITIONAL_IGNORED_APPS

Default:()
Definition:A list or tuple of ignored Django applications (expressed as strings)
Used by::ref:`Middleware`
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 by::ref:`Middleware`, :ref:`Template filter`
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 by::ref:`Middleware`, :ref:`Template filter`
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 by::ref:`Middleware`, :ref:`Template filter`
Extends:TERMS_IGNORED_IDS
Syntax example:['article-footer', 'side-content']

TERMS_DEFINITION_WIDGET

Default:'auto'
Definition:Explicitly tells django-terms which text widget to choose for the definition of a term. Accepted values are 'auto', 'basic', 'tinymce', and 'ckeditor'.

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 by::ref:`Middleware`

TERMS_IGNORED_TAGS

Default:see terms/settings.py
Definition:A list or tuple of ignored HTML tags (expressed as strings)
Used by::ref:`Middleware`, :ref:`Template filter`

TERMS_IGNORED_CLASSES

Default:see terms/settings.py
Definition:A list or tuple of ignored HTML classes (expressed as strings)
Used by::ref:`Middleware`, :ref:`Template filter`

TERMS_IGNORED_IDS

Default:see terms/settings.py
Definition:A list or tuple of ignored HTML IDs (expressed as strings)
Used by::ref:`Middleware`, :ref:`Template filter`