 |
摘要 | 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），否则无法对其进行编辑。
-
标题中的表情符号在特色主题链接中不会渲染。