Discourse 文档和界面中的文本格式化

:information_source: Discourse UI 和文档目前正在审查和编辑中,以符合这些指南。我们正努力尽快实现全面对齐。

在为 Discourse 撰写内容时,请注意以下文本格式设置指南。这些指南适用于所有区域的文本,尤其是在文档和 Discourse UI 中。

字体大写

在撰写文档或 UI 文本时,默认使用句子大小写(即,短语的第一个字母大写,其余字母小写)。

重要提示:

  • 标题、题目和类别名称使用句子大小写。
  • Discourse 功能的名称大写,只有以下例外:

功能名称不使用任何其他格式,包括不使用粗体、斜体、反引号、引号或任何其他格式。

字体大写例外情况包括:

  • 缩写词必须始终正确大写。
  • 产品和品牌名称必须根据其品牌指南进行大写。
  • 插件和主题名称必须正确大写。
  • 在引用菜单项、按钮标签或表单选项时,请大写第一个单词的首字母 - 例如,“Click the New topic button to start writing.”(点击“新建主题”按钮开始撰写)。
  • 如果 UI 中某项内容因故大写,则在撰写相关文档时也应使用相同的字体大写。
  • 类别和 URL 缩略语始终为小写。

如有疑问,请使用句子大小写。

句号

请勿在以下情况中使用句号:

  • 工具提示、图片说明或其他只有一个句子的 UI 元素
  • 按钮标签
  • 菜单项
  • 不包含动词的列表项

在以下情况中使用句号:

  • 普通句子
  • 工具提示、图片说明或其他包含多个句子的 UI 元素
  • 包含动词的列表项
  • 图片 alt 文本

列表项的注意事项: 如果您正在编写一个包含混合项目(即有些需要句号,有些不需要)的列表,请为所有项目都使用句号。

强调

要强调单词,默认使用斜体。如果您觉得粗体更符合上下文,也可以使用粗体

反引号

使用反引号(``)来表示行内代码、示例 URL 和设置名称。请勿将其用于任何其他目的。

代码块

包含代码块时,请尽可能通过在开头反引号(前三个反引号)之后立即添加来指定编码语言 - 例如 ```css

5 个赞

Data Explorer 不是插件名称吗?因此,它是否包含在

为什么不使用按钮的确切拼写?这样我更容易识别它。
New Topic

最近这里也这样做了

1 个赞

这是事实,但在这里单独列出仍然是值得的,因为它在 Discourse 中算是一种独特的功能。

我们绝对应该使用按钮的确切拼写,但按钮本身一开始就不应该那样写。这些指南适用于所有 UI 元素以及文档。为此,我们将逐步更新 Discourse 以符合这些指南——这可能需要一些时间,所以在我们完成所有这些工作之前,文档中的大写和 UI 中的大写之间会存在细微的差异。

1 个赞

供参考,这里已修复 UX: Use correct case for "Add Flag" button by martin-brennan · Pull Request #29505 · discourse/discourse · GitHub

1 个赞