TurboGears2插件应用程序,用于具有Facebook共享功能的实体评论
项目描述
关于tgcomments
tgcomments是TurboGears2的可插拔评论应用程序。可以通过使用comments_for组件将评论添加到任何网页。
如果用户使用tgapp-fbauth登录或如果用户模型提供了类似接口,TGComments支持Facebook头像。否则将回退到Gravatar。
安装
tgcomments可以从pypi或从bitbucket安装
pip install tgapp-tgcomments
对于大多数用户应该都能正常工作
插入tgcomments
在你的应用程序 config/app_cfg.py 中导入 plug
from tgext.pluggable import plug
然后在文件 末尾 调用plug与tgcomments
plug(base_config, 'tgcomments')
要公开实体的评论支持,只需在模板中调用该实体的comments_for(entity)组件,如《公开组件》部分所述。
公开组件
tgcomments公开了一系列组件,可以在应用程序的任何位置使用这些组件来渲染博客系统的各个部分
- tgcomments.partials:comments_for(entity)
给定任何可在应用程序 model 模块中使用的SQLAlchemy或Ming实体(实例),它将显示该实体的评论列表,并有一个框可以添加新的评论。
提供选项
tgcomments支持许多选项,可以传递给插件调用以更改其行为
- notify_facebook(默认:True)自动在Facebook上通知用户写的评论
如果他已经使用Facebook登录
allow_anonymous(默认:True)允许匿名用户评论
pretty_date一个将用于正确格式化日期的函数(例如:“5分钟前”)
get_user_avatar一个将用于获取头像的函数(默认情况下搜索avatar属性,然后回退到fb信息,然后回退到gravatar)
公开的模板
注册时使用的模板,可以用tgext.pluggable.replace_template替换,包括
tgcomments.templates.comments_partial
可用的钩子
TGComments公开了一些钩子来配置其行为,可以使用TurboGears2的register_hook使用的钩子有
tgcomments.before_add(entity, user, kw) - 在添加评论之前调用。可以在此处修改kw[‘body’]
变更日志
0.2.6 - 支持 turbogears 2.4
0.2.3 - 添加了tgcomments.before_add钩子
- 0.2.2 - 修复了由v0.2.1引入的匿名评论创建问题,使用pre而不是div来显示评论正文,以便保留换行符
0.2.1 - 修复了ming与User的关系,并添加了author_username
0.2.0 - 介绍了与ming的兼容性
项目详情