第四十三章 在CSP应用程序中本地化文本 - 本地化的基础
本地化的基础
当本地化应用程序的文本时,将用一种语言创建文本字符串的目录,然后建立一种约定,在应用程序地区不同时用另一种语言替换这些消息的翻译版本。
Caché
支持以下本地化字符串的过程:
- 开发人员在他们的代码中包含可本地化的字符串。 在
CSP
应用程序中,最简单的方法是使用基于类的开发并使用$$$Text
宏之一。 在硬编码字面值字符串的地方,包含$$$Text宏(或相关宏)的实例,为宏参数提供如下值:
- 默认字符串
- 该字符串所属的域(当字符串被分组到域中时,本地化更容易管理)
- 默认字符串的语言代码
&html<<div>"Hello world"</div>> 复制代码
包括:
set hello=$$$Text("Hello world","sampledomain","en-us") &html<<div>#(hello)#</div>> 复制代码
- 编译代码时,编译器为
$$$Text
宏(及其相关宏)的每个惟一实例在消息字典中生成条目。 消息字典是全局的,因此可以很容易地在管理门户中查看(例如)。Caché
提供类方法来帮助完成常见任务。 - 开发完成后,发布工程师为该域或所有域导出消息字典。
结果是一个或多个包含原始语言文本字符串的XML
消息文件。
- 发布工程师将这些文件发送给翻译人员,要求翻译版本。
- 发布工程师将翻译后的
XML
消息文件导入导出原始消息文件的同一名称空间。 - 在信息词典中,译文与原文并存。
- 在运行时,应用程序根据浏览器默认语言选择要显示的文本。
$$$Text Macros
Caché提供了三个相关的$$$Text
宏(在%occMessages
中)。 包含在%occInclude.inc中):
$$$Text
返回一个%String
$$$TextJS
返回一个%String
,该字符串被转义后用于JavaScript
$$$TextHTML
返回一个%字符串,该字符串被转义以用于HTML
每个宏都有三个参数:默认字符串、该字符串所属的域以及默认字符串的语言代码。编译代码时,编译器会在消息字典中为每组唯一的参数值生成条目。
$$$Text
返回的%String
可能会被赋给一个变量,可以用它来表示后续调用中的消息。例如:
Set tmsg = $$$TextJS("Error saving production") &js<alert('#(tmsg)#: #($ZCVT($ZE,"O","JS"))#');> 复制代码
或者,可以在需要字符串的任何地方插入一个$$$Text
宏:
&js<alert('#($$$TextJS("Error saving production"))#: #($ZCVT($ZE,"O","JS"))#');> 复制代码
参数详细信息
形式上,$$$Text
、$$$TextJS
和$$$TextHTML
宏按顺序接受下列参数:
text
- 非空字符串。文本必须是文字字符串。它不能是用#()#
语法括起来的CSP
运行时表达式的值。用于文本的格式可以是:“actualText”
或:“@textId@actualText”
,其中textId
是消息Id
,actualText
是消息的文本。字符串actualText
可以由下列各项单独或组合组成:
- 文件格式允许的简单文本
- 替换参数
%1
、%2
、%3
或%4
HTML
格式ObjectScript
字符串表达式
- 如果提供了
textId
,则将其用作消息Id
。如果未指定@textId@
,系统将通过计算此文本的32
位CRC
(循环冗余校验)来生成新的textId
。如果指定了textId
,并且具有该Id
的消息已经存在,则检查现有消息,看它是否具有与actualText
相同的文本。否则,会报告一个错误。 domain
- (可选)为新消息指定域的字符串。如果未指定,domain
默认为编译时DOMAIN
类参数的值和%response
。运行时的域。(可选)RFC 1766
在指定语言的新标签代码中打开。Caché
将该字符串转换为全小写。如果未指定,语言默认如下:
- 编译时:
$$$DefaultLanguage
。 - 在运行时:
%Response.Language
,或者如果没有为%Response.Language
定义值,则$DefaultLanguage
。
language
- 基于标签的CSP
页面会自动从浏览器设置中获取%Response.Language
的值,因此它可以作为默认语言使用。对于基于类的CSP
页面则不是这样,它必须显式地为%Response.Language
设置一个值以将其用作默认值。可以通过在类方法MatchLanguage()
中为%Response.Language
赋予%Library.MessageDictionary
的返回值来为其赋值,本章稍后将对此进行讨论。在给定语言列表和域名的情况下,此方法使用HTTP1.1
匹配规则(RFC2616
在)在域中查找最佳匹配语言。
$$$Text at Compile Time
编译包含$TEXT
、$TextJS
或$TextHTML
宏的调用的类时,每次调用都会在消息字典中生成一条消息,其中包含宏参数提供的文本、消息ID、域和语言。
第一次通过$$$Text
将消息添加到域中时,无论是否指定了语言参数,都会使用$$$SessionLanguage
。同一域的后续$$$Text
宏会添加与第一个添加的消息语言相同的消息。
$$$Text at Runtime
如果消息文本包含参数(%1,%2,%3,%4
),必须在显示文本之前指定相应的替换文本。因为$$$Text
返回一个字符串,所以可以使用编码语言自带的任何字符串操作。例如,在JavaScript
中:
var prompt = '#($$$TextHTML("Remove user %1 from this Role?"))#'; prompt = prompt.replace(/%1/g,member.userName); 复制代码
还可以使用$$$$Text
字符串作为%response
的第一个参数。FormatText
方法或$$$FormatText
宏。