Skripteditor

  • Der Skripteditor hält das Batchpad Skript und bietet eine umfangreiche Autovervollständigung.

    Abbildung 1: Der Skripteditor des Batchpad


    1 Aufbau des Skripts


    Das Skript muss ein Stammelement enthalten, das allen anderen Elemente über übergeordnet ist. Für die Syntax des Batchpad ist dies der Batch-Tag:


    <Batch>...</Batch>


    Alle weiteren verfügbaren Tags müssen in diesem Stammelement verschachtelt werden.

    Hinweis: Über die Attribute ActionLog und ConditionLog (siehe Abbildung 1) kann die Ausgabe in das Protokoll im Ausgabefenster gesteuert werden.


    1.1 Tags

    Analog zu der XML-Syntax werden diese Elemente, wie z.B. das Stammelement "<Batch>" auch Tags genannt.

    Dabei ist "<Batch>" der öffnende Tag und "</Batch>" der schließende Tag.


    Ein Tag muss immer geschlossen werden. Wenn kein weiteres Tag in einem Tag verschachtelt werden soll kann auch das öffnende Tag durch ein Slash (/) am Ende des öffnenden Tags geschlossen werden:


    <Print Text="Hello World!" Variable="{@Result}" />


    Innerhalb von dem Batch-Tag können weitere Tags, wie z.B. der Print-Tag verschachtelt werden:


    Code
    <Batch ActionLog="true" ConditionLog="false"> 
    <Print Text="Hello World!" Variable="{@Result}" /> 
</Batch>

    Es werden nur die Tags die das Batchpad zur Verfügung stellt verarbeitet. Text in Tag-Elemente zu verschachteln wird nicht unterstützt und kann zu Fehlern führen. Für Anmerkungen innerhalb des Batchpads siehe Abschnitt 1.4 Kommentare.


    Hinweis: Im Normalfall werden die Aktionen über den Bereich "Aktionen & Parameter" oder über die Autovervollständigung hinzugefügt. Das Hinzufügen von vorgefertigten Tags erleichtert die Einhaltung der Syntax-Regeln.



    1.2 Attribute

    Innerhalb eines öffnenden Tags können Attribute verwendet werden:


    <Print Text="Hello World!" Variable="{@Result}" />


    In dem Beispiel sind die Attribute Text und Variable angegeben. Die Werte des Attributs müssen innerhalb von zwei Anführungszeichen ("...") stehen.



    1.3 Variablen und Parameter

    Innerhalb von Attributen können Variablen und Parameter verwendet werden. Wie Beispielsweise die Variable {@Result} in folgendem Beispiel:


    <Print Text="Hello World!" Variable="{@Result}" />


    Variablen und Parameter werden über die gleiche Syntax eingebunden. Parameter werden von dem Batchpad verwaltet (siehe Lexikon-Eintrag Hauptmenü), Variablen werden innerhalb des Skripts über die Aktion <Set Variable="" Value="" /> gesetzt:


    Code
    <Batch>
    <Set Variable="{@TestVariable}" Value="Test Wert" />
    <Print Text="{@TestVariable}" />
</Batch>
<!-- Ausgabe: "Test Wert" -->


    Darüber hinaus gibt es Variablen die von den jeweiligen Aktionen bereitgestellt werden sowie Zugriffsmöglichkeiten auf die Werte von Objekten.

    Wie diese Variablen eingesetzt werden ist im Bereich "Aktionen & Parameter" zu der jeweiligen Aktion dokumentiert. Beispielsweise stellt die ForEach Schleife eine Variable {@Data} als Objekt Verfügung:


    Code
            <ForEach Data="{@myData}">
            <ConditionTrue Condition="{@Data:IsDirectory}">
...



    1.4 Kommentare

    Kommentare werden XML-typisch wie folgt geschrieben: <!-- Das ist ein Kommentar --> und können in Tags verschachtelt werden oder auch außerhalb von dem Stammelement "<Batch>" platziert werden.


    Nicht erlaubt sind zwei Striche innerhalb von einem Kommentar wie z.B. <!-- Das ist ein nicht erlaubter -- Kommentar-->



    1.5 Sonderzeichen

    Die Sonderzeichen < und & können nicht verwendet werden. Es gibt folgende vordefinierte Ersetzungszeichen


    Bedeutung Zeichen Ersetzungszeichen Batchpad Ersetzungszeichen
    Kleiner als < &lt; [*l]
    Größer als > &gt; [*g]
    Ampersand & &amp; [*a]
    Anführungszeichen "
    		[*q]
    Apostroph '
    Tabulator  
    		 [*t]
    Zeilenumbruch [*n]


    Zum Beispiel erzeugt die Aktion Print:

    Code
    <Print Text="[*l]Hello[*g] [*t]World![*n][*a]Neue Zeile" Variable="{@Result}" />

    folgende Ausgabe im Ausgabefenster:

    Code
    <Hello>     World! 
&Neue Zeile


    2 Autovervollständigung


    Innerhalb des Skripts können Tags mit Hilfe der Autovervollständigung hinzugefügt werden.

    Dabei wird der Cursor im Bereich des Skripteditors platziert und durch die Eingabe von < wird ein Kontextmenü aufgerufen, welches die verfügbaren Aktionen auflistet (siehe Abbildung 2).

    Wenn noch kein <Batch> Tag vorhanden ist, wird nur das <Batch> Tag vorgeschlagen.


    Abbildung 2: Autovervollständigung Batchpad Tags



    Innerhalb eines öffnenden Tags wird durch die Tatenkombination Strg +Leerzeichen ein Kontextmenü mit den möglichen Attributen für dieses Tag aufgerufen (Siehe Abbildung 3).


    Abbildung 3: Autovervollständigung Batchpad Attribute



    3 Autoformatierung und Attribute aufräumen


    Das Skript ist XML-typisch über Tags verschachtelt. Jede Verschachtelung wird dabei mit einem Tab Unterschied zum Eltern-Tab eingerückt.

    Das Batchpad unterstützt die Einhaltung dieser Formatierung durch die Funktionalität "Dokument formatieren" im Hauptmenü.


    Zudem kann über das Hauptmenü die Funktionalität "Dokument aufräumen" verwendet werden, um die Anzahl an verwendeten Attributen zu verringern.

    Dabei werden nicht verwendete Attribute aus dem Skript entfernt.


    Weitere Informationen zu dieser Funktionalität sind im Lexikon-Eintrag Hauptmenü verfügbar.

Teilen