django-richcomments 0.0.2

Django app extending the builtin comments framework for AJAX style commenting.

Django Richcomments

Django app extending the builtin comments framework for AJAX style commenting.

django-richcomments wraps the Django's comments frameworks existing render_comment_list and render_comment_form template tags to make them behave AJAXy.

Installation

  1. Install or add django-richcomments to your Python path.

  2. Configure Django's comments framework as described here.

  3. Add richcomments url include to your project's urls.py file:

    (r'^richcomments/', include('richcomments.urls')),
    
  4. Ensure django-richcomments static media is accessible, see managing static files.

Usage

django-richcomments simply wraps the existing render_comment_list and render_comment_form template tags to make them behave AJAXy. Thus when a comment is submitted it is done via Javascript and an existing comment list is update without a page reload. You would customize your comment listing and form HTML as per normal. From a code perspective commenting behaves exactly the same as it normally does, except that the form generated by the render_comment_form tag will be submitted via AJAX and comment lists generated by the render_comment_list will be updated via AJAX after such a submit.

For richcomments to be active on a page both the jQuery and jQuery form plugin Javascript libraries needs to be loaded. Both are included as part of django-richcomments static media and a shortcut template tag is provided for your convenience, i.e.:

{% load richcomments %}

{% richcomments_static %}

which renders the following (with a static path as configured in your settings):

<script type="text/javascript" src="/static/richcomments/includes/jquery.min.js"></script>
<script type="text/javascript" src="/static/richcomments/includes/jquery.form.js"></script>

To recap here's a simple example illustrating how you can display a list of comments as well as a comment form for an object which will be submitted and updated via AJAX:

{% load comments richcomments %}

<html>
    <head>
        {% richcomments_static %}
    </head>
    <body>
        {% render_comment_list for object %}
        {% render_comment_form for object %}
    </body>
</html>

Changelog

0.0.2 (2011-09-15)

  1. Documentation, static media tag.

0.0.1 (2010-08-03)

  1. Initial release
BSD

Author

Praekelt Foundation

Pip

django-richcomments==0.0.2

Classifiers

  • Framework :: Django
  • Intended Audience :: Developers
  • Operating System :: OS Independent
  • Programming Language :: Python
  • Development Status :: 4 - Beta
  • License :: OSI Approved :: BSD License
  • Topic :: Internet :: WWW/HTTP :: Dynamic Content
File Type Python Version Uploaded On Downloads
django_richcomments-0.0.2-py2.7.egg Egg 2.7 Sept. 15, 2011 3,074
django_richcomments-0.0.2-py2.6.egg Egg 2.6 Sept. 15, 2011 2,600
django-richcomments-0.0.2.tar.gz Source Sept. 15, 2011 2,912
Version Release Date
0.0.2 Sept. 15, 2011
0.0.1 Aug. 3, 2010
Date Package Version Action
Aug. 26, 2015, 12:23 a.m. django-richcomments 0.0.2 Release Created
Aug. 26, 2015, 12:23 a.m. django-richcomments 0.0.1 Release Created
Aug. 26, 2015, 12:23 a.m. django-richcomments Package Created