Warning and Error Messages"
(→Change particular message: make it more clear) |
|||
| Line 15: | Line 15: | ||
[since 6.0.0] | [since 6.0.0] | ||
| − | If you want to change a particular message, you | + | If you want to change a particular message, you need to create <tt>WEB-INF/zk-label.properties</tt> (or <tt>WEB-INF/zk-label_[LOCALE].properties</tt>) and add key-value pairs in it. For example, assuming you want to customize <code>MZk.NOT_FOUND</code> in German translation (<tt>msgzk_de.properties</tt>), then you can add the following to <code>WEB-INF/zk-label_de.properties</code>: |
<source lang="xml"> | <source lang="xml"> | ||
| Line 21: | Line 21: | ||
</source> | </source> | ||
| − | + | Notice the prefix <tt>MZk</tt>, and <tt>3000</tt> is the error code and you can find it at [[ZK_Messages/German/msgzk_de.properties]] | |
| − | For messages defined in msgzk.js/msgzul.js you can | + | For messages defined in <tt> msgzk.js / msgzul.js</tt> you can create a js file and include it via <tt>lang-addon.xml</tt>. For example for overriding <tt>msgzk.LOADING</tt> for CEZH language create a file <tt>test_cs.js</tt> and override particular message <code>msgzk.LOADING=CS langauge specific message"</code> and include this js file via <tt>lang-addon.xml</tt> as below |
<source lang="xml"> | <source lang="xml"> | ||
<language-addon> | <language-addon> | ||
| Line 33: | Line 33: | ||
</source> | </source> | ||
| − | Note: You can use any prefix other than "test" and add language specific suffix to your js files and include all of them by using * wild card as shown above | + | Note: You can use any prefix other than "test" and add language specific suffix to your js files and include all of them by using <tt>*</tt> wild card as shown above |
Finally include your lang-addon.xml in zk.xml using language-config element as shown below | Finally include your lang-addon.xml in zk.xml using language-config element as shown below | ||
Revision as of 02:43, 17 May 2016
Overview
ZK's messages (such as warnings and errors) are packed in property files (*.properties) under the /metainfo/mesg directory of the classpath. These mesages are grouped into modules, such as zcommon, zweb, zk and zul. These files are Locale depedent. For example, the message file of zk.jar for Germany messages is msgzk_de_DN.properties or msgzk_de.properties.
Translate messages to another language
If you want to translate messages to another language, you can add your own property files named with the correct Locale, and put it to the /metainfo/mesg directory of the classpath. Of course, it is always better to contribute it back. Please take a look at ZK Messages for all available translations. If you'd like to contribute, just add the language to it and notice us at info at zkoss dot org.
Change particular message
[since 6.0.0]
If you want to change a particular message, you need to create WEB-INF/zk-label.properties (or WEB-INF/zk-label_[LOCALE].properties) and add key-value pairs in it. For example, assuming you want to customize MZk.NOT_FOUND in German translation (msgzk_de.properties), then you can add the following to WEB-INF/zk-label_de.properties:
MZk.3000=my customized message here
Notice the prefix MZk, and 3000 is the error code and you can find it at ZK_Messages/German/msgzk_de.properties
For messages defined in msgzk.js / msgzul.js you can create a js file and include it via lang-addon.xml. For example for overriding msgzk.LOADING for CEZH language create a file test_cs.js and override particular message msgzk.LOADING=CS langauge specific message" and include this js file via lang-addon.xml as below
<language-addon>
<addon-name>test</addon-name>
<language-name>xul/html</language-name>
<javascript src="/js/test*.js" />
</language-addon>
Note: You can use any prefix other than "test" and add language specific suffix to your js files and include all of them by using * wild card as shown above
Finally include your lang-addon.xml in zk.xml using language-config element as shown below
<language-config>
<addon-uri>/WEB-INF/lang-addon.xml</addon-uri>
</language-config>
Version History
| Version | Date | Content |
|---|---|---|
| 6.0.0 | n/a | Allows applications to override a particular message with zk-label.
|