Module Configuration

Synopsis

<jsonix:module
  name="ModuleName"
  schemaId="${module.name}.jsonschema#">
  ...
  <jsonix:mapping ... />
  ...
  <jsonix:output ... />
  ...
  <jsonix:jsonSchema ... />
  ...
</jsonix:module>

Configuration attributes and elements

• name, optional - name of the module. If omitted, the name of the module will be generated based on the names of the mappings included into this module. Mapping names will be concatenated with the underscore _ as separator. For instance if a module contains two mappings named Foo and Bar, the module will be named Foo_Bar by default.
• schemaId, optional - id of the JSON Schema for this module.
  Supports the ${module.name} expression.
  If omitted, defaults to ${module.name}.jsonschema#. See JSON Schema Generation.
• mapping, required one or more - specifies and configures mappings which will be included into this module. See Mapping Configuration.
• output, optional zero or more - specifies output configurations which will be applied when writing out this module. See Output Configuration.
• jsonSchema, optional zero or more - specifies JSON Schema configurations which will be applied when writing out this module. See JSON Schema Configuration.

Examples

<jsonix:module>
	<jsonix:output naming="compact"/>
	<jsonix:jsonSchema fileName="${module.name}.json"/>
	<jsonix:mapping package="org.w3.smil.v_2_0" name="SMIL_2_0"/>
	<jsonix:mapping package="org.w3.smil.v_2_0.language" name="SMIL_2_0_Language"/>
</jsonix:module>

Generates the module named SMIL_2_0_SMIL_2_0_Language which contains mappings SMIL_2_0 and SMIL_2_0_Language.
This module will be written out using the compact naming. The file name pattern defaults to ${module.name}.compact.js so this module will be written out into the file SMIL_2_0_SMIL_2_0_Language.compact.js.
JSON Schema will be generated in the SMIL_2_0_SMIL_2_0_Language.jsonschema file.