Der Befehl script-fu-register trägt Ihr Skript in den Prozedurenbrowser des GIMP ein - registriert es dort.
Der Befehl fügt Ihr Skript also zur bestehenden Bibliothek der GIMP-Skripte hinzu. Erst dadurch können Sie es in GIMP zum Beispiel über einen neuen Menüpunkt aufrufen und anklicken.
script-fu-register - Beispiel
Unten habe ich Ihnen einen Auszug als Beispiel für die Syntax des Befehls notiert. Achtung, dieser Codeschnipsel ist alleine nicht funktionsfähig und dient nur der Anschauung!
...
073 (script-fu-register "gimp-handbuch-icon-im-glaslook"
074 "<Toolbox>/Xtns/Script-Fu/GIMP-Handbuch.de/Neu/Icon im Glaslook..."
075 "Erzeugt ein Icon mit Relfexion"
076 "Oliver Lohse Info(at)GIMP-Handbuch.de"
077 "Oliver Lohse"
078 "(c) 07.06.2008"
079 ""
080 SF-COLOR "Hintergrund" '(255 255 255)
081 SF-COLOR "Ring" '(0 0 255)
082 SF-COLOR "oben" '(0 0 255)
083 SF-COLOR "unten" '(200 200 255)
084 )
...Beispielcode für script-fu-register
Dieses kurze Skript meldet ein neues Skript mit dem Namen gimp-handbuch-icon-im-glaslook an.
Toolbox - Menüeintrag vornehmen
Sie müssen das Skript in GIMP sichtbar machen, damit Sie es später anklicken und auch verwenden können.
...
074 "<Toolbox>/Xtns/Script-Fu/GIMP-Handbuch.de/Neu/Icon im Glaslook..."
...Diese Zeile oben legt fest, wo dieses Script später in GIMP sichtbar werden soll. In diesem Beispiel also das Hauptfenster mit allen Werkzeugen der Anwendung.
Hinter Toolbox folgt der Menüpfad. Dies heißt, dass unter Xtns/Script-Fu nun ein neuer Menüpunkt mit dem Namen GIMP-Handbuch.de erscheint (siehe Bild oben). Dieser enthält dann ein Untermenü mit dem Namen Neu - Icon im Glaslook.... Übrigens die drei Punkte deuten immer an, dass nach dem Klick ein Dialog folgt (dies ist zwar keine Vorschrift aber international üblich!).
Weitere Informationen - Programmdokumentation
Die Zeilen 75 bis 79 sind zur Dokumentation im Prozedurenbrowser gedacht. Tragen Sie dort wichtige Informationen zu diesem Skript ein.
...
075 "Erzeugt ein Icon mit Relfexion"
076 "Oliver Lohse Info(at)GIMP-Handbuch.de"
077 "Oliver Lohse"
078 "(c) 07.06.2008"
079 ""
...Ein kurzer Text was dieses Skript tut tragen Sie in Zeile 75 ein. In Zeile 76 stehen Kontaktinformationen, damit andere Entwickler ggf. Kontakt zu Ihnen herstellen können. In Zeile 77 den Namen des Autors (bitte den Realnamen). Zeile 78 noch das Datum. Zeile 79 können Sie noch einen weiteren Kommentar hinterlegen.
Diese Informationen können dann andere User lesen wenn Sie Ihr Script im Prozedurenbrowser des GIMP nachschlagen.
SF-COLOR - Parameter für das Skript
Diese Parameter werde ich nur der Vollständigkeit wegen kurz anschneiden, denn sie werden in einem weiteren Artikel genauer betrachtet.
...
080 SF-COLOR "Hintergrund" '(255 255 255)
081 SF-COLOR "Ring" '(0 0 255)
082 SF-COLOR "oben" '(0 0 255)
083 SF-COLOR "unten" '(200 200 255)
...Ihr Skript benötigt natürlich einige Werte, Parameter oder Farbangaben. Der Parameter SF-COLOR öffnet den Dialog Farben in dem Sie eine Farbe einstellen können. Im Beispielskript werden demnach vier Farbwerte vom Anwender abgefragt bevor das Skript seine eigentliche Tätigkeit beginnt.
Der Prozeduren-Browser des GIMP
GIMP legt Ihr Skript in einer eigenen Prozedurendatenbank ab bzw. meldet es dort für Sie an. Über das Eingabefeld Suche gelangen Sie schneller zu Ihrem Skript wenn Sie die Anfangsbuchstaben eingeben.
Im Bild sehen Sie den Prozeduren-Browser des GIMP der alle ihm bekannten Skripte verwaltet. Das Beispielskript gimp-handbuch-icon-im-glaslook ist links in der Liste verfügbarer Skripte eingetragen, rechts sehen Sie die Kommentare unter der Rubrik Weitere Information und die Parameter darüber die Sie für dieses Skript festgelegt haben.
Praxistipp | Wenn Sie eigene Skripte schreiben, denken Sie sich einen brauchbaren Namensraum aus (Präfix+Suffix). Ich habe versucht mich an den Standard aus der Programmiersprache Java zu halten und identifiziere die Skripte anhand des Domainnamens (gimp-handbuch) gefolgt vom eigentlichen Namen (icon-im-glaslook) des Skriptes.