标准 UI 术语

本节中使用的用户界面 (UI) 术语用作集合术语，指的是

• 图形用户界面 (GUI)

• Web 用户界面 (WUI)

• 命令行界面 (CLI)

本节提供有关如何描述 UI 元素的通用指南，以及首选的动词和名词。

命令行界面指南

在记录读者必须在命令行界面 (CLI) 中执行的操作时，请使用以下指南

• 对于内联命令、文件名、目录、选项等，请使用相关的 RST 指令。有关详细信息，请参阅 内联元素。

• 将代码片段格式化为独立的字面块。有关详细信息，请参阅 代码示例。

• 当您提供命令的输出时，请考虑用户是否需要查看所有输出或部分输出。如果输出包含多行，请考虑截断输出。使用省略号 (…) 来显示页面显示的是输出的一部分。

• 始终使用 OpenStack Client openstack 用于 CLI 命令，而不是 per-project CLI 工具，例如 nova。

• 根据您是在运行文本中还是在过程中描述 CLI 操作，请考虑以下用法

  在运行文本中

  不要使用	使用
  您可以使用 ping 来验证两个设备之间的网络连接。	您可以使用 ping 命令来验证两个设备之间的网络连接。
  您可以使用 openstack server image create 命令来创建快照。	您可以使用 openstack server image create 命令来创建快照。

  
  

  在过程中

  不要使用	使用
  通过运行 restart 命令来关闭 VM。	通过运行 restart 来关闭 VM。
  通过运行 restart 命令来关闭 VM。	通过运行 restart 来关闭 VM。

图形和 Web 用户界面指南

在记录 GUI 和 WUI 时，请使用以下指南

• 完全按照它们在 UI 中显示的方式编写 UI 元素的名称，包括标点符号。

• 对所有图形和 Web UI 元素使用 :guilabel: RST 标记。

  示例： 单击 确定。

• 在描述 GUI 和 WUI 中的过程时，从 UI 中的位置开始一个步骤。这有助于不熟悉它的用户快速找到所需的元素。

  示例： 在 节点 选项卡中，单击 添加节点。

• 在描述 GUI 和 WUI 时，使用以下标准 UI 术语

  标准 UI 术语：动词

  术语	含义
  单击	按下并释放鼠标按钮的行为。
  按下	需要按下键盘上的按钮（物理上）、电源按钮等的操作。
  类型	将按键输入到文本框等的操作。

  
  

  标准 UI 术语：名词

  术语	含义
  Field	需要在其中输入信息的 WUI 或 GUI 中的区域。
  对话框	在操作后出现的弹出窗口。不要使用 屏幕。
  面板	工具栏或控制面板。
  窗格	WUI 或 GUI 中可以滚动和调整大小的独立区域。
  按钮	单击后执行操作的图形或 Web 元素。
  图标	代表操作快捷方式的图形或 Web 元素。
  选项卡	将一组操作分组的图形或 Web 元素。
  向导	引导用户完成执行特定任务的步骤序列的对话框。

有关更多详细信息，请使用 IBM 术语 作为参考。