Benutzerhandbuch > Objekte > Alphabetische Auflistung > Registerkarten zur Dokumentation

Registerkarten zur Dokumentation

Die Registerkarten zur Dokumentation sind benutzerdefinierte und mandantenspezifische Registerkarten, die allen Objekten in der AE zugeordnet werden können.

Es werden alle Dokumentations-Registerkarten angezeigt, die der Administrator in der Variable UC_OBJECT_DOCU eingetragen hat. Davon unabhängig weisen importierte Objekte zusätzlich ihre eigenen Dokumentations-Registerkarten auf.

Die Registerkarte Versionsmanagementzeigt, wenn sie aktiviert wurde, die gesicherten Versionen des Objektes an.

Strukturierte Dokumentation

Zusätzlich kann jede dieser Registerkarten in strukturierter Form dargestellt werden. Mittels der sogenannten strukturierten Dokumentation können Sie umfangreiche Informationen zu einem Objekt in übersichtliche Teile aufsplitten. Jedes Element der Dokumentation bietet neben der normalen Funktionalität Text zu hinterlegen, auch noch zusätzlich die Möglichkeit Attribute zu definieren.

In strukturierten Dokumentationen sind auch Links definierbar. Das können beispielsweise Verknüpfungen mit Dateien oder Ordnern sein, aber auch Links zu Dokumenten im Intranet und Internet. Dateien werden so mit dem assozierten Programm angezeigt, Ordner werden geöffnet, URL's rufen den Standard-Browser auf usw. Hier gilt, dass die Aktionen von den installierten Programmen und der Konfiguration des Benutzer-PC's abhängen.

Bei einer neuen Registerkarte zur Dokumentation sehen Sie zu Beginn lediglich den Ordner "Content". Dies ist der Ausgangspunkt, von dem Sie die weitere Struktur aufbauen können. Für das Anlegen und die Bearbeitung derselben stehen Ihnen über das Kontextmenü folgende Befehle zur Verfügung:

Befehl	Beschreibung
Neues Attribut	Legt ein neues Attribut in dem markierten Element an.
Neues Element danach	Ein neues Element wird nach dem markierten Element eingefügt.
Neues Element davor	Ein neues Element wird vor dem markierten Element eingefügt.
Neues Subelement	Ein neues Element wird eine Ebene unter dem markierten Element angelegt.
Element duplizieren	Das markierte Element wird mit seinen Attributen und Inhalten dupliziert.
Element löschen	Das markierte Element wird unwiderruflich gelöscht.

Bei jedem einzelnen Element lassen sich ein oder mehrere Attribute anlegen. Grundsätzlich werden zwei Arten unterschieden: Text und Aufzählung. Sie können einem Element ein oder mehrere dieser Attribute hinzufügen. Legen Sie hierfür den Namen des Attributes fest und wählen danach aus, ob es sich um einen Text oder um eine Aufzählung handelt. Im zweiten Fall können Sie die Einträge, die diese enthalten sollen, festlegen.

Bei der Benennung von Elementen und Attributen ist die XML-Namenskonvention zu berücksichtigen. Es dürfen Buchstaben, Zahlen und die Zeichen "-", ".", "_" verwendet werden. Folgende Regeln sind zusätzlich zu beachten:

Der erste Buchstabe des Namens darf keine Zahl und nicht "." bzw. "-" sein.
Der Name darf keine Leerzeichen enthalten.
Der Doppelpunkt gehört zu den reservierten Zeichen und darf deshalb ebenfalls nicht verwendet werden.
Der Beginn eines Namens darf nicht "XML" sein, egal ob in Groß- oder Kleinbuchstaben geschrieben.

Sie können strukturierte Dokumentationen mit speziellen Script-Sprachmitteln (XML_*) auslesen.

Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support