ZK Configuration Reference/zk.xml/The language-config Element

Syntax:

<language-config>
    <addon-uri>a_uri</addon-uri>
    <language-uri>a_uri</language-uri>
</language-config>

The allowed child elements include addon-uri. You might have multiple language-config elements in one zk.xml.

 <language-config>
     <addon-uri>/WEB-INF/lang-addon.xml</addon-uri>
     <addon-uri>/WEB-INF/lang-addon2.xml</addon-uri>
 </language-config>

Note: Unlike most other configurations defined in WEB-INF/zk.xml, the definitions defined in the language addons are applied to all Web applications sharing the same zk.jar.

In other words, the definitions in the language addons are visible to all Web applications sharing the same zk.jar. Furthermore, it may cause errors in another Web application, if the classes or resources are available only in the Web application defining this.

Thus, if this has become an issue, you can just put zk.jar and relevant ZK libraries under the WEB-INF/lib directory.

The addon-uri Element

[Default: none]

It specifies the URI of language add-on definitions. To specify more than one URIs, you have to define them with multiple addon-uri.

A language addon is used to add new components and override the definitions of existent components. For more information, please refer to ZK Client-side Reference: Language Definition.

For example,

<language-config>
	<addon-uri>/WEB-INF/lang-addon.xml</addon-uri>
</language-config>

The language-uri Element

[Default: none]

Since 5.0.7

It specifies the URI of the language definition. To specify more than one URIs, you have to define them with multiple language-uri.

A language definition is used to define a new set of components. For more information, please refer to ZK Client-side Reference: Language Definition.

Acceptable Path

Depending on the location of a zk.xml, the paths it can accept are different:

WEB-INF/zk.xml

It can accept a path that a javax.servlet.ServletContext can access like:

<language-config>
	<addon-uri>/WEB-INF/my-addon.xml</addon-uri>
</language-config>

metainfo/zk/zk.xml

It can accept a path that a class loader can access like:

<language-config>
	<addon-uri>/metainfo/zk/my-addon.xml</addon-uri>
</language-config>

Version History

Version	Date	Content
5.0.7	May 2011	The language-uri element was introduced.