Code-Vervollständigung für Regeln

Über die Code-Vervollständigung auf dem Register „Regeln“ können die für die Regeldefinition im aktuellen syntaktischen Kontext verfügbaren Tags sowie zugehörige Parameter mit den zur Verfügung stehenden Werten per Tastendruck angezeigt und an der Einfügemarke auf dem Regeln-Register eingefügt werden.

Sind die gewünschten Tags, Parameter oder Werte bereits bekannt, können auch der oder die ersten Buchstaben eingegeben werden. Mit Strg + Leertaste wird dann die Anzahl der auszuwählenden Einträge reduziert bzw. der Eintrag direkt eingefügt. Soweit möglich, werden auch Pflichtparameter direkt mit eingefügt.

Ab FirstSpirit-Version 5.2R2 kann die Vorschlagsliste auch durch Eingabe von Text gefiltert bzw. durchsucht werden. Siehe dazu Einleitungsseite.

Dazu muss die Einfügemarke nach einem öffnenden <RULES>-Tag positioniert sein.

Hinweise
Es werden immer nur die Tags, Parameter und Schlüsselbegriffe angezeigt, die für das gewählte Tag oder den gewählten Parameter gültig sind. Bereits für die aktuelle Regeldefinition verwendete Tags oder Parameter, die nur einmal verwendet werden können, werden nicht mehr in der Liste angezeigt.

Durchgestrichene Einträge in der Liste sind veraltet („deprecatet“) und sollten nicht verwendet werden.

Um die verfügbaren Tags, Parameter und Werte anzuzeigen und auswählen zu können, muss die Einfügemarke je nach Regel-Syntax folgendermaßen positioniert sein:

1) Tags

Um Tags zwischen öffnenden oder schließendem und öffnendem Tag anzeigen und ergänzen zu können, muss vor der Einfügemarke eine spitze Klammer geöffnet werden (<). Mit Strg + Leertaste öffnet sich eine Vorschlagsliste mit zur Verfügung stehenden Tags.

Beispiel:
Es besteht bereits folgende DO / VALIDATION-Definition:

<RULES>
    <RULE>
        <DO>
            <VALIDATION>
                <PROPERTY name="VALID" source="st_headline"/>
            </VALIDATION>
        </DO>
    </RULE>
</RULES>

Soll das Tag MESSAGE ergänzt werden, muss an der entsprechenden Stelle eine spitze Klammer geöffnet werden (<, im folgenden Beispiel nach PROPERTY, in der 5. Zeile):

<RULES>
    <RULE>
        <DO>
            <VALIDATION>
                <PROPERTY name="VALID" source="st_headline"/>  <
            </VALIDATION>
        </DO>
    </RULE>
</RULES>

Bei Auswahl des Tags MESSAGE aus der Vorschlagsliste, die sich mit Strg + Leertaste öffnet, wird das Tag inklusive der Pflichtparameter lang und text folgendermaßen ergänzt:

<RULES>
    <RULE>
        <DO>
            <VALIDATION>
                <PROPERTY name="VALID" source="st_headline"/>  <MESSAGE lang="" text="" />
            </VALIDATION>
        </DO>
    </RULE>
</RULES>

Zwischen die Anführungszeichen können nun die Werte für lang und text eingetragen werden. Die Einfügemarke steht bereits an der richtigen Position. Siehe dazu auch Abschnitt 3) Werte.

2) Parameter

Um Parameter innerhalb eines öffnenden Tags anzeigen und ergänzen zu können, muss vor und ggf. hinter der Einfügemarke ein Leerzeichen vorhanden sein.

Beispiel:
Für das oben angegebene Beispiel gilt die Restriktionsstufe INFO, da der Parameter scope nicht angegeben ist. Soll die Restriktionsstufe auf SAVE gestellt werden, muss der Parameter scope mit dem Wert SAVE im Tag VALIDATION ergänzt werden. Dazu muss im öffnenden VALIDATION-Tag vor der schließenden spitzen Klammer > ein Leerzeichen eingefügt und die Einfügemarke hinter das Leerzeichen gesetzt werden (im folgenden Beispiel in der 4. Zeile):

<RULES>
    <RULE>
        <DO>
            <VALIDATION >
                <PROPERTY name="VALID" source="st_headline"/>
                <MESSAGE lang="*" text="A Headline must be provided!"/>
            </VALIDATION>
        </DO>
    </RULE>
</RULES>

Da im Tag VALIDATION nur der Parameter scope zur Verfügung steht, wird dieser mit Strg + Leertaste direkt an der Einfügemarke ergänzt. Es werden direkt die drei zur Verfügung stehenden Werte INFO, RELEASE und SAVE in einer Vorschlagsliste angezeigt. Wird SAVE gewählt, wird der Code folgendermaßen ergänzt:

<RULES>
    <RULE>
        <DO>
            <VALIDATION scope="SAVE">
                <PROPERTY name="VALID" source="st_headline"/>
                <MESSAGE lang="*" text="A Headline must be provided!"/>
            </VALIDATION>
        </DO>
    </RULE>
</RULES>

3) Werte

Um von FirstSpirit vorgegebene Werte („Schlüsselbegriffe“) oder auch Bezeichner von Eingabekomponenten, die bereits auf dem Formular-Register definiert sind, zu einem Parameter anzeigen und ergänzen zu können, muss die Einfügemarke innerhalb der Anführungszeichen positioniert werden.

Beispiel:
Über das Pflicht-Attribut „source“ im Tag PROPERTY werden einzelne Komponenten oder das gesamte Formular referenziert. Um die auf dem Formular-Register definierten Eingabekomponenten per Code-Vervollständigung anzeigen zu können, muss die Einfügemarke innerhalb der Anführungszeichen positioniert sein.

Mit Strg + Leertaste öffnet sich eine Vorschlagsliste mit den zur Verfügung stehenden Eingabekomponenten-Bezeichnern. Sie werden in alphabetischer Reihenfolge angezeigt.