Über die Befehlsbeschreibungen

Struktur der Befehlsbeschreibungen

Die Tcl-Befehlsbeschreibungen in diesem Handbuch sind nach Befehlsgruppen (beispielsweise obj oder attribute) geordnet. Die Beschreibungen der Befehle einer Gruppe werden durch eine tabellarische Aufstellung der Felder oder Parameter dieser Gruppe ergänzt. Zu jedem Feld oder Parameter ist der Name und der Typ seines Wertes angegeben. Ferner wird seine Bedeutung erläutert, und es ist angegeben, wie auf das Feld oder den Parameter zugegriffen werden kann (lesend, schreibend). Ferner ist angegeben, ob der Wert des Feldes oder Parameters gegebenenfalls bei der Erzeugung einer neuen Instanz (einer Datei, einer Vorlage usw.) gesetzt werden kann.

Die Befehlsbeschreibungen selbst enthalten die Funktionsdeklaration mit anschließender Erläuterung der Aufgabe, der Parameter und des Rückgabewertes. Ferner werden die Rechte genannt, die ein Benutzer haben muss, um den Befehl ausführen zu können.

Datentypen und Notation

Die Datentypen der Feldwerte und -parameter sowie der Rückgabewerte der Funktionsaufrufe können sein:

  • string: Zeichenkette
  • stringlist: Listen und Felder von strings
  • number: Ganzzahl
  • datetime: Datum und Uhrzeit
  • bool: Logische Werte (no | yes oder false | true oder 0 | 1)
  • void: nichts (kein Rückgabewert, kein Parameter)

In Tcl-Funktionsdeklarationen werden die folgenden Symbole verwendet:

Symbol Verwendung und Beispiel
( ) Fasst Elemente logisch zusammen:
obj (withId id) | (withPath path) get parameter
[ ] Das geklammerte Element ist optional:
logout [login]
{ } Das geklammerte Element muss wenigstens einmal vorkommen:
obj withId id mget {parameter}
| Der vertikale Strich bedeutet, dass entweder das links oder das rechts davon stehende Element angegeben werden muss:
obj (withId id) | (withPath path) get parameter

Datumsformat

Intern werden alle Datums- und Zeitstempelangaben in kanonischer Form als 14stelliger String (von links beginnend: Jahr vierstellig, Monat zweistellig, Tag zweistellig, Stunde zweistellig, Minute zweistellig, Sekunde zweistellig) in GMT gespeichert.

Zur Konvertierung von Datums- und Zeitstempelangaben von der kanonischen in eine konventionelle Form siehe Der SystemConfig-Befehl. Bei der Umwandlung eines Datums oder einer Zeitangabe werden immer die Benutzer-Voreinstellungen für die Zeitzone und das Ausgabeformat berücksichtigt, wenn Sie statt des SystemConfig-Befehls den UserConfig-Befehl verwenden (siehe Der UserConfig-Befehl).

Anforderungen an Bezeichner

Sämtliche Bezeichner, die im Content Manager (für Feldnamen, Logins, Gruppennamen, Dateinamen usw.) verwendet werden, dürfen weder Leerzeichen noch Sonderzeichen enthalten. Als Sonderzeichen gelten alle Zeichen außer a-z, A-Z, 0-9 und der Unterstrich. Die Namen von CMS-Dateien dürfen auch das Dollar-Zeichen und den Bindestrich enthalten. Beim Import werden nicht erlaubte Zeichen in CMS-Dateinamen in Unterstriche umgewandelt.