Django Threaded Comments 技术文档

1. 安装指南

1.1 安装依赖

首先，通过 pip 安装 django-threadedcomments 包：

pip install django-threadedcomments

推荐在虚拟环境中安装此模块，以避免与其他项目冲突。

1.2 配置 settings.py

在项目的 settings.py 文件中添加以下配置：

INSTALLED_APPS += (
    'threadedcomments',
    'django_comments',
    'django.contrib.sites',
)

COMMENTS_APP = 'threadedcomments'

将 threadedcomments 应用放在 django.contrib.comments 应用之前，以便替换默认的 comments/list.html 模板为线程视图。

1.3 配置 urls.py

确保在 urls.py 中配置了 django_comments 的 URL：

from django.conf.urls import url, include

urlpatterns += [
    url(r'^articles/comments/', include('django_comments.urls')),
]

1.4 提供模板

为显示评论的对象（如文章或博客条目）提供一个模板：

{% load threadedcomments_tags %}

<h2>Comments for {{ object.title }}:</h2>

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

2. 项目的使用说明

2.1 模板设计

为了更好地定制评论的显示效果，建议编写自己的 comments/list.html 模板，或者使用 comments/app/list.html 或 comments/app/model/list.html 的覆盖模板。

同时，确保覆盖 comments/base.html 模板，以便其他 django_comments 视图使用网站的设计风格。

2.2 示例应用

项目中提供了一个 example 应用，展示了基本的配置，包括一个基于 JavaScript 的回复表单，该表单会移动到访客回复的评论位置。

3. 项目API使用文档

3.1 模板标签

threadedcomments_tags 库是 comments 库的替代品，支持与 django_comments 相同的语法，并添加了一些额外的参数。

3.1.1 获取评论数量

{% get_comment_count for [object] as [varname] %}
{% get_comment_count for [object] as [varname] root_only %}

{% get_comment_count for [app].[model] [id] as [varname] %}
{% get_comment_count for [app].[model] [id] as [varname] root_only %}

3.1.2 获取评论列表

{% get_comment_list for [object] as [varname] %}
{% get_comment_list for [object] as [varname] flat %}
{% get_comment_list for [object] as [varname] root_only %}

3.1.3 渲染评论列表

{% render_comment_list for [object] %}
{% render_comment_list for [object] root_only %}

{% render_comment_list for [app].[model] [id] %}
{% render_comment_list for [app].[model] [id] root_only %}

3.1.4 获取评论表单

{% get_comment_form for [object] as [varname] %}
{% get_comment_form for [object] as [varname] with [parent_id] %}
{% get_comment_form for [app].[model] [id] as [varname] %}
{% get_comment_form for [app].[model] [id] as [varname] with [parent_id] %}

3.1.5 渲染评论表单

{% render_comment_form for [object] %}
{% render_comment_form for [object] with [parent_id] %}
{% render_comment_form for [app].[model] [id] %}
{% render_comment_form for [app].[model] [id] with [parent_id] %}

3.1.6 渲染整个评论树

{% for comment in comment_list|fill_tree|annotate_tree %}
    {% ifchanged comment.parent_id %}{% else %}</li>{% endifchanged %}
    {% if not comment.open and not comment.close %}</li>{% endif %}
    {% if comment.open %}<ul>{% endif %}

    <li id="c{{ comment.id }}">
        ...
    {% for close in comment.close %}</li></ul>{% endfor %}
{% endfor %}

fill_tree 过滤器用于分页，确保第一个评论的父评论也被包含。annotate_tree 过滤器为评论添加 open 和 close 属性。

4. 项目安装方式

4.1 通过 pip 安装

使用以下命令安装 django-threadedcomments：

pip install django-threadedcomments

4.2 配置项目

按照上述步骤配置 settings.py 和 urls.py，并提供相应的模板文件。

通过以上步骤，您可以成功安装并使用 django-threadedcomments 项目，实现线程评论功能。