Eg bruker gjerne GIMP for å lage boksar med litt tekst og/eller bilete i for heimesidene mine. Ulempen er at eg aldri veit på førehand kor stor denne boksen blir, og har dermed problem med å vite kor stort startvindauge må vere. Alt er avhengig av skrifttype, skriftstorleik og eventuelle andre ting som skal vere med.

Dette problemet kan løysast og automatiserast med Script-Fu.

Vi vill derfor lage eit skript som vi kallar «Text Box», og som lagar eit bilete i høveleg storleik til å passa pent rundt ei tekstlinje som brukaren skriv inn. Sjølvsagt kan brukaren også velja både type, storleik og farge for skrifta.

Opp til no har vi arbeidd på Script-Fu-konsollen. No skal vi gå over til å redigera skriptfiler. Skriptfiler er reine tekstfiler som kan redigerast i program for å redigera tekst eller kode. Kva namn du brukar på fila er ikkje så viktig, men bør vera slik at det er lett å finna igjen skriptet. Du gjev skriptfila utvidinga «.scm».

Kvar du lagrar skripta dine er eit spørsmål om preferanse. I GIMPs mappeinnstillingar kan du sjå kva mapper GIMP ser etter skript i. Det er også mogleg å leggja til ei ny mappe der. Til vanleg er mappa som GIMP lagrar sine eigne skript i ikkje det beste valet for å lagra skripta dine, men sjølvsagt brukar du staden som passar deg best.

Kvart einaste skript i Script-Fu må definera minst ein funksjon, og det er hovudfunksjonen for skriptet. Det er her du definerer kva skriptet skal gjere.

Alle skripta må også kunne registrerast i prosedyredatabasen slik at dei er tilgjengelege for GIMP.

Vi må altså først definera hovudfunksjonen:

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

Setninga ovanfor definerer ein ny funksjon som vi har kalla script-fu-text-box. Funksjonen tar fire parametrar, som seinare vert tilordna noko tekst («inText»), ein skrifttype («inFont»), ein skriftstorleik («inFontSize») og ein tekstfarge («inTextColor»). (Eigentleg kunne vi like gjerne ha brukt norske namn her, men i programmering er det vanleg å bruke engelske namn slik at programmet er forståeleg også for andre). Funksjonen vi har laga er førebels tom og gjer ikkje noko som helst. Så langt inkje nytt eller merkverdig.

Eigentleg godtar Scheme fleire måtar å skriva namn på. Har du gode vanar med deg frå andre språk, kan du stort sett nytta desse. Som i alle(?) programmeringsspråk, kan du ikkje dele opp eit namn med mellomrom. I Scheme er det difor vanleg praksis å gjere samansette ord meir forståelege ved å dela dei opp med bindestrek (-) slik du ser det er brukt i funksjonsnamnet. Dette vert av mange også brukt i parameternamna. Her har eg likevel nytta ein annan metode, nemleg å markera dei ulike orda med stor bokstav. I tillegg legg eg inn eit «in» framføre for å markera at dette er inndata og ikkje noko som er lagt til seinare. (Eg har lagt med til den vanen å bruke prefikset «the» framføre variablar som vert oppretta inne i skriptet).

GIMP vil helst gi skriptfunksjonane namnet script-fu-abc slik at dei vert lista ut under Script-Fu i prosedyredatabasen. Dette også for å skilje dei frå programtillegg.

Nå må vi registrera funksjonen vår i GIMP. Dette gjer vi ved å kalle opp funksjonen script-fu-register. Når GIMP les inn eit skript, vil denne funksjonen legge skriptet inn i prosedyredatabasen. Du kan eigentleg skrive inn dette funksjonsoppkallet kvar som helst i skriptet, men det er vanleg å setje det heilt på slutten, etter alle dei andre kodane.

Her er utlistinga av programbiten som registrerer denne funksjonen (forklaringa kjem etterpå):

  (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")
      

Dersom du lagrar dette i skriptkatalogen som ei tekstfil med filutvidinga .scm og deretter vel Filter → Script-Fu → Oppdater skript, vil dette skriptet dukka opp i Fil → Hent inn → Text → Text Box.

Førebels gjer dette skriptet naturleg nok ingenting. Einaste er at du ser korleis skriptet vert registrert i GIMP og få ein kontroll på at du har gjort alt rett så langt.

Dersom du aktiverer prosedyrelesaren ( Hjelp → Prosedyrelesar) vil du finna at scriptet ditt nå er registrert i databasen.

For å registrera skriptet i GIMP, må vi skrive inn dei sju obligatoriske parametra, legge til skriptet sine eigne parametrar og ei beskriving av skriptet, og endeleg dei verdiane du ønskjer skriptet skal opnast med i dei variable parametra. Deretter kallar du opp funksjonen «script-fu-register» frå skriptet ditt.

Når vi endeleg er ferdige med dei obligatoriske parametra, er tida komen for dei skriptavhengige parametra. Når vi listar opp parametra for skriptet, tar vi også med kva for type dei er. Dette er for dialogvindauget som sprett opp når nokon vel skriptet ditt. I tillegg treng vi også ein førehandsvald verdi for parametra. Den verdien programmet vil nytte om brukaren ikkje gjer endringar.

Dette avsnittet i registreringsprosessen har dette formatet:

Når skriptet er registrert, nå vi fortelja GIMP kva det skal vera i menyen.

Den beste menyplasseringa er avhengig av kva funksjon skriptet har. Dei fleste skripta er plasserte i menyane Filter og Fargar.

For det gjeldande skriptet, som lagar eit nytt bilete, vel vi ein undermeny med Fil → Opprett. Dette er det linja med script-fu-menu-register-funksjonen gjer. Dermed registrerte vi tekstboksskriptet vårt her: Fil → Opprett → Tekst → Tekstboks.

Du la kanskje merke til at text-undermenyen i Fil → Opprett ikkje var der til å byrja med. GIMP opprettar nye menyar automatisk.

Figur 13.2. Menyen for skriptet ditt.