Eine der häufigsten Operationen, die ich in GIMP durchführe, ist das Erstellen einer Box mit Text für eine Webseite, ein Logo oder was auch immer. Allerdings weiß man nie genau, wie groß das anfängliche Bild sein muss, denn man weiß nicht, wieviel Platz der Text bei der gewünschten Schriftart und -größe benötigen wird.

Der Skript-Fu-Meister (und auch der Schüler) wird schnell bemerken, dass dieses Problem mit Skript-Fu leicht gelöst und automatisiert werden kann.

Wir werden daher ein Skript namens „Text Box“ erstellen, welches ein Bild in genau der Größe erstellt, so dass eine Textzeile, die der Benutzer eingibt, bequem hineinpasst. Wir werden außerdem den Benutzer die Schrift, die Schriftgröße und die Textfarbe auswählen lassen.

Bis jetzt haben wir in der Skript-Fu-Konsole gearbeitet, aber jetzt gehen wir dazu über, Skripte in Form von Textdateien zu bearbeiten.

Wo Sie Ihre Skripte speichern bleibt Ihnen überlassen – wenn Sie Zugriff auf GIMPs systemweites Skriptverzeichnis haben, können Sie Ihre Skripte dort platzieren. Ich bevorzuge es allerdings, meine persönlichen Skripte in meinem eigenen Skriptverzeichnis zu haben, getrennt von den vorinstallierten Skripten.

In the .gimp-2.8 directory that GIMP made off of your home directory, you should find a directory called scripts. GIMP will automatically look in your .gimp-2.8 directory for a scripts directory, and add the scripts in this directory to the Script-Fu database. You should place your personal scripts here.

Jedes Skript-Fu-Skript definiert mindestens eine Funktion, die Hauptfunktion des Skripts. Das ist der Ort, wo Sie arbeiten müssen.

Jedes Skript muss sich auch bei der Prozedurendatenbank registrieren, so dass Sie von GIMP aus darauf zugreifen können.

Wir definieren zuerst die Hauptfunktion:

        (define (script-fu-text-box inText inFont inFontSize inTextColor))
      

Hier haben wir eine neue Funktion namens script-fu-text-box mit vier Parametern definiert, die später einem Text, einer Schriftart, der Schriftgröße und der Textfarbe entsprechen. Die Funktion ist jetzt noch leer und macht daher überhaupt nichts. So weit, so gut – nichts Neues, nichts Außergewöhnliches.

Schemes Namenskonventionen scheinen kleingeschriebene Namen mit Bindestrichen zu bevorzugen, dem bin ich beim Funktionsnamen gefolgt. Allerdings bin ich bei den Parametern von dieser Konvention abgewichen. Ich bevorzuge für meine Parameter und Variablen beschreibende (sprechende) Namen und habe daher den Parametern die Vorsilbe „in“ vorangestellt, so dass ich sofort erkennen kann, dass sie Eingabewerte fürs Skript enthalten und nicht innerhalb des Skriptes erzeugt wurden. Für letztere verwende ich die Vorsilbe „the“.

It's GIMP convention to name your script functions script-fu-abc, because then when they're listed in the procedural database, they'll all show up under Script-Fu when you're listing the functions. This also helps distinguish them from plug-ins.

Nun wollen wir die Funktion bei GIMP registrieren. Das wird durch Aufrufen der Funktion script-fu-register getan. Wenn GIMP ein Skript einliest, führt es diese Funktion aus, die das Skript bei der der Prozedurendatenbank registriert. Sie können diese Funktion irgendwo innerhalb des Skripts platzieren, ich stelle sie ganz ans Ende, hinter meinen übrigen Code.

Hier ist das Programmlisting, um die Funktion zu registrieren (ich erkläre alle Parameter in einer Minute):

  (script-fu-register
    "script-fu-text-box"                        ;func name
    "Text Box"                                  ;menu label
    "Creates a simple text box, sized to fit\
      around the user's choice of text,\
      font, font size, and color."              ;description
    "Michael Terry"                             ;author
    "copyright 1997, Michael Terry;\
      2009, the GIMP Documentation Team"        ;copyright notice
    "October 27, 1997"                          ;date created
    ""                     ;image type that the script works on
    SF-STRING      "Text"          "Text Box"   ;a string variable
    SF-FONT        "Font"          "Charter"    ;a font variable
    SF-ADJUSTMENT  "Font size"     '(50 1 1000 1 10 0 1)
                                                ;a spin-button
    SF-COLOR       "Color"         '(0 0 0)     ;color variable
  )
  (script-fu-menu-register "script-fu-text-box" "<Image>/File/Create/Text")
      

Wenn Sie diese Funktionen in einer Textdatei mit Dateiendung .scm in Ihrem Skriptordner speichern und dann Filter → Skript-Fu → Skripte auffrischen wählen, wird dieses neue Skript als Datei → Erstellen → Text → Text Box erscheinen.

Rufen Sie dieses neue Skript auf, macht es natürlich gar nichts, aber Sie können die Eingabeaufforderungen sehen, die Sie mit dem Registrieren erstellt haben (mehr darüber, was wir eigentlich gemacht haben, folgt gleich).

Zum guter Letzt: wenn Sie den Prozeduren-Browser aufrufen (Hilfe → Prozeduren-Browser), werden Sie feststellen, dass unser Skript jetzt in der Datenbank auftaucht.

Um das Skript bei GIMP zu registrieren, rufen wir die Funktion script-fu-register auf, geben die sieben erforderlichen Parameter an und fügen unsere eigenen Parameter noch hinzu, jeweils mit Beschreibung und Standardwert.

Abbildung 13.4. Das Menü Ihres Skripts

Nachdem wir die erforderlichen Parameter aufgelistet haben, müssen wir die Parameter aufführen, die den von unserem Skript benötigten Parametern entsprechen. Wir werden dabei auch Hinweise zu ihrem jeweiligen Typ für den Dialog, der sich beim Aufruf unseres Skripts öffnet, geben. Außerdem geben wir einen Standardwert vor.

Dieser Abschnitt des Registrierungsprozesses hat das folgende Format: