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的輸出。 |
對輸出面板使用描述性名稱。 |
側邊欄 | 在編輯和調試模式下可用的視圖,可用於瀏覽項目,文件和書簽,以及查看類層次結構。 |
您可以將視圖添加到側邊欄菜單。 使用描述性名稱。 |
視圖 | 屏幕上為用戶顯示信息,以及為用戶提供管理信息功能的區域。 調試模式下可用,用於與在調試器控制下運行的程序進行交互。 |
對視圖使用描述性名稱。 |
原創造福大家,共享改變世界
獻出一片愛心,溫暖作者心靈
