Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A modern, ajax-based appearance for django.contrib.comments
Python CSS HTML JavaScript
tree: c848232eb1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
fluent_comments
.gitignore
AUTHORS
LICENSE
MANIFEST.in
README.rst
setup.py

README.rst

Introduction

The django-fluent-comments module enhances the default appearance of the django.contrib.comments application to be directly usable in web sites.

The application is designed to be plug&play. It leverages django-crispy-forms to handle the form layout.

Installation

First install the module, preferably in a virtual environment:

git clone https://github.com/edoburu/django-fluent-comments.git
cd django-fluent-comments
pip install .

Configuration

To use comments, the following settings are required:

INSTALLED_APPS += (
    'fluent_contents',
    'crispy_forms',
    'django.contrib.comments',
)

Add the following in urls.py:

urlpatterns += patterns('',
    url(r'^blog/comments/', include('fluent_comments.urls')),
)

Provide a template that displays the comments for the object:

{% load comments %}

{% render_comment_list for object %}
{% render_comment_form for object %}

The database can be created afterwards:

./manage.py syncdb
./manage.py runserver

CSS form layout

Form layouts generally differ across web sites, hence this application doesn't dictate a specific form layout. Instead, this application uses django-crispy-forms which allows configuration of the form appearance.. By default, the forms can be rendered with 2 well known CSS frameworks:

  • Bootstrap The default template pack. The popular simple and flexible HTML, CSS, and Javascript for user interfaces from Twitter.
  • Uni-form Nice looking, well structured, highly customizable, accessible and usable forms.

The CRISPY_TEMPLATE_PACK setting allows you to choose which layout you like to use. For more information, see the django-crispy-forms documentation..

Both CSS frameworks have a wide range of themes available, which should allow you to have a good layout for your Django forms. In fact, we would encourage to adopt django-crispy-forms for all your form layouts to have a consistent layout across all your forms.

If your form CSS framework is not supported, you can create a template pack for it and submit a pull request to the django-crispy-forms authors for inclusion.

Treaded comments

There is rudimentary support for django-threadedcomments in this module, which can be enabled with the following settings:

INSTALLED_APPS += (
    'threadedcomments',
)

COMMENTS_APP = 'threadedcomments'

Note however, that some improvements to django-threadedcomments are still open (see pull request #39) and until that moment it is not easy to take full advantage of the threaded display.

Contributing

This module is designed to be generic, and easy to plug into your site. In case there is anything you didn't like about it, or think it's not flexible enough, please let us know. We'd love to improve it!

If you have any other valuable contribution, suggestion or idea, please let us know as well because we will look into it. Pull requests are welcome too. :-)

Something went wrong with that request. Please try again.