Pinax Likes 技术文档

1. 安装指南

要安装 pinax-likes，请运行以下命令：

pip install pinax-likes

在 INSTALLED_APPS 设置中添加 pinax.likes：

INSTALLED_APPS = [
    # 其他应用
    "pinax.likes",
]

在设置文件中将想要被喜欢的模型添加到 PINAX_LIKES_LIKABLE_MODELS：

PINAX_LIKES_LIKABLE_MODELS = {
    "app.Model": {}  # 在这个字典中为每个模型覆盖默认配置设置
}

将 pinax.likes.auth_backends.CanLikeBackend 添加到 AUTHENTICATION_BACKENDS（或使用自己的自定义版本，检查 pinax.likes.can_like 权限）：

AUTHENTICATION_BACKENDS = [
    # 其他后端
    "pinax.likes.auth_backends.CanLikeBackend",
]

在项目的 urlpatterns 中添加 pinax.likes.urls：

urlpatterns = [
    # 其他 URL
    url(r"^likes/", include("pinax.likes.urls", namespace="pinax_likes")),
]

2. 项目的使用说明

将每个需要被喜欢的模型添加到 PINAX_LIKES_LIKABLE_MODELS 设置中：

PINAX_LIKES_LIKABLE_MODELS = {
    "profiles.Profile": {},
    "videos.Video": {},
    "biblion.Post": {},
}

在 Django 模板中显示“喜欢”小部件。假设你有一个博客文章的详细页面。首先在模板中加载标签：

{% load pinax_likes_tags %}

在想要显示喜欢小部件的位置，添加：

{% likes_widget request.user post %}

确保你安装了 eldarion-ajax。

Eldarion AJAX

上述的 likes_widget 模板标签和“切换喜欢”视图都遵循 eldarion-ajax 理解的 AJAX 响应。此外，本项目提供的模板将与 eldarion-ajax 无缝工作。在你的基础模板中包含 eldarion-ajax.min.js JavaScript 包：

{% load staticfiles %}
<script src="{% static "js/eldarion-ajax.min.js" %}"></script>

并在你的站点 JavaScript 中包含 eldarion-ajax：

require('eldarion-ajax');

使用 eldarion-ajax 是可选的。你可以滚动自己的 JavaScript 处理，因为视图除了返回渲染的 HTML 外，还会返回数据。此外，如果你根本不想要 ajax，视图将处理常规 POST 并执行重定向。

3. 项目API使用文档

本项目提供了以下模板标签和信号供使用：

信号

pinax.likes.signals.object_liked 和 pinax.likes.signals.object_unliked 分别在对象被喜欢和取消喜欢后发送，包含了相关的 Like 实例或对象。

滤镜

likes_count 滤镜返回给定对象喜欢的数量。

模板标签

• who_likes：获取给定对象的喜欢列表。
• likes：获取给定用户喜欢的对象列表。
• render_like：渲染一个喜欢。
• likes_widget：渲染一个 HTML 片段，用户点击它可以取消喜欢或喜欢对象。
• liked：装饰一个对象的可迭代列表，指示指定用户是否喜欢每个对象。

4. 项目安装方式

请参考上述“安装指南”部分进行项目的安装。安装完成后，根据“项目的使用说明”部分配置并使用 pinax-likes。