The Include element

Available since version: 0.8.0 (2012)
Author: Christian Mayer

Description

Includes other configuration snippets. Note that this is no widget shown in your visualization it just gives you the opportunity to split you configuration into multiple files. If you have a large configuration file splitting it up might help to keep track of your configuration. The path to the included files must be relative to the resource folder.

Example

<page>
 <include src="config/part1.xml"/>
 <include src="config/part2.xml"/>
</page>

Settings

For a general understanding of how the configuration files are structured and what elements and attributes are it is recommended to read this section first: Pages and structure of CometVisu.

The behaviour and appearance of the Include widget can be influenced by using certain attributes and elements. The following tables show the allowed attributes and elements and their possible values. The screenshots show, how both can be edited in the editor.

Attributes underlined by ….. are mandatory, all the others are optional and can be omitted.

Allowed attributes in the Include-element

Element

Attribute

Name

Content

Description

include

src

URI

../../../_images/en_config_widgets_include_index_editor_attributes.png

Attributes in the editor (simple view) [1]

Allowed child-elements and their attributes

None.

Examples

It is possible to manually edit the visu_config.xml and add an entry for the Include widget.

Caution

Make sure that you only use UTF-8 encoded characters by settings the encoding in your XML-editor to UTF-8 mode!

Footnotes