qt creator源码全方面分析(2-6)

目录

User Interface Text Guidelines

请遵循本节中的准则，以确保扩展与Qt Creator UI保持一致，并且可以轻松地将其本地化为其他语言。

编写UI文本时，请确保它：

  • 与现有的Qt Creator用户界面条款一致
  • 简明扼要
  • 中性，描述性和事实正确
  • 明确的
  • 可翻译成不同的语言

语法和风格

所有UI文本必须为语法正确的英语，并使用标准形式的书面语言。不要使用方言。使用惯用语言，即英语特有的表达。如果可能，请以英语为母语的人进行评论。

用户界面文本应简洁明了且经济实惠。避免使用不必要的内容词和短语。但是，更重要的是使文本有用且易于理解。

避免以第二个人称称呼用户。使用中性语调或被动语态，但在必要时使用称呼。称呼用户时，请避免使用“请”一词。例外情况是一些版权文本和简短的命令式句子，否则听起来可能会粗鲁。例如，请稍候。

避免在菜单名称和项目中使用缩写。如果没有足够的空间可以完整拼写或连字，请根据英语缩写规则将文本缩写。

避免缩写。例如，使用cannot 而不是can't。

标点

避免在菜单名称和菜单项中使用标点符号或特殊字符。

使用标点符号如下：

  • 在消息中使用句号。
  • 切勿在菜单项名称的末尾使用句号(.)。
  • 放置三个句号(...)在菜单项名称的末尾，这将打开一个需要用户操作的对话框。
  • 使用感叹号(!)，仅在需要用户特别注意或特别重要的文本中。
  • 在变量值周围使用引号("")。 例如，关闭项目"qtcreator"。为了保持一致，请在用户可见的字符串中使用双引号突出显示或设置文件名，目录名，URL等。
  • 不要使用前导，尾随或多个空格来对齐消息中的文本，因为翻译工具可能无法正确处理它们。

编写工具提示tooltips

工具提示包含有关图标，菜单项或其他UI元素的有用信息。当用户将鼠标指针放在UI元素上时，它们就会出现。您还可以向用户界面添加始终可见的描述性文本。

对于图标，可以将命令名用作工具提示。在这种情况下，请使用书本样式大写(book style capitalization)，并且不要在工具提示后添加句点。

工具提示也可以包含完整的句子。尝试使它们尽可能短而简洁，同时仍使它们在语法上正确。就像对任何句子一样，使用句子样式大写(sentence style capitalization)和标点符号。

设计模式中编写工具提示

在Qt Designer中，将纯文本用作工具提示。要获得更多格式，请在富文本编辑器的源选项卡中，编写简短的规范HTML：<html><head/><body><b>Note:</b> text.

Qt Designer具有简化富文本格式的功能（默认情况下处于启用状态），但仍然应通过查看源选项卡进行验证。

编写消息

检查消息是否简洁明了且经济合理。 但是，更重要的是消息是有用的并且易于理解。

尽量减少使用许多新的和不同的句子结构。 重用在类似情况下使用的句子结构。 例如：

  • 无法将日志作为所选消息类型发送。文字太长。
  • 无法接收图像。
  • 无法插入图片。 文字长度上限为120个字符。
  • 图片名称已被使用。
  • 文件夹名称已被使用。

UI文本大写

使用两种样式，书名和句子样式（book title and sentence style）：

  • 示例 Example of Book Title Capitalization

  • 示例 Example of sentence style capitalization

使用书本样式大写

使用书本样式大写时，大写所有单词，除少于五个字母的介词（例如，是'with'而不是'Without'），连词（例如，and, or, but）和冠词（a, an, the ）。 但是，请始终将大写第一个和最后一个的上述单词。

将书本样式大写用于：

  • 标题（窗口，对话框，组框，选项卡，列表视图列等）
  • 功能（菜单项，按钮）
  • 可选择项目（组合框项目，列表框项目，树形列表项目等）

检查书本样式大写

您可以使用\doc\titlecase文件夹中的to-title-case.js脚本来检查UI文本或文档中标题的书籍样式大写：

  1. 在浏览器中打开to-title-case.html。
  2. 在字段中输入用户界面文本。
  3. 单击转换。

带有建议的书本样式大写的UI文本显示在右侧的字段中。

使用句子样式大写

当使用句子样式大写时，除专有名称外，仅大写第一个字母。

将句子样式大写用于：

  • 标签
  • 工具提示
  • 描述性文本
  • 其他非头或标题文字

准备本地化

Qt Creator已本地化为多种语言。一致性和简洁性使UI文本更易于翻译。

标记UI文本进行翻译

确保呈现给用户的文本字符串易于翻译。用户界面文本字符串包含在tr()调用中，并在翻译过程中从源代码中提取。因此，翻译器可能不知道消息的源代码上下文。

