Code-Vervollständigung auf Ausgabe-Registern
Inhaltsverzeichnis |
Über die Code-Vervollständigung auf Ausgabe-Registern können Anweisungen (CMS-Tags) per Tastendruck angezeigt und an der Einfügemarke eingefügt werden. Dazu muss bis FirstSpirit-Version 5.2R1 einschließlich mindestens das Zeichen $ eingegeben werden.
Ab FirstSpirit-Version 5.2R2 kann darüber hinaus auch Folgendes eingeblendet und eingefügt werden:
- Bezeichner von Eingabekomponenten, die auf dem Formular-Register der Vorlage definiert sind,
- Methoden, die auf dem Rückgabewert / Datentyp der jeweiligen Eingabekomponente ausgeführt werden können,
- Funktionen, die in Anweisungen verwendet werden können
Einfügen von Anweisungen
Mithilfe der Tastenkombination Strg+Leertaste öffnet sich ein Fenster mit allen zur Verfügung stehenden CMS-Tags („Anweisungen“) sowie sinnvolle Kombinationen der CMS-Tags.
Das gewünschte Tag kann per Tastatur (Cursor-Taste nach oben ↑ bzw. nach unten ↓ und Enter) oder Maus (doppelter Mausklick oder Mausklick und Enter) auf das Ausgabe-Register übernommen werden. Kombinationen werden in mehrere Zeilen untereinander eingefügt.
Die Einfügemarke befindet sich dann hinter der öffnenden Klammer, in die dann direkt der gewünschte Ausdruck eingegeben werden kann.
Ab FirstSpirit-Version kann mit Strg+Leertaste eine weitere Vorschlagsliste geöffnet werden, die die Bezeichner der auf dem Formular-Register der Vorlage definierten Eingabekomponenten sowie die zur Verfügung stehenden Funktionen enthält. Siehe dazu unten.
Die Anzahl der eingeblendeten Tags kann durch die Eingabe des oder der ersten Buchstaben des gewünschten CMS-Tags eingeschränkt werden. Beispielsweise werden bei Eingabe von
$CMS_IF
mit Strg+Leertaste folgende Vorschläge angezeigt:
$CMS_IF()$ $CMS_ELSE$ $CMS_END_IF$
$CMS_IF()$ $CMS_ELSIF()$ $CMS_ELSE$$CMS_END_IF$
$CMS_IF()$ $CMS_END_IF$
Ab FirstSpirit-Version 5.2R2 kann die Vorschlagsliste auch durch Eingabe von Text gefiltert bzw. durchsucht werden. Siehe dazu Einleitungsseite.
Die Eingabe
$CMS_FOR
wird mit Strg und Leertaste direkt ergänzt zu
$CMS_FOR(,)$
$CMS_END_FOR$
Eingabekomponenten-Bezeichner und Funktionen
Per Strg+Leertaste können die Bezeichner der Eingabekomponenten, die auf dem Formular-Register der Vorlage definiert sind, eingeblendet und eingefügt werden.
Dazu muss die Einfügemarke innerhalb der runden Klammern einer Anweisung stehen.
In der Vorschlagsliste werden zu den Bezeichnern auch die Datentypen / Rückgabewerte zu den Eingabekomponenten-Typen angezeigt, z. B.
- Datentyp TargetReference für FS_REFERENCE,
- Datentyp DomElement für CMS_INPUT_DOM
- usw.
Diese Datentypen sind relevant für die Vorlagen-Entwicklung in den Vorlagensatz-Registern (HTML, PDF usw.). Die Dokumentation zu diesen Datentypen inklusive der Methoden, die auf dem von der Eingabekomponente zurückgelieferten Datentyp ausgeführt werden können, befindet sich im Kapitel Datentypen.
In derselben Liste werden auch die Funktionen, die in der Anweisung zur Verfügung stehen, sowie weitere Schlüsselbegriffe aufgelistet (z. B. #global).
Einfügen von Methoden
Zu den Bezeichnern von Eingabekomponenten, die auf dem Formular-Register der Vorlage definiert sind, sowie zu Methoden in Anweisungen können mit Strg+Leertaste zur Verfügung stehende Methoden angezeigt und an der Einfügemarke in den Code eingefügt werden.
Dazu muss vor der Einfügemarke ein Punkt (.) gesetzt werden.
Bei der Eingabe von
$CMS_VALUE(st_text.
werden beispielsweise mit Strg+Leertaste alle Methoden aufgelistet, die auf dem Rückgabewert von „st_text“ (kann z. B. eine Eingabekomponente vom Typ CMS_INPUT_TEXT sein) ausgeführt werden können (z. B. toLowerCase)
$CMS_VALUE(st_text.toLowerCase())$
Hinter jedem Punkt kann mit Strg+Leertaste eine weitere Vorschlagsliste mit den zu Verfügung stehenden Methoden angezeigt werden.
Einblenden von Informationen
Zu folgenden Elementen können weitere Informationen in einem Tooltip per Strg+Q auf dem Ausgabe-Register eingeblendet werden:
- Eingabekomponenten-Bezeichner
(Tooltip zeigt den Eingabekomponenten-Typ und den Rückgabewert/Datentyp an) - Methoden
(Tooltip zeigt den Rückgabewert/Datentyp an)
Ist der Rückgabewert bekannt, kann ermittelt werden, welche Methoden weiterhin verwendet werden können.
Zu folgenden Elementen können weitere Informationen in einem Tooltip per Strg+Q in der Vorschlagsliste eingeblendet werden:
- Eingabekomponenten-Bezeichner
Methoden, die denselben Namen haben, können mit Strg+P auf einer Methode ermittelt werden.
Zur Anzeige der Informationen muss sich die Vorlage im Bearbeitungs-Modus befinden.
Möglichkeiten zur Analyse von bestehendem Code auf Vorlagensatz-Registern bieten der FirstSpirit Template Inspector und der FirstSpirit Vorlagen-Debugger. |