_ (public)

 _ key [ substitution_list ]

Defined in packages/acs-lang/tcl/lang-message-procs.tcl

Short hand proc that invokes the lang::message::lookup proc. Returns a localized text from the message catalog with the locale ad_conn locale if invoked within a request, or the system locale otherwise.

Example:

    set the_url [export_vars -base "[ad_conn package_url]view" { item_id }]
    set body [_ my-package.lt_To_view_this_item [list item_url $the_url]]

If the message value is "To view this item, please click here: %item_url%", then the URL will be insert into the message.

Parameters:

key (required)

Unique identifier for this message. Will be the same identifier for each locale. The key is on the format package_key.message_key

substitution_list (optional)

A list of values to substitute into the message on the form { name value name value ... }. This argument should only be given for certain messages that contain place holders (on the syntax %1:pretty_name%, %2:another_pretty_name% etc) for embedding variable values. If the message contains variables that should be interpolated and this argument is not provided then upvar will be used to fetch the variable values.

Returns:

A localized message

Authors:

Jeff Davis <davis@xarg.net>

Peter Marklund <peter@collaboraid.biz>

Christian Hvid <chvid@collaboraid.biz>

See Also:

• lang::message::lookup
• lang::message::format

Partial Call Graph (max 5 caller/called nodes):

Testcases:

group_localization, acs_subsite_group_type

Source code:

    return [lang::message::lookup "" $key "TRANSLATION MISSING" $substitution_list 2]

Generic XQL file:

packages/acs-lang/tcl/lang-message-procs.xql

PostgreSQL XQL file:

packages/acs-lang/tcl/lang-message-procs-postgresql.xql

Oracle XQL file:

packages/acs-lang/tcl/lang-message-procs-oracle.xql