User Interface Text Guidelines
- 語法和風格
- 標點
  - 撰寫工具提示tooltips
    - 設計模式中撰寫工具提示
  - 撰寫訊息
- UI文本大寫
  - 使用書本樣式大寫
    - 檢查書本樣式大寫
  - 使用句子樣式大寫
- 準備本地化
  - 標記UI文本進行翻譯
  - 語言或書寫系統的特征
- Qt Creator通用條款

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文本或檔案中標題的書籍樣式大寫：

在瀏覽器中打開to-title-case.html，
在欄位中輸入用戶界面文本，
單擊轉換，

帶有建議的書本樣式大寫的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的輸出，	對輸出面板使用描述性名稱，
側邊欄	在編輯和除錯模式下可用的視圖，可用于瀏覽專案，檔案和書簽，以及查看類層次結構，	您可以將視圖添加到側邊欄選單，使用描述性名稱，
視圖	螢屏上為用戶顯示資訊，以及為用戶提供管理資訊功能的區域，除錯模式下可用，用于與在除錯器控制下運行的程式進行互動，	對視圖使用描述性名稱，

原創造福大家，共享改變世界

獻出一片愛心，溫暖作者心靈

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/17803.html

標籤：其他

上一篇：qt creator原始碼全方面分析(2-5)

下一篇：qt creator原始碼全方面分析(2-7)

qt creator原始碼全方面分析(2-6)