Quick start guide¶

To get started using django-comments-xtd follow these steps:

Install the Django Comments Framework by running pip install django-contrib-comments.
Install the django-comments-xtd app by running pip install django-comments-xtd.
Enable the “sites” framework by adding 'django.contrib.sites' to INSTALLED_APPS and defining SITE_ID. Be sure that the domain field of the Site instance points to the correct domain (localhost:8000 when running the default development server), as it will be used by django_comments_xtd to create comment verification URLs, follow-up cancellation URLs, etc.
Install the comments framework by adding 'django_comments' to INSTALLED_APPS.
Install the comments-xtd app by adding 'django_comments_xtd' to INSTALLED_APPS.
Set the COMMENTS_APP setting to 'django_comments_xtd'.
Set the COMMENTS_XTD_MAX_THREAD_LEVEL to N, being N the maximum level of threading up to which comments will be nested in your project.
```
# 0: No nested comments.
# 1: Nested up to level one.
# 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_MODEL setting, so that different models have enabled different thread levels. ie: no nested comments for food recipes, up to thread level one for blog posts, etc.
Set the COMMENTS_XTD_CONFIRM_EMAIL to True to require comment confirmation by email for no logged-in users.
Run manage.py migrate to create the tables.

Add the URLs of the comments-xtd app to your project’s urls.py:

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 = "alias@mail.com"
EMAIL_HOST_PASSWORD = "yourpassword"
DEFAULT_FROM_EMAIL = "Helpdesk <helpdesk@yourdomain>"

If you wish to allow comments written in a markup language like Markdown or reStructuredText, install django-markup by running pip install django-markup.
Use the comments templatetag module, provided by the django-comments app. Create a comments directory 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 render_comments_list templatetag.
- comments/form.html, used by the render_comment_form templatetag.
- 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.
Add extra settings to control comments in your project. Check the available settings in the Django Comments Framework and in the django-comments-xtd app.

These are in a glance 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.