Discourse UI 和文档目前正在审查和编辑中,以符合这些指南。我们正努力尽快实现全面对齐。
在为 Discourse 撰写内容时,请注意以下文本格式设置指南。这些指南适用于所有区域的文本,尤其是在文档和 Discourse UI 中。
字体大写
在撰写文档或 UI 文本时,默认使用句子大小写(即,短语的第一个字母大写,其余字母小写)。
重要提示:
- 标题、题目和类别名称使用句子大小写。
- Discourse 功能的名称不大写,只有以下例外:
功能名称不使用任何其他格式,包括不使用粗体、斜体、反引号、引号或任何其他格式。
字体大写例外情况包括:
- 缩写词必须始终正确大写。
- 产品和品牌名称必须根据其品牌指南进行大写。
- 插件和主题名称必须正确大写。
- 在引用菜单项、按钮标签或表单选项时,请大写第一个单词的首字母 - 例如,“Click the New topic button to start writing.”(点击“新建主题”按钮开始撰写)。
- 如果 UI 中某项内容因故大写,则在撰写相关文档时也应使用相同的字体大写。
- 类别和 URL 缩略语始终为小写。
如有疑问,请使用句子大小写。
句号
请勿在以下情况中使用句号:
- 工具提示、图片说明或其他只有一个句子的 UI 元素
- 按钮标签
- 菜单项
- 不包含动词的列表项
请在以下情况中使用句号:
- 普通句子
- 工具提示、图片说明或其他包含多个句子的 UI 元素
- 包含动词的列表项
- 图片
alt文本
列表项的注意事项: 如果您正在编写一个包含混合项目(即有些需要句号,有些不需要)的列表,请为所有项目都使用句号。
强调
要强调单词,默认使用斜体。如果您觉得粗体更符合上下文,也可以使用粗体。
反引号
使用反引号(``)来表示行内代码、示例 URL 和设置名称。请勿将其用于任何其他目的。
代码块
包含代码块时,请尽可能通过在开头反引号(前三个反引号)之后立即添加来指定编码语言 - 例如 ```css。