Una de les operacions més comunes que es realitza amb el GIMP és crear un quadre amb algun text dins per a una pàgina web, o un logotip. Però quan es comença, mai no se sap la mida adequada de la imatge, ni l'espai que ocuparà el text amb la mida de la lletra.

Els mestres de Script-Fu (i els estudiants) reconeixen ràpidament que aquest problema pot ser fàcilment resolt i automatitzat amb l'Script-Fu.

Crearem un script anomenat «Text Box», que crearà una imatge amb la mida correcta, ajustada a una línia de text que l'usuari ha introduït. També deixarem a l'usuari triar la lletra tipogràfica, la seva mida i el color del text.

Up until now, we've been working in the Script-Fu Console. Now, however, we're going to switch to editing script files. Script files should be plain text files that you can edit in a text or code editor. The name you give is not that important, except for being able to recognize the script. You should give your script file the extension «.scm».

Where you place your scripts is a matter of preference. In GIMP's folder preferences you can see in which folders GIMP looks for scripts. It is also possible to add a new folder there. The folder where GIMP stores its own scripts is usually not the best choice for your scripts, but for the rest feel free to choose what suits you best.

Cada script de Script-Fu defineix almenys una funció, que és la funció principal de l'script. És on fa la feina.

Cada script ha de registrar-se també en la base de dades de procediments, de manera que s'hi pugui accedir amb el GIMP .

Es defineix primer la funció principal:

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

Aquí s'ha definit una nova funció anomenada script-fu-text-box amb quatre paràmetres que més tard correspondran al text, a una mida de lletra i al color del text. La funció està actualment buida i no fa res. Fins aquí tot bé - res de nou, res d'especial.

Les Convencions de nomenclatura de l'Scheme prefereixen minúscules amb guions i s'han respectat dins el nom de la funció. No obstant això, es parteix de la convenció amb els paràmetres. Es volen noms més descriptius pels paràmetres i variables, i s'hi afegeix el prefix «in» als paràmetres, així es pot veure ràpidament quins valors entren en l'script, en comptes dels que es creen en ell. S'utilitza el prefix «the» per a les variables definides en l'script.

És la convenció del GIMP per a anomenar les funcions del vostre script script-fu-abc, perquè així apareixeran en la base de dades de procediments, totes elles es mostraran sota l'Script-Fu quan s'estiguin llistant les funcions. Això també ajuda a distingir-les dels connectors.

Ara, registrem la funció amb el GIMP. Això es fa cridant la funció script-fu-register. Quan el GIMP llegeixi un script, executarà aquesta funció, que registrarà l'script en la base de dades de procediments. Podeu situar aquesta funció on vulgueu dins el vostre script, però normalment se situa al final, després de la resta de les línies del codi.

Aquest és el llistat de registre d'aquesta funció (s'explicaran tots aquests paràmetres de seguida):

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

Si deseu aquestes funcions en un fitxer de text amb el sufix .scm al directori dels vostres scripts, seleccioneu Filtres → Script-Fu → Actualitza els scripts, aquest script nou apareixerà com Fitxer → Crea → Text → Text Box.

Si crideu aquest nou script, no farà res, per descomptat, però podeu veure les anotacions que es van fer quan es va registrar l'script (més informació del que es va fer, es mostrarà després).

Finalment, si obriu el Navegador de procediments (Ajuda → Navegador de procediments), veureu que l'script apareix en la base de dades.

Per a registrar l'script en el GIMP, es cridarà la funció script-fu-register, s'ompliran els set paràmetres requerits i s'hi afegiran els nostres paràmetres, junt amb una descripció i els valors per defecte de cada paràmetre.

Una vegada que s'han llistat els paràmetres requerits, cal precisar quins són els que corresponen amb les necessitats del nostre script. En llistar aquests paràmetres, es donen indicacions del tipus que són; això és pel diàleg que apareix quan l'usuari selecciona l'script. També es poden proporcionar valors per defecte.

Aquesta secció del procés de registre té el següent format:

Once we have registered our script, we need to tell GIMP where it should be found in the menu.

The best menu location of your script depends on its function. Most scripts are found in the Filters and Colors menus.

For the current script, which creates a new image, we choose a submenu of File → Create. This is what the line with the script-fu-menu-register function does. Thus, we registered our Text Box script here: File → Create → Text → Text Box.

Si us fixeu, el submenú Text, dins el menú Fitxer/Crea, no hi era al començament: el GIMP crea automàticament menús que no existeixen.

Figura 13.2. El menú de l'script.