Java和Javascript API可讓您將字串國際化為下列類型的資源:
有關國際化和本地化流程的概述,請參閱國際化元件。
com.day.cq.i18n
Java套件可讓您在UI中顯示本地化字串。 I18n
類別提供從AEM字典擷取本地化字串的get
方法。 get
方法的唯一必要參數是英語中的字串常值。 英文是UI的預設語言。 下面的示例將單詞Search
本地化:
i18n.get("Search");
以英文識別字串不同於一般的國際化架構,其中ID可識別字串,並在執行時期用來參考字串。 使用英文字串常值可提供下列優點:
有兩種方式可決定使用者偏好的語言:
使用者帳戶的語言屬性是偏好的方法,因為它更可靠。 但是,用戶必須登錄才能使用此方法。
I18n類提供兩個建構子。 您如何決定使用者偏好的語言,以決定要使用的建構函式。
若要以使用者帳戶中指定的語言呈現字串,請使用下列建構函式(匯入com.day.cq.i18n.I18n)
後):
I18n i18n = new I18n(slingRequest);
建構函式使用SlingHTTPRequest
來擷取使用者的語言設定。
若要使用頁面地區設定來判斷語言,您首先需要取得所請求頁面語言的ResourceBundle:
Locale pageLang = currentPage.getLanguage(false);
ResourceBundle resourceBundle = slingRequest.getResourceBundle(pageLang);
I18n i18n = new I18n(resourceBundle);
使用I18n
物件的get
方法來國際化字串。 get
方法的唯一必要參數是要國際化的字串。 該字串與Translator字典中的字串相對應。 get方法會在字典中查找字串並返回當前語言的翻譯。
get
方法的第一個引數必須符合下列規則:
String
的變數不可接受。i18n.get("Enter a search keyword");
指定國際化字串的轉換提示,以區分字典中的重複字串。 使用get
方法的第二個可選參數提供翻譯提示。 翻譯提示必須與字典中項目的「注釋」屬性完全匹配。
例如,字典包含字串Request
兩次:一次是動詞,一次是名詞。 以下代碼包括翻譯提示作為get
方法中的參數:
i18n.get("Request","A noun, as in a request for a web page");
在本地化字串中加入變數,將內容相關意義建立至句子中。 例如,登入Web應用程式後,首頁會顯示訊息「歡迎返回管理員」。 收件匣中有2條訊息。」 頁面內容會決定使用者名稱和訊息數量。
在字典中,變數在字串中表示為方括弧內的索引。將變數的值指定為get
方法的參數。 引數將按照轉換提示放置,索引與引數的順序相對應:
i18n.get("Welcome back {0}. You have {1} messages.", "user name, number of messages", user.getDisplayName(), numItems);
國際化字串和翻譯提示必須與字典中的字串和注釋完全匹配。 通過提供null
值作為第二個引數,可以省略本地化提示。
I18N
類定義了靜態get
方法,當需要本地化少量字串時,該方法非常有用。 除了對象的get
方法的參數外,靜態方法還需要您使用的SlingHttpRequest
對象或ResourceBundle
,具體取決於您確定用戶首選語言的方式:
使用使用者的語言偏好設定:提供SlingHttpRequest作為第一個參數。
I18n.get(slingHttpRequest, "Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);
使用頁面語言:提供ResourceBundle作為第一個參數。
I18n.get(resourceBundle,"Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);
Javascript API可讓您在用戶端上本地化字串。 與Java和JSP程式碼一樣,Javascript API可讓您識別要本地化的字串、提供本地化提示,以及在本地化的字串中加入變數。
granite.utils
用戶端程式庫資料夾提供Javascript API。 若要使用API,請在您的頁面上加入此用戶端程式庫資料夾。 本地化函式使用Granite.I18n
命名空間。
在顯示本地化字串之前,需要使用Granite.I18n.setLocale
函式設定區域設定。 函式需要語言環境的語言代碼作為參數:
Granite.I18n.setLocale("fr");
若要呈現本地化字串,請使用Granite.I18n.get
函式:
Granite.I18n.get("string to localize");
下列範例將字串"Welcome back"國際化:
Granite.I18n.setLocale("fr");
Granite.I18n.get("string to localize", [variables], "localization hint");
函式參數與Java I18n不同。get方法:
下列範例使用Javascript來本地化「歡迎返回管理員」。 收件匣中有2條訊息。」 句子:
Granite.I18n.setLocale("fr");
Granite.I18n.get("Welcome back {0}. You have {1} new messages in your inbox.", [username, numMsg], "user name, number of messages");
UI字串通常以JCR節點屬性為基礎。 例如,頁面的jcr:title
屬性通常用作頁面程式碼中h1
元素的內容。 I18n
類提供了用於定位這些字串的getVar
方法。
以下示例JSP指令碼從儲存庫中檢索jcr:title
屬性,並在頁上顯示本地化字串:
<% title = properties.get("jcr:title", String.class);%>
<h1><%=i18n.getVar(title) %></h1>
與Java API](#using-translation-hints)中的[翻譯提示類似,您可以提供翻譯提示來區分字典中的重複字串。 提供翻譯提示作為包含國際化屬性的節點的屬性。 提示屬性的名稱由具有_commentI18n
尾碼的國際化屬性名稱組成:
${prop}_commentI18n
例如,cq:page
節點包含正在本地化的jcr:title屬性。 提示是作為名為jcr:title_commentI18n的屬性值提供的。
測試您的UI中的所有字串是否已國際化。 若要查看涵蓋哪些字串,請將使用者語言設為zz_ZZ,然後在網頁瀏覽器中開啟UI。 國際化字串以下列格式顯示存根轉換:
USR_*Default-String*_尠
下圖顯示AEM首頁的存根翻譯:
要設定用戶的語言,請為用戶帳戶配置首選項節點的語言屬性。
用戶的首選項節點具有如下路徑:
/home/users/<letter>/<hash>/preferences