User Guide > Objects > Alphabetical Listing > Documentation Tabs

Documentation Tabs

The Documentation tabs are user-defined, client-specific tabs, which can be assigned to all objects in the Automation Engine.

All Documentation tabs that the administrator entered in the UC_OBJECT_DOCU variable are displayed. Regardless of this fact, imported objects have their own Documentation tabs.

Structured Documentation

Every tab can be displayed in a structured form. Using structured documentation, you can divide comprehensive information on an object into clear parts. Every node of the documentation offers the normal function to add text as well as the additional option to define attributes.

It is also possible to define links in structured documentation. These can be links to files or folders or links to documents on the intranet and Internet. In this way, files are displayed with the associated application, folders are opened, URLs call up the standard browser, etc. Here, the actions depend on the installed applications and the configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. of the user's PCs.

At first, a new Documentation tab only contains the 'Content' folder. This is the starting point from which you can establish the further structure. The following commands are available via the context menu for creating and editing it.

Command	Description
New attribute	Creates a new attribute in the highlighted node.
Add node after	Adds a new node after the highlighted node.
Add node before	Adds a new node before the highlighted node.
New sub-node	Adds a new node one level under the highlighted node.
Duplicate node	Duplicates the highlighted node with its attributes and content.
Delete node	Permanently deletes the highlighted node.

It is possible to create one or several attributes for each individual node. In principle, a distinction is made between two types: text and enumeration. You can add one or several of these attributes to a node. Specify the name of the attribute and then select whether it is a text or enumeration. In the second case, you can specify the items these should contain.

The XML naming convention must be taken into account when naming nodes and attributes. Letters, numbers, and the "-", ".", "_" symbols may be used. Note the following rules:

The first letter of the name may not be a number, ".", or "-".
The name may not contain any spaces.
Colons are reserved characters and may not be used.
The name may not begin with "XML", regardless of whether it is written in upper or lower case letters.

You can read structured documentation with special script elements (XML_*).