User Guide > Objects > Alphabetical Listing > Documentation Tabs

Documentation Tabs

Documentation tabs are user-defined and client-specific tabs that can be assigned to all object types in AE.

All Documentation tabs that the administrator has defined in the variable UC_OBJECT_DOCU are shown. Note that imported objects have their own Documentation tabs.

The Version Management tab displays the stored object versions, if this function is active.

Structured Documentation

Each of these tabs can also be displayed in structured form. Structured documentation can be used to split complex object information into clear parts. Each documentation element can be used to store texts, but also to define attributes.

You can also define links (for example, to files, folders or to documents in the intranet and Internet) in structured documentation. Files are then displayed with the associated program, folders are opened, URLs call the standard browser etc. The particular actions depend on the installed programs and the user's PC configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied..

New Documentation tabs initially only include the "Content" folder. This is your starting point for creating a further structure. To create and edit this structure, you can use the following context menu commands:

Command	Description
Add attribute	Creates a new attribute in the highlighted element.
Add node after	Inserts a new element after the highlighted element.
Add node before	Inserts a new element before the highlighted element.
Add node child	Creates a new element one level below the highlighted element.
Duplicate node	Duplicates the highlighted element including its attributes and contents.
Delete node	Deletes the highlighted element irrevocably.

You can create one or more attributes for each individual element. Basically, there are two different types: text and enumeration. You can add one or more of these attributes to an element. Determine the attribute's name and then select whether it is a text or an enumeration. In enumerations, you can specify the entries that should be included.

Names of elements and attributes should comply with the XML naming convention. Letters, numbers and the characters "-", ".", "_" can be used. Keep the following rules in mind:

The first letter of a name must neither be a number nor "." nor "-".
The name must not include blanks.
Do not use colons as they are reserved characters.
Names must not begin with "XML", regardless if uppercase or lowercase letters are used.

Structured documentation can be read with specific script elements (XML_*).