国际化UI字符串 internationalizing-ui-strings
Java™和JavaScript API使您能够国际化以下资源类型中的字符串:
- Java™源文件。
- jsp脚本。
- 客户端库或页面源中的JavaScript。
- 对话框和组件配置属性中使用的JCR节点属性值。
有关国际化和本地化过程的概述,请参阅国际化组件。
在Java™和JSP代码中国际化字符串 internationalizing-strings-in-java-and-jsp-code
com.day.cq.i18n
Java™包允许您在UI中显示本地化的字符串。 I18n
类提供从Adobe Experience Manager (AEM)词典中检索本地化字符串的get
方法。 get
方法的唯一必需参数是英语中的字符串文字。 英语是UI的默认语言。 以下示例将单词Search
本地化:
i18n.get("Search");
使用英语标识字符串不同于典型的国际化框架,在后者的框架中,ID用于标识字符串并在运行时引用字符串。 使用英语字符串文字具有以下优点:
- 代码易于理解。
- 默认语言的字符串始终可用。
确定用户的语言 determining-the-user-s-language
可以通过两种方式确定用户首选的语言:
- 对于经过身份验证的用户,根据用户帐户中的首选项确定语言。
- 所请求页面的区域设置。
用户帐户的语言属性是首选方法,因为它更可靠。 但是,用户必须登录才能使用此方法。
创建I18n Java™对象 creating-the-i-n-java-object
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);
将字符串国际化 internationalizing-a-string
使用I18n
对象的get
方法将字符串国际化。 get
方法的唯一必需参数是要国际化的字符串。 该字符串对应于Translator字典中的字符串。 get方法在词典中查找字符串并返回当前语言的翻译。
get
方法的第一个参数必须符合以下规则:
- 该值必须为字符串文字。 不接受
String
类型的变量。 - 字符串文字必须用一行表示。
- 字符串区分大小写。
i18n.get("Enter a search keyword");
使用翻译提示 using-translation-hints
指定国际化字符串的翻译提示以区分词典中的重复字符串。 使用get
方法的第二个可选参数来提供翻译提示。 翻译提示必须与词典中项目的Comment属性完全匹配。
例如,词典包含字符串Request
两次:一次作为动词,一次作为名词。 以下代码包含翻译提示作为get
方法中的参数:
i18n.get("Request","A noun, as in a request for a web page");
在本地化句子中包括变量 including-variables-in-localized-sentences
在本地化字符串中包含变量以将上下文含义构建到句子中。 例如,在登录到Web应用程序后,主页显示消息“欢迎返回管理员”。 您的收件箱中有两封邮件。” 页面上下文确定用户名和消息数。
在词典中,变量以字符串的形式表示为带括号的索引。 将变量的值指定为get
方法的参数。 参数位于翻译提示的后面,索引与参数的顺序相对应:
i18n.get("Welcome back {0}. You have {1} messages.", "user name, number of messages", user.getDisplayName(), numItems);
国际化字符串和翻译提示必须与词典中的字符串和注释完全匹配。 通过提供null
值作为第二个参数,可以省略本地化提示。
使用静态获取方法 using-the-static-get-method
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代码中国际化字符串 internationalizing-strings-in-javascript-code
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本地化“欢迎回来管理员”。 您的收件箱中有两封邮件。” 句子:
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");
将JCR节点中的字符串国际化 internationalizing-strings-from-jcr-nodes
UI字符串通常基于JCR节点属性。 例如,页面的jcr:title
属性通常用作页面代码中h1
元素的内容。 I18n
类提供了用于本地化这些字符串的getVar
方法。
以下示例JSP脚本从存储库检索jcr:title
属性并在页面上显示本地化的字符串:
<% title = properties.get("jcr:title", String.class);%>
<h1><%=i18n.getVar(title) %></h1>
指定JCR节点的翻译提示 specifying-translation-hints-for-jcr-nodes
与Java™ API🔗中的翻译提示类似,您可以提供翻译提示以区分词典中的重复字符串。 提供翻译提示作为包含国际化属性的节点的属性。 hint属性的名称由带_commentI18n
后缀的国际化属性名称组成:
${prop}_commentI18n
例如,cq:page
节点包含正在本地化的jcr:title属性。 提示作为名为jcr:title_commentI18n的属性的值提供。
测试国际化范围 testing-internationalization-coverage
测试您是否已经国际化了UI中的所有字符串。 要查看包含哪些字符串,请将用户语言设置为zz_ZZ,然后在Web浏览器中打开UI。 国际化字符串与存根翻译一起显示,格式如下:
USR_*Default-String*_尠
下图显示了AEM主页的存根翻译:
要为用户设置语言,请为用户帐户配置首选项节点的语言属性。
用户的首选项节点的路径如下所示:
/home/users/<letter>/<hash>/preferences