您可以添加注释，使之在Qt Linguist( //:)中可见，以阐明上下文。例如：

  //: Contact book "Add person" button label
  return tr("Add");

如果该类不是Q_OBJECT，请使用QCoreApplication::translate("class context", "message")或考虑使用Q_DECLARE_TR_FUNCTIONS。不要使用QObject::tr()，这会造成混淆，因为消息在Qt Linguist中按类上下文分组显示，而与QObject绑定的消息没有类上下文。

传递给tr().arg()的文件和目录名称，使用QDir::toNativeSeparators()。

不要使用跨越整个字符串的标记，因为这会使翻译人员感到困惑。例如，不采用：

tr("<html><head/><body><span>UI Text</span></body></html>")

采用

QLatin1String("<html><head/><body><span>") + tr("UI Text") + QLatin1String("/span></body></html>")

语言或书写系统的特征

为了使扩展本地化，请考虑语言和书写系统对实现的影响。

不好意思，这一小节我也看的不知所云，大家感兴趣直接看原文吧，sry

语言或书写系统的特征 对实现的影响
字序 不同的语言具有不同的字序规则。
不要使用运行时串联。 请使用完整的短语和"%1"格式。 例如，使用：
tr("Foo failed: %1").arg(message)
代替
tr("Foo failed: ") + message
单数，复数，对偶形式 某些语言没有复数形式（例如，中文和日语），而另一些语言具有双重形式。
在布局设计中为文本扩展留出空间。 一些语言需要更多空间来表示多个或双重性以传达所需的信息。
例如使用
tr("%n files found", 0, number)
代替
tr("%1 files found").arg(number)
性别 有些语言具有性别（女性，男性，中性），而有些则没有（例如芬兰语）或没有广泛使用（例如英语）。
不要重复使用文本字符串。 由于基本单词的性别，同一术语可能无法在其他情况下使用。
文章在某些语言中具有语法性别，而且在英语中句子不如容易被构造。 避免以下类型的构造：
tr("%1 failed").arg(someCondition ? "the operation" : "opening a file")

Qt Creator通用条款

本节总结了用于常见Qt Creator UI组件的术语。 它还描述了命名不同类型的UI组件的约定。

始终检查您打算使用的术语在UI中是否没有其他含义。如果已经存在合适的术语，请使用它。 例如，将查找Find用于搜索，将新建New用于创建新对象的向导。

有关如何添加UI组件的更多信息，请参见Common Extension Tasks。

UI文本 使用 约定
上下文菜单 当用户右键单击屏幕时打开。 内容取决于上下文。
 您可以添加与特定上下文相关的菜单项。 请遵循命名菜单项的约定。
对话框 用户界面元素通常包含许多选择，或允许用户向应用程序提供输入。 当用户选择菜单项或按钮时打开。
 使用菜单项或按钮名称作为对话框名称。 您也可以将菜单项或按钮名称与对话框中管理的对象名称结合在一起。例如，文档选项中的添加按钮将打开添加文档对话框。
定位器 使您不仅可以浏览文件，还可以浏览定位过滤器（locator filter）得到的任何条目。
 您可以添加定位过滤器。 检查过滤器是否尚未使用，并为其指定描述性名称。
菜单 包含代表命令或选项的菜单项，并在逻辑上进行分组和显示。 菜单也可以包含子菜单。
 您可以创建新菜单。 使用与现有菜单名称一致的简短但描述性的名称。 使用无歧义的名称。
菜单项 表示供用户选择的命令或选项。
 您可以将新条目添加到菜单。 使用与现有菜单名称一致的简短但描述性的名称。 使用无歧义的名称。
消息框 以状态信息，警告或错误消息的形式向用户提供反馈的对话框。

来自Qt Creator的输出应该显示在输出面板中。		 使用事件作为标题，并在消息框中提供解决方案。
模式 模式对应于全屏幕控件，专门用于任务。
 例如，您可以为新型编辑器添加模式。 使用描述性但简短的模式名称。 它们必须适合于模式选择器。
输出面板 任务面板中显示的面板，显示Qt Creator的输出。
 对输出面板使用描述性名称。
侧边栏 在编辑和调试模式下可用的视图，可用于浏览项目，文件和书签，以及查看类层次结构。
 您可以将视图添加到侧边栏菜单。 使用描述性名称。
视图 屏幕上为用户显示信息，以及为用户提供管理信息功能的区域。 调试模式下可用，用于与在调试器控制下运行的程序进行交互。
 对视图使用描述性名称。

原创造福大家，共享改变世界

献出一片爱心，温暖作者心灵

posted @ 2020-02-15 17:08  codeForFamily  阅读(976)  评论(0)  编辑  收藏  举报