Language Definition"
From Documentation
| (15 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{ZKClient-sideReferencePageHeader}} |
| − | + | __TOC__ | |
| − | + | This section describes what a language definition and addon are. It is required for component development. However, you could skip it if you won't develop components. For more information about component development, please refer to [[ZK Component Development Essentials]]. | |
| − | + | If you would like to change the default configuration of a ZK application, please refer to [[ZK Developer's Reference/Customization/Packing Code|ZK Developer's Reference: Packing Code]]. | |
| − | |||
| − | |||
| − | + | = Language Definition= | |
| − | + | A language definition defines a component set (aka., a language). For example, [[ZUML Reference/ZUML/Languages/ZUL|ZUL]] and [[ZUML Reference/ZUML/Languages/XHTML|XHTML]] are two component sets. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | To define a language definition, you have to prepare a file called <code>/metainfo/zk/lang.xml</code> and makes it available to the classpath (such as in a JAR file, or in WEB-INF/classes of a Web application). In addition, you could specify them in [[ZK Configuration Reference/JAR File's config.xml/The language-config Element|/metainfo/zk/config.xml]] in the classpath. | |
| − | |||
| − | |||
| − | |||
| − | + | = Language Addon = | |
| − | + | A language addon is used to extend a language definition. You need to include it in one of the following ways: | |
| − | |||
| − | + | * create the file under the path: <code>/WEB-INF/classes/metainfo/zk/lang-addon.xml</code> available to the classpath. The filename must be the same as specified. | |
| + | * specified the file path in [[ZK_Configuration_Reference/zk.xml/The_language-config_Element|WEB-INF/zk.xml]] (in a Web application) | ||
| + | * specified the file path in [[ZK Configuration Reference/JAR File's config.xml/The language-config Element|/metainfo/zk/config.xml]] (in a JAR file; classpath). | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | When ZK starts, it will parse all language definitions and then all language addons based on their [[ZK Client-side Reference/Language Definition/depends|dependency]]. A language addon is a variant of a language definition. They are almost the same, except the naming and it must specify the [[ZK Client-side Reference/Language Definition/addon-name|addon name]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{ | + | {{ZKClient-sideReferenceHeadingToc}} |
| + | {{ZKClient-sideReferencePageFooter}} | ||
Revision as of 03:19, 27 April 2022
This section describes what a language definition and addon are. It is required for component development. However, you could skip it if you won't develop components. For more information about component development, please refer to ZK Component Development Essentials.
If you would like to change the default configuration of a ZK application, please refer to ZK Developer's Reference: Packing Code.
Language Definition
A language definition defines a component set (aka., a language). For example, ZUL and XHTML are two component sets.
To define a language definition, you have to prepare a file called /metainfo/zk/lang.xml and makes it available to the classpath (such as in a JAR file, or in WEB-INF/classes of a Web application). In addition, you could specify them in /metainfo/zk/config.xml in the classpath.
Language Addon
A language addon is used to extend a language definition. You need to include it in one of the following ways:
- create the file under the path:
/WEB-INF/classes/metainfo/zk/lang-addon.xmlavailable to the classpath. The filename must be the same as specified. - specified the file path in WEB-INF/zk.xml (in a Web application)
- specified the file path in /metainfo/zk/config.xml (in a JAR file; classpath).
When ZK starts, it will parse all language definitions and then all language addons based on their dependency. A language addon is a variant of a language definition. They are almost the same, except the naming and it must specify the addon name.