Caution

This is the documentation for the current development branch of the CometVisu. It is possible that some of the described features are not yet available in the current release.

Also there might be lots of errors in this documentation as some parts of the content have been translated by an online translation service.

The timeout plugin

Available since version: 2012
Author: Carsten Tschach (Carsten@Tschach.com)

Description

This plugins jumps back to a defined page after a given timeout period

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: visu-config-details.

The behaviour and appearance of the timeout plugins 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 be omitted.

Allowed attributes in the timeout-element

Element Attribute
  Name Content Description
timeout time string  
target string The name of the page, that should be shown.
debug true or false  

Allowed child-elements und their attributes

Examples

It is possible to manually edit the visu_config.xml and add an entry for the timeout plugin.

Caution

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

Footnotes

[1]The simple view might not show everything. To see all elements/attributes use the expert view.