Een van de meest voorkomende bewerkingen die ik uitvoer in GIMP is het maken van een vak met wat tekst erin voor een webpagina, een logo of wat dan ook. U weet echter meestal niet precies hoe groot de initiële afbeelding te maken als u begint. U weet niet hoeveel ruimte de tekst zal vullen met het lettertype en de grootte die u wilt.

Dat probleem kan worden opgelost met geautomatiseerd met Script-Fu.

We zullen daarom een script maken, genaamd Text Box, dat een op de juiste grootte gemaakt afbeelding maakt om soepel te passen rondom een regel tekst die de gebruiker invoert. We zullen ook de gebruiker het lettertype, de grootte van het lettertype en de tekstkleur laten kiezen.

Tot nu hebben we gewerkt in de Script-Fu Console. We gaan nu echter overschakelen naar het bewerken van bestanden met scripts. Bestanden met scripts zouden platte tekstbestanden moeten zijn die u kunt bewerken in een tekstbewerker. De naam die u geeft is niet zo belangrijk, behalve om het script te kunnen herkennen. U zou uw script de extensie “.scm” moeten geven.

Waar u uw scripts plaatst is een kwestie van voorkeur. In GIMP's voorkeuren Mappen kunt u zien in welke mappen GIMP zoekt naar scripts. Het is ook mogelijk om daar een nieuwe map toe te voegen. De map waar GIMP zijn eigen scripts opslaat is gewoonlijk niet de beste keuze voor uw scripts, maar voor de rest kunt u uitkiezen wat u wilt.

Elk script voor Script-Fu definieert ten minste een functie, wat de hoofdfunctie van het script is. Dat is waar u het werk doet.

Elk script moet zich ook registreren bij de procedurele database, zodat u er toegang toe heeft binnen GIMP.

We zullen eerst de hoofdfunctie definiëren:

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

Hier hebben we een nieuwe functie gedefinieerd, genaamd script-fu-text-box die vier parameters neemt, die later zullen corresponderen met enige tekst, een lettertype, de grootte van het lettertype en de kleur van de tekst. De functie is momenteel leeg en doet dus niets. Zover gaat alles goed — niets nieuws, niets vreemds.

De conventies voor het geven van namen in Scheme lijken een voorkeur te hebben voor kleine letters met afbreekstreepjes, die ik heb gevolgd bij het geven van een naam aan de functie. Ik ben echter van de conventie afgeweken voor wat betreft de parameters. Ik hou meer van beschrijvende namen voor mijn parameters en variabelen en dus voeg in het voorvoegsel "in" toe aan de parameters, zodat ik snel kan zien dat zij waarden zijn die worden ingevoegd in het script, in plaats van er binnen gemaakt worden. Ik gebruik het voorvoegsel "the" voor variabelen die binnen het script worden gedefinieerd.

Het is een conventie van GIMP om uw functies voor scripts script-fu-abc te noemen, omdat, als zij worden vermeld in de procedurele database, zij allemaal staan onder Script-Fu als u de functies vermeld. Dat helpt ook om ze te onderscheiden van plug-ins.

Dan, laten we de functie registreren bij GIMP. Dat wordt gedaan door de functie script-fu-register. Als GIMP in een script leest, zal het die functie uitvoeren, die het script registreert in de procedurele database. U kunt deze aanroep naar de functie plaatsen waar u wilt in uw script, maar ik plaats het gewoonlijk aan het einde, na al mijn andere code.

Hier is de code voor het registreren van deze functie (ik zal al deze parameters later uitleggen):

  (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>/File/Create/Text")
      

Sla deze functies op in een tekstbestand met het achtervoegsel .scm in uw map voor scripts, en herstart dan GIMP. Het nieuwe script zal verschijnen als Bestand → Maken → Tekst → Text Box.

Als u dit nieuwe script activeert, zal het niets doen, natuurlijk, maar u kunt de vragen zien die u hebt gemaakt bij het registreren van het script (meer informatie over wat we deden wordt hierna behandeld).

Tenslotte, als u de Procedureverkenner ( Help → Procedureverkenner) activeert, zult u merken dat ons script nu in de database verschijnt.

Voor het registreren van ons script bij GIMP, roepen we de functie script-fu-register aan, vullen de zeven vereiste parameters in en voegen de eigen parameters van ons script toe, samen met een beschrijving en een standaard waarde voor elke parameter.

Als we eenmaal de vereiste parameters hebben vermeld, moeten we vervolgens de parameters vermelden die corresponderen met de parameters die ons script nodig heeft. Wanneer we de parameters vermelden, geven we hints over wat hun typen zijn. Dat is voor het dialoogvenster dat naar voren komt als de gebruiker ons script selecteert. We verschaffen ook een standaard waarde.

Dit gedeelte van het proces voor registreren heeft de volgende indeling:

Als we ons script eenmaal hebben geregistreerd, moeten we GIMP vertellen waar het te vinden is in het menu.

De beste locatie in het menu voor uw script is afhankelijk van zijn functie. De meeste scripts zijn te vinden in de menu's Filters en Kleuren.

Voor het huidige script, dat een nieuwe afbeelding maakt, kiezen we voor een submenu van Bestand → Aanmaken. Dat is wat de regel met de functie script-fu-menu-register doet. Dus, we registreerden ons script Text Box hier: Bestand → Aanmaken → Tekst → Text Box.

Zoals u al opmerkte, het submenu Tekst in het menu Bestand → Aanmaken was er nog niet toen we begonnen — GIMP maakt automatisch menu's als die nog niet bestaan.

Afbeelding 13.2. Het menu van ons script.