django cms integration

README.rst

@@ -62,9 +62,12 @@ Usage
 
    * `Middleware`_ (to give django-terms a try or for development)
    * `Template filter`_ (for production)
+   * `cms_plugin_processor`_ (if you are using django-CMS)
 
 The added terms should now be automatically linked to their definitions.
 
+For django-CMS users : display all terms and their definitions with the `TermsIndexPlugin`_.
+
 
 Middleware
 ----------
@@ -140,6 +143,26 @@ Example:
        TERMS_ADDITIONAL_IGNORED_CLASSES = ['code-snippet']
 
 
+cms_plugin_processor
+--------------------
+
+A cms_plugin_processor is available if you are using django-CMS.
+It will parse all plugin output.
+
+Add this in `settings.py`::
+
+   CMS_PLUGIN_PROCESSORS = (
+      [...]
+      'terms.cms_plugin_processors.TermsProcessor',
+      [...]
+      )
+
+
+TermsIndexPlugin
+----------------
+
+If you are using django-CMS, you can display all terms and their definitions with the "Terms Index Plugin".
+
 
 Settings
 ========
@@ -308,7 +331,7 @@ Resolver404
 HTMLValidationWarning
 .....................
 
-:Raised by: `Middleware`_ and `Template filter`_.
+:Raised by: `Middleware`_, `Template filter`_. and `cms_plugin_processor`_
 :Raised in: `TERMS_DEBUG`_ mode.  Otherwise we try to make terms replacements
             work anyway.
 :Reason: This happens when django-terms finds a problem in the architecture

terms/cms_plugin_processors.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+
+from .html import TermsHTMLReconstructor
+from django.template import Context, Template
+
+
+def TermsProcessor(instance, placeholder, rendered_content, original_context):
+    """
+    This processor mark all terms in all placeholders plugins except termsplugins
+    """
+    if 'terms' in original_context:
+        return rendered_content
+
+    parser = TermsHTMLReconstructor()
+    parser.feed(rendered_content)
+
+    t = Template('{{ content|safe }}')
+    c = Context({
+        'content': parser.out,
+    })
+    return t.render(c)

terms/cms_plugins.py

@@ -0,0 +1,19 @@
+from cms.plugin_base import CMSPluginBase
+from cms.plugin_pool import plugin_pool
+from cms.models.pluginmodel import CMSPlugin
+from django.utils.translation import ugettext_lazy as _
+from .models import Term
+
+
+class TermsIndexPlugin(CMSPluginBase):
+    model = CMSPlugin
+    name = _("Terms Index Plugin")
+    render_template = "term_plugin.html"
+
+    def render(self, context, instance, placeholder):
+        terms = Term.objects.all()
+        context['terms'] = terms
+        return context
+
+
+plugin_pool.register_plugin(TermsIndexPlugin)

terms/templates/term_plugin.html

@@ -0,0 +1,8 @@
+<dl class="terms-index">
+{% for term in terms %}
+    <dt>{{ term|capfirst }}</dt>
+    <dd>{{ term.definition|safe }}
+        {% if term.url and term.definition %}<br/>{%endif %}
+        {{ term.url|urlizetrunc:40 }}</dd>
+{% endfor %}
+</dl>