Una de las operaciones más comunes que realiza el autor en GIMP es crear una caja con algún texto en ella para una página web, un logotipo o algo así. Nunca se sabe el tamaño adecuado de una imagen cuando se empieza. No sabe cuánto espacio llenará el texto con la tipografía ni el tamaño de tipografía que quiere.

This problem can be solved and automated with Script-Fu.

Crearemos un script, llamado «Text Box», que creará una imagen, con el tamaño correctamente ajustado a una línea de texto, que el usuario introduce. También, dejaremos al usuario elegir la fuente, el tamaño de la fuente y el color del texto.

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 guión Script-Fu define al menos una función, que es la función principal del script. Es donde hace el trabajo.

Cada script debe registrarse también en la base de datos de procedimientos, para poder acceder a el bajo GIMP.

Se define la función principal, primero:

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

Aquí se ha definido una nueva función llamada script-fu-text-box que toma cuatro parámetros que más tarde corresponderán al texto, a una tipografía, al tamaño de la tipografía y al color del texto. La función generalmente está vacía y no hace nada. Hasta ahora, todo va bien; nada nuevo, nada lujoso.

Las convenciones de nombres en Scheme parecen preferir minúsculas con guiones y se han seguido en el nombre de la función. Sin embargo, se parte de la convención con los parámetros. Se quieren nombres más descriptivos para los parámetros y variables, y se añade el prefijo «in» a los parámetros, así se puede ver rápidamente qué valores entran en el script, en lugar de que los que se crean en él. Se usa el prefijo «the» para las variables definidas en el script.

Es la convención de GIMP para nombrar sus funciones de script script-fu-abc, porque así están listadas en la base de datos de procedimientos, todas ellas se mostrarán bajo Script-Fu cuando se estén listando las funciones. Esto también ayuda a distinguirlas de los complementos.

Ahora se registra la función con GIMP. Esto se hace llamando a la función script-fu-register. Cuando GIMP lee en un script, ejecutará esta función, que registrará el script en la base de datos de procedimientos. Puede situar esta llamada a la función donde quiera en su script, pero normalmente se sitúa al final, después de las otras líneas de código.

Aquí está el listado de registro de esta función (se explicarán todos estos parámetros enseguida):

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

If you save these functions in a text file with a .scm suffix in your script directory, then restart GIMP. The new script will appear as File → Create → Text → Text Box.

Si llama a este nuevo script, no hará nada, desde luego, pero puede ver los apuntes creados cuando se registra el script (más información de lo que hicimos, se descubrirá luego).

Finalmente, si abre el visor de procedimientos Ayuda → Visor de procedimientos), verá que nuestro script aparece en la base de datos.

Para registrar el script en GIMP, se llamará a la función script-fu-register, se rellenarán los siete parámetros requeridos y se añadirán los parámetros propios, junto con una descripción y los valores predefinidos para cada parámetro.

Una vez que se han listado los parámetros requeridos, se necesitan listar los parámetros que corresponden a los parámetros que su script necesita. Al listar estos parámetros, se dan indicaciones del tipo que son. Esto es por el diálogo que aparece cuando el usuario selecciona el script. También se pueden proporcionar valores predefinidos.

Esta sección del proceso de registro tiene el siguiente formato:

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.

If you notice, the Text submenu in the File → Create menu wasn't there when we began — GIMP automatically creates any menus not already existing.

Figura 13.2. El menú del script.