Quick start guide¶
To get started using django-comments-xtd follow these steps:
pip install django-comments-xtd
Enable the “sites” framework by adding
SITE_ID. Visit the admin site and be sure that the domain field of the
Siteinstance points to the correct domain (
localhost:8000when running the default development server), as it will be used to create comment verification URLs, follow-up cancellations, etc.
'django_comments', in that order, to
Nthe maximum level of threading up to which comments will be nested in your project.
# 0: No nested comments: # Comment (level 0) # 1: Nested up to level one: # Comment (level 0) # |-- Comment (level 1) # 2: Nested up to level two: # Comment (level 0) # |-- Comment (level 1) # |-- Comment (level 2) COMMENTS_XTD_MAX_THREAD_LEVEL = 2
The thread level can also be established on a per
<app>.<model>basis by using the
COMMENTS_XTD_MAX_THREAD_LEVEL_BY_APP_MODELsetting. Use it to establish different maximum threading levels for each model. ie: no nested comments for quotes, up to thread level 2 for blog stories, etc.
Trueto require comment confirmation by email for no logged-in users.
manage.py migrateto create the tables.
Add the URLs of the comments-xtd app to your project’s
urlpatterns = [ ... url(r'^comments/', include('django_comments_xtd.urls')), ... ]
Customize your project’s email settings:
EMAIL_HOST = "smtp.mail.com" EMAIL_PORT = "587" EMAIL_HOST_USER = "email@example.com" EMAIL_HOST_PASSWORD = "yourpassword" DEFAULT_FROM_EMAIL = "Helpdesk <helpdesk@yourdomain>"
As of version 1.7.1 django-comments-xtd comes with templates styled with twitter-bootstrap v3 to allow a quick start. If you want to build your own templates, use the comments templatetag module, provided by the django-comments app. Create a
commentsdirectory in your templates directory and copy the templates you want to customise from the Django Comments Framework. The following are the most important:
comments/list.html, used by the
comments/form.html, used by the
comments/preview.html, used to preview the comment or when there are errors submitting it.
comments/posted.html, which gets rendered after the comment is sent.
These are the steps to quickly start using django-comments-xtd. Follow to the next page, the Tutorial, to read a detailed guide that takes everything into account. In addition to the tutorial, the Demo projects implement several commenting applications.