En av de vanligaste operationer jag utför i GIMP är att skapa en ruta med lite text i för en webbsida, en logotyp eller vad det nu kan vara. Du vet dock aldrig riktigt hur stor du vill göra den ursprungliga bilden då du startar. Du vet inte hur mycket utrymme texten kommer fylla med typsnittet och storleken som du vill ha.

Detta problem kan lösas och automatiseras med Script-Fu.

Vi kommer därför skapa ett skript som vi kallar Text Box, vilket skapar en bild som har rätt storlek för att passa precis runt en textrad som användaren matar in. Vi kommer också låta användaren välja typsnittet, typsnittsstorleken och textfärgen.

Så här långt har vi arbetat i Script-Fu-konsolen. Nu ska vi dock växla till att redigera skriptfiler. Skriptfiler bör vara klartextfiler som du kan redigera i en text- eller kodredigerare. Namnet du ger är inte så viktigt, förutom för att kunna känna igenom skriptet. Du bör ge din skriptfil filändelsen ”.scm”.

Var du placerar dina skript är en smaksak. I GIMPs mappinställningar kan du se i vilka mappar GIMP letar efter skript. Det är också möjligt att lägga till en ny mapp där. Mappen där GIMP lagrar sina egna skript är vanligen inte det bästa valet för dina skript, men i övrigt är du fri att välja vad som passar dig bäst.

Varje Script-Fu-skript definierar minst en funktion som är skriptets huvudfunktion. Det här är var du gör jobbet.

Varje skript måste också registrera sig mot procedurdatabasen så du kan komma åt det inuti GIMP.

Vi kommer definiera huvudfunktionen först:

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

Här har vi definierat en ny funktion som heter script-fu-text-box som tar fyra parametrar, vilka sedan kommer motsvara lite text, ett typsnitt, typsnittsstorleken och textens färg. Funktionen är för närvarande tom och gör därmed ingenting. Allt väl så långt — inga nyheter, inget speciellt.

Schemes namnkonventioner verkar föredra gemener med bindestreck, vilket jag följt i namngivandet av funktionen. Jag har dock avvikit från konventionen med parametrarna. Jag gillar mer beskrivande namn för mina parametrar och variabler, och lägger därför till prefixet ”in” till parametrarna så att jag snabbt kan se att de är värden som skickas till skriptet, snarare än skapade i det. Jag använder prefixet ”the” för variabler som definieras i skriptet.

GIMPs konvention är att namnge dina skriptfunktioner script-fu-abc, för då visas de alla under Script-Fu då du listar funktionerna i procedurdatabasen. Detta hjälper också till att skilja dem från insticksmoduler.

Låt oss nu registrera funktionen med GIMP. Detta görs genom att anropa funktionen script-fu-register. När GIMP läser in ett skript kommer det exekvera denna funktion, vilken registrerar skriptet i procedurdatabasen. Du kan placera detta funktionsanrop var du vill i ditt skript, men jag placerar det vanligen i slutet, efter all min andra kod.

Här är listan för att registrera denna funktion (jag kommer förklara alla dess parametrar om ett ögonblick):

  (script-fu-register
    "script-fu-text-box"                        ;function 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>/Filters/Tutorial")
      

Spara dessa funktioner i en textfil med filändelsen .scm i en underkatalog till din skriptkatalog, med samma namn som din skriptfil, och starta sedan om GIMP. Det nya skriptet kommer dyka upp som Filter → Tutorial → Text Box.

Om du anropar detta nya skript kommer det förstås inte göra något, men du kan se inmatningarna du skapade då du skriptet registrerades (mer information om vad vi gjorde kommer härnäst).

Om du slutligen anropar procedurbläddraren ( Hjälp → Procedurbläddrare) så kommer du se att vårt skript nu visas i databasen.

För att registrera vårt skript med GIMP anropar vi funktionen script-fu-register, fyller i de sju parametrarna som krävs och lägger till vårt skripts egna parametrar, tillsammans med en beskrivning och ett standardvärde för varje parameter.

När vi har listat parametrarna som krävs så behöver vi lista parametrarna som motsvarar parametrarna som vårt skript behöver. När vi listar dessa parametrar ger vi antydningar om vad deras typer är. Detta är för dialogrutan som poppar upp när användaren väljer vårt skript. Vi tillhandahåller också ett standardvärde.

Detta avsnitt av registreringsprocessen har följande format:

När vi har registrerat vårt skript behöver vi säga till GIMP var det ska hittas i menyn.

Den bästa menyplatsen för ditt skript beror på dess funktion. De flesta skript hittas i menyerna Filter och Färger.

För det aktuella skriptet, som skapar en ny bild, väljer vi en undermeny Filters → Tutorial. Detta är vad raden med funktionen script-fu-menu-register gör. Vi registrerade därmed vår Text Box här: Filter → Tutorial → Text Box (Menykatalogen Filters är översatt i GIMP-gränssnittet och visas på aktuellt språk).

Alla undermenyer som du anger i ditt skript som inte ännu finns kommer skapas automatiskt av GIMP.