 |
摘要 | Discourse 年度回顾 会在 1 月 1 日创建一个主题，总结上一年的论坛活动。（请参阅我们在 Meta 上的示例 - year-in-review） |
 |
仓库链接 | https://github.com/discourse/discourse-yearly-review |
 |
安装指南 | 如何在 Discourse 中安装插件 |
初始设置
前往您的 /admin/plugins 页面，点击 discourse-yearly-review 
设置 按钮：
-
在
yearly review categories（年度回顾分类）设置中输入要提取数据的分类。如果留空，将默认选择前 5 个公开分类。 -
使用
yearly review publish category（年度回顾发布分类）设置，选择要发布回顾帖的目标分类。
强烈建议将 yearly review publish category设置为工作人员分类或其他私有分类，以便在公开之前查看主题。您可能还想先对其进行编辑。 -
然后，使用
yearly review enabled（年度回顾启用）设置启用插件。
功能
正如您在 2022: The Year in Review 所见，数据分为两个部分显示：用户和主题。
用户部分包括：
- 阅读时间最多
- 创建主题最多
- 回复最多
- 被回复最多
- 点赞最多
- 被点赞最多
- 访问次数最多
- 获得特色徽章的用户（徽章由
yearly review featured badge站点设置指定）
主题部分包括：
- 阅读最多
- 点赞最多
- 被回复最多
- 最受欢迎
- 书签最多
生成年度回顾
该插件会设定阈值以决定显示哪些主题。主题必须至少有 10 个点赞或回复、5 个书签、10 分评分，或至少一小时阅读时间，才会被显示。主题会通过后台作业自动发布。该作业会检查插件是否已启用，以及是否处于当年第一个月的前 31 天内。随后，它会检查系统用户是否已发布标题为 yearly_review.topic_title 的主题。如果所有检查都通过，主题将发布到 yearly review publish category 设置中指定的分类。如果未配置此项，主题将发布到“未分类”分类。
额外选项
年度回顾分类
本部分使用的分类是在 yearly review categories 站点设置中指定的分类。如果未配置此设置，将自动选择论坛中前 5 个最佳公开分类。「最佳」是根据分类的 topics_year 计数来确定的。
yearly review categories 站点设置中指定的任何分类的子分类将 不会 包含在年度回顾报告中。如果您希望子分类包含在报告中，则需要在 yearly review categories 站点设置中明确指定它们。
年度回顾排除工作人员
该插件具有 yearly review exclude staff（年度回顾排除工作人员）设置。默认情况下已启用，因此工作人员将被排除在用户部分之外，由工作人员创建的主题也将被排除在主题部分之外。
年度回顾特色徽章
可以通过 yearly review featured badge 设置指定一个特色徽章。最多显示 15 个获得该徽章的用户。如果超过 15 个用户获得了此徽章，则会显示指向该徽章页面的链接。如果未配置 yearly review featured badge，则不会显示此部分。
手动运行年度回顾
如果您不想等待后台作业，可以通过 Rails 控制台发布主题，命令如下：
Jobs::YearlyReview.new.execute(force: true)
如果您想为特定年份生成报告，只需添加 review_year: 'year'，例如：
Jobs::YearlyReview.new.execute(force: true, review_year: '2021')
由我们托管？如果您希望手动运行年度回顾，可以联系 team@discourse.org，我们将很乐意为您安排。
设置
| 名称 | 描述 |
|---|---|
| yearly review enabled | 启用年度回顾。 |
| yearly review categories | 要提取主题的公开分类。将从该组中选择前 5 个分类。如果留空，将默认选择前 5 个公开分类。 |
| yearly review exclude staff | 在用户统计中排除工作人员。 |
| yearly review include user stats | 在回顾主题的首帖中添加用户识别统计信息。 |
| yearly review include private categories | 在回顾中包含来自私有或阅读受限分类的用户活动。 |
| yearly review publish category | 发布回顾的分类。 |
| yearly review featured badge | 输入完整的徽章名称。可以留空。 |
已知问题
-
数据以 HTML 表格形式显示。表格被包裹在带有
data-review-topic-users="true'和data-review-featured-topics="true"属性的div标签中。这使得表格在 Discourse 上显示时可以应用样式。但在生成主题邮件时，这些样式不会被复制。因此，发送给主题的邮件看起来不太美观。 -
生成主题的首帖由于使用 HTML，字符数约为 40,000 个。因此，除非您先增加正文字符限制（参见 https://meta.discourse.org/t/body-is-limited-to-32000-characters-you-entered-43659/157301），否则无法编辑该帖。
-
标题中的表情符号在特色主题链接中不会渲染。