| 摘要 | 将主题中的表格转换为可搜索的项目,成员可以使用 + 提及这些项目,并附带链接和 Onebox 预览。 |
|
| 仓库 | Discourse Mentionables | |
| 安装指南 | 在自托管的 Discourse 站点上安装插件 | |
| 赞助 | 请考虑赞助持续开发,以帮助维护这些插件并确保它们与当前版本的 Discourse 兼容。 |
为您的社区提供关于其讨论内容的共享词汇表:书籍、
产品、项目、地点、支持资源或任何带有 URL 的内容。
成员输入 + 和部分名称,选择一个建议,即可获得一个可读的链接,而无需记住地址。
功能
- 仅使用 URL 开始。 导入器获取名称并生成 slug;您可以添加自己的名称和 slug 作为可选覆盖。
- 边写边搜索。 输入
+或使用编辑器工具栏按钮搜索您的目录。适用于 Markdown 和富文本编辑器。 - 可读的内联链接。 提及显示为使用项目显示名称的紧凑胶囊,并在帖子的 Markdown 中包含稳定的 slug。
- 原生 Onebox。 将提及单独放在一行以显示 Onebox,使用 Discourse 现有的布局和支持的目标。
- 桌面预览。 悬停或聚焦内联胶囊以打开浮动预览,其中包含打开原始页面链接。普通点击打开目标页面。
- 管理员可在 Discourse 中编辑的目录。 从主题首帖中的 Markdown 表格导入。不需要 Google 账户或 API 凭据。
- 管理员表格按钮。 从编辑器工具栏插入空的 mentionables 表格,然后填写您的项目。
Onebox 的外观取决于目标和 Discourse 的正常 Onebox 支持。不支持的目标保持为链接。浮动卡片需要登录;
访客仍然可以跟随目标链接。代码中的提及保持不变,
列表和引用中的提及保持内联。
基础 Mentionables 和 Pro 扩展
基础 Mentionables 是基础插件。Pro 是一个可选的伴随插件,
与其一起安装;Pro 通过该依赖关系包含基础功能。
| 功能 | 基础 Mentionables | 带 Pro 扩展 |
|---|---|---|
| 从主题首帖导入 Markdown 表格 | 是 | 是 |
| 将源主题保留在受限类别中 | 是 | 是 |
| 仅限管理员的编辑器按钮以插入表格骨架 | 是 | 是,包括图标列 |
在 Markdown 和富文本编辑器中使用 + 搜索 |
是 | 是 |
| 内联提及胶囊和独立的原生 Onebox | 是 | 是 |
| 桌面悬停或键盘焦点时的浮动预览 | 是 | 是,在默认悬停模式下 |
| 使用服务账户从 Google Sheets 导入 | — | 是 |
| 在主题表格和 Google Sheets 之间选择 | 仅主题表格 | 是 |
| 每 12 小时自动同步 | — | 可选,默认关闭 |
| 导入可选的图标名称和 HTML 颜色 | — | 是,来自任一来源 |
| 点击或轻触时打开浮动预览,包括触摸设备 | — | 可选 |
Pro 的 icon 和 icon_colour 列在提及名称前添加彩色图标。
例如,对手册使用 book 和 #2563eb。启用
mentionables_pro_click_to_preview 后,点击或轻触胶囊会打开其
预览;预览中的打开原始页面链接会将您带到目标页面。
快速设置
-
使用上述安装指南安装基础插件。安装后重建 Discourse。
-
为您的目录创建一个主题。作为管理员,使用编辑器工具栏中的插入 mentionables 表格或将此表格粘贴到首帖中:
| name | url | slug | image_url | | ------------------ | ----------------------------------- | ------------------ | --------- | | Getting started | https://example.com/getting-started | getting-started | | | Community handbook | https://example.com/handbook | community-handbook | | | Events calendar | https://example.com/events | events-calendar | | -
用您自己的 URL 替换示例 URL,保存帖子,并将
mentionables_topic_id设置为该主题的数值 ID。保持mentionables_enabled
处于启用状态。对于此设置,Pro 安装应在mentionables_source中选择topic_table。 -
打开管理 → 插件 → Mentionables,点击开始导入,然后点击
刷新以检查报告。后台作业工作进程必须正在运行。 -
重新加载浏览器,打开编辑器,输入
+来尝试您的项目。
使用小写的列名。只有 url 是必需的,必须以 http://
或 https:// 开头。仅包含 URL 的行会从目标获取名称并生成
slug。您可以提供 name、slug 或两者来覆盖这些默认值,在一个表格中混合
使用这些选项。如果没有可用的标题,URL 将成为显示名称。当源省略 slug 时,现有 URL 保留其 slug。
image_url 和 description 是可选的。
导入器读取首帖中第一个未引用的包含 url 列的表格。
回复、引用的表格和围栏代码示例将被忽略。源主题
必须是常规且未删除的主题,而不是个人消息。
源隐私和更新您的目录
您可以将源主题保留在 Staff 或其他受限类别中,以便只有
受信任的人才能维护它。**导入的名称、URL 和图片
对 mentionables 的用户可用。**限制主题不会使
导入的目录私有。请勿在表格中保留机密信息。
每次导入都按 URL 同步:匹配的 URL 会更新,新的 URL 创建记录,
从源中移除的 URL 删除记录。完整的源必须
有效;重复的 URL 或 slug、无效的行、获取失败和空数据集
会使目录保持不变。有意清除时使用全部删除。
永远不会修改源主题和电子表格。Pro 的可选
mentionables_pro_sync_enabled 设置每 12 小时运行一次相同的导入。
导入后重新加载浏览器。现有的已渲染帖子不会自动
重新渲染,显式更改 slug 可能会破坏早期的 +slug 引用。
设置和更多信息
| 设置 | 目的 |
|---|---|
mentionables_enabled |
启用或禁用 Mentionables。 |
mentionables_topic_id |
在其首帖中包含源表格的主题。 |
mentionables_autocomplete_limit |
建议的最大数量;默认为五个。 |
mentionables_onebox_fallback |
当提供名称时也获取缺失的图片/描述;默认关闭。 |
请参阅 README 了解完整的设置指南、导入行为和
故障排除。截图使用插件测试固件中的示例数据。








