Discourse Wiki 共同编辑者

安装此主题组件

Discourse 会记录每一次 Wiki 编辑,但从不显示贡献者。此组件会在帖子下方列出他们,以便让保持 Wiki 更新的人员获得应有的认可。

功能说明

  • 在 Wiki 主题首帖下方显示“共同编辑者”及编辑者头像。
  • 根据近期修订版本中的编辑次数对编辑者进行排名。帖子作者、system 和 discobot 不会被列出。
  • 点击可打开对应用户的个人资料卡片。
  • 当头像数量超过设定值时,其余头像将被折叠在“+N 位更多”之后。
  • 适用于未登录访客:即使关闭了 edit_history_visible_to_public 设置,Wiki 的编辑历史仍是公开的。
  • 包含英文和西班牙文本地化支持。

设置项

设置项 默认值
target_categories 空 显示该列表的 Wiki 所属的分类
target_tags 空 在任何分类中显示该列表的 Wiki 标签。若未设置任何分类或标签,则所有 Wiki 均会显示该列表。
label 空 头像前的文本。留空时使用查看者的语言。
label_overrides 无 按分类设置不同的措辞
excluded_users 空 永不列出的用户名
max_avatars 5 在出现“+N 位更多”之前显示的头像数量
max_revisions 20 读取的近期修订版本数量,最多为 40

已知限制

  • 每次视图中的每个修订版本都需要发起一个请求,因此仅读取近期修订版本:对于编辑频繁的 Wiki,早期编辑者将不再显示。上限设为 40 是因为默认情况下,Discourse 会在 10 秒内阻止访客发起超过 50 次请求。
  • 无法自动检测其他机器人(例如 AI 机器人):需要将其添加到 excluded_users 中。
  • 任何修订版本都会被计数,包括仅修改了标题、标签或分类的修订版本。
  • 仅对首帖进行认可。
  • excluded_users 仅隐藏姓名。其编辑记录仍保留在帖子的历史中。

如需使用排行榜代替按帖认可,README 中包含一个 Data Explorer 查询。欢迎提交 Bug 报告和支持(PR)。