README

下载 | Packagist | 问题 | 支持论坛 | 捐赠

Rah_comments 允许您分页 Textpattern CMS 的 评论列表，将长篇无尽的评论列表拆分为多个页面，并提供完全可定制的导航。

此插件是 etc_pagination 的模块，扩展了核心评论系统，并允许 etc_pagination 与其协同工作。Rah_comments 执行诸如 URL 路由和评论计算等后台工作，而 etc_pagination 负责渲染分页。

安装

使用 Composer

$ composer require rah/rah_comments:*

或者 下载插件包。

要求

• Textpattern 4.4.1 或更高版本。
• etc_pagination
• PHP 5.3.0 或更高版本。

基础知识

Rah_comments 与 etc_pagination 一起使用以生成文章评论的分页，并附带一些标签，这些标签使核心评论系统和 etc_pagination 完全兼容。

总的来说，rah_comments 负责提供 etc_pagination 所需的页数，以确定需要渲染的内容，重写和重定向评论 URL，并使评论提交过程更加流畅。

包含两个标签；rah_comments_numpages - 主要标签，作为 etc_pagination 的粘合剂，以及 rah_comment_permlink，替代 comment_permlink 的标签。

最基本的使用案例将涉及使用 rah_comments 计算页数，将值传递给 etc_pagination，然后使用具有正确 offset 属性的核心 comments 标签。

<txp:variable name="numPages" value='<txp:rah_comments_numpages limit="10" />' />
<txp:etc_pagination pages='<txp:variable name="numPages" />' />
<txp:comments offset='<txp:etc_offset pageby="10" />' limit="10" />

上面的示例与任何 etc_pagination 使用案例类似，但不同的是，我们使用的是 rah_comments_numpages 而不是它的 etc_numpages。

标签和属性

rah_comments_numpages

<txp:rah_comments_numpages limit="10" />

计算并返回评论页数，同时执行一些必要的后台任务。页数基于提供的 offset 和 limit 属性计算，并将结果值传递给 etc_pagination 或类似的分页生成器。

为了使分页正常工作，该标签需要两个属性，即 limit 和 sort，它们应与分页 comments 标签中使用的值相同。

属性

limit
每页显示的评论数。此值应与在 comments 标签上使用的 limit 相同。
默认值: "10" 示例: limit="5"

sort
评论排序标准。此值应与您在评论标签上使用的sort属性相同，如果您使用了的话。
默认值："posted asc" 示例：sort="posted desc"

偏移量
跳过的评论数。
默认值："0" 示例：offset="5"

参数
用于传递页面数的查询字符串参数。此值应设置为与使用etc_pagination时使用的参数pg_counter匹配。
默认值："pg" 示例：parameter="pg"

rah_comment_permlink

<txp:rah_comment_permlink>
    ...contained statement...
</txp:rah_comment_permlink>

渲染评论permlink，用作comment_permlink标签的替代。

属性

锚点
是否将评论的id应用于超链接标签（作为id属性），将此评论的永久链接设置为评论页面的锚点。
默认值："1" 示例：anchor="0"

示例

基本分页

<txp:variable name="numPages" value='<txp:rah_comments_numpages limit="10" />' />
<txp:etc_pagination pages='<txp:variable name="numPages" />' />
<txp:comments offset='<txp:etc_offset pageby="10" />' limit="10" />

上述示例每页渲染10条评论，并在评论列表上方显示页码。

最近评论

<txp:recent_comments limit="10" wraptag="ul" break="li">
    <txp:rah_comment_permlink><txp:comment_name link="0" /> (<txp:title />)</txp:rah_comment_permlink>
</txp:recent_comments>

上述示例渲染网站上最后的10条评论。

变更日志

版本 0.5.0 – 即将推出

• 重写为etc_pagination模块。
• 移除：rah_comments标签。
• 移除：rah_recent_comments标签。
• 新增：rah_comments_numpages标签。
• 新增：rah_comment_permlink标签。
• 更新：现在在新评论提交后显示正确的评论页面。
• 性能优化。
• 作为Composer包发布。

版本 0.4 – 2008/09/14

• 新增<txp:rah_recent_comments />标签。

版本 0.3 – 2008/09/03

• 移除属性：break_nav和break_pages。
• 修复混乱url模式的错误：现在在混乱模式下完全工作。
• 新增属性：pg_break、pg_break_class、prepend和append。
• 现在在文章列表中工作，与<txp:comments />相同。
• 更好的文档。

版本 0.2 – 2008/02/17

• 一些小错误修复。
• 从文档中移除了一些错别字。

版本 0.1 – 2008/02/16

• 首次发布。