自定义常见问题与指南

:bookmark: 本指南面向管理员,介绍如何自定义 Discourse 站点上的常见问题解答(FAQ)和指南页面。

:person_raising_hand: 所需用户等级:管理员

在 Discourse 中自定义常见问题解答和指南页面,可以让内容更贴合您社区的具体需求和规则。这些页面通常是新用户了解期望行为的首要参考点,同时也可为现有成员提供资源。

常见问题解答和指南页面

默认情况下,Discourse 仅包含一个常见问题解答(FAQ)页面。

不过,您也可以创建一个指南页面。这样可以让每个页面的内容更加聚焦:常见问题解答页面处理常见疑问,而指南页面则阐述社区规则。

若要在您的站点添加指南页面,您需要在 faq url 管理设置中添加一个主题 URL 或外部 URL。您也可以在此处使用 已发布的页面 的 URL。

这将创建一个指南页面(可通过 .../guidelines 访问),并与现有的 FAQ 标签页并存。

将“常见问题解答”重命名为“指南”(即将推出的变更)

Discourse 正在推出一项 即将推出的变更rename_faq_to_guidelines),该变更会将导航中的“常见问题解答”页面重命名为“指南”。启用此变更后:

  • 导航标签将显示 指南 而非 常见问题解答
  • /faq/rules/conduct 均会重定向至 /guidelines(当 faq_url 未设置时)
  • 侧边栏链接将从“常见问题解答”变为“指南”
  • 如果 faq_url 设置,则“指南”和“常见问题解答”标签仍会同时显示(与之前相同)

常见问题解答页面的内容保持不变——仅标签和路由发生变化。您可以从 管理 → 即将推出的变更 页面管理此变更。

常见问题解答和指南内容

Discourse 的常见问题解答页面自带默认内容,可作为论坛指南和常见问题解答的模板。要编辑此内容:

  1. 导航至您论坛上的 常见问题解答/指南 主题。该主题通常在 Discourse 实例设置时默认创建,通常固定在工作人员分类中,但如果被移动,也可能出现在其他分类中。
  2. 像编辑论坛上的任何其他主题一样编辑该帖子。作为管理员或版主,您可以修改文本以符合您社区的规则和期望。
  3. 完成必要更改后,保存编辑以更新常见问题解答页面的内容。

如果您希望链接到外部常见问题解答页面,可以将 faq_url 站点设置更改为指向您外部常见问题解答页面的 URL。

如果您已添加指南页面,该页面将使用 常见问题解答/指南 主题作为其内容。您可以按照上述类似流程自定义指南页面的内容。

导航标签名称

您可以在 管理 → 自定义 → 文本 页面(.../admin/customize/site_texts/)上自定义导航菜单中用于常见问题解答和指南的文本标签。

搜索 js.guidelinesjs.faq 以找到对应导航标签的文本内容,并将其更改为您偏好的术语。

您还可以通过编辑 js.sidebar.sections.community.links.faq.content 来更新侧边栏中用于常见问题解答的导航标签。如果启用了 rename_faq_to_guidelines 即将推出的变更,则改为编辑 js.sidebar.sections.community.links.guidelines.content

有关此过程的更多详细信息,请参阅 https://meta.discourse.org/t/customize-any-text-in-discourse/36092。

URL 路由

如果站点不包含指南页面,您可以通过以下 URL 别名访问常见问题解答页面:

  • /faq
  • /guidelines
  • /rules
  • /conduct

如果站点包含指南页面,则可以使用以下 URL 访问指南页面:

  • /guidelines
  • /rules
  • /conduct

当存在指南页面时,常见问题解答页面只能通过 /faqSiteSetting.faq_url 访问。

:bulb: 当启用 rename_faq_to_guidelines 即将推出的变更且未设置 faq_url 时,/faq/rules/conduct 均会重定向至 /guidelines

:person_raising_hand: 是否有办法更改如 /faq/guidelines 这样的 URL 路由?

不行。Discourse 没有核心功能来更改这些路由,但可以通过插件实现。

隐藏导航标签

根据您希望如何构建站点,您可能希望隐藏常见问题解答和指南页面的导航链接。这可以通过 在您的站点上进行 CSS 更改 来实现。

具体来说,您可以使用以下 CSS 隐藏常见问题解答和指南的导航标签名称:

隐藏常见问题解答导航标签

.nav-pills .nav-item-faq {
    display: none;
}

隐藏指南导航标签

.nav-pills .nav-item-guidelines {
    display: none;
}

此外,您还可以使用以下代码隐藏侧边栏/汉堡菜单中的常见问题解答按钮:

li[data-list-item-name="faq"]{
    display: none;
}

如果启用了 rename_faq_to_guidelines 即将推出的变更,侧边栏项目名称将变为“指南”,因此请使用:

li[data-list-item-name="guidelines"]{
    display: none;
}

将指南添加到侧边栏

您可以使用 自定义汉堡菜单链接 主题组件,将指南页面的链接添加到汉堡菜单或侧边栏。有关如何安装此组件的详细信息,请参阅 安装主题或主题组件

安装主题组件后,您可以使用以下条目添加指向指南页面的链接:

指南,/guidelines,g

社区管理提示

在 Discourse 上自定义常见问题解答和指南对于塑造您社区独特的身份和文化以及明确空间期望至关重要。这不仅有助于培养社区归属感,还能清晰说明“可为”与“不可为”的事项,从而显著减少管理工作量并提升用户体验。

结构良好的常见问题解答部分对于高效地引导新成员加入非常有价值,因为它可以预先回答常见问题,从而为更深入、更具参与性的讨论腾出空间。

以积极的语气撰写这些文件,并通过清晰的示例突出鼓励的行为,将大有裨益。保持内容简洁,并利用项目符号和标题进行良好组织,也有助于使信息更易于消化。

9 个赞