Ahora, registremos la función con el GIMP. Esto se hace llamando a la función script-fu-register. Cuando el GIMP lee un script, ejecutará esta función, que registrará el script en la base de datos de procedimientos. Puede situar esta llamada a función donde quiera en su script, pero, normalmente, se situa al final, después de las otras lineas de códigos. Cuando empiezo a trabajar con un script nuevo, a mi me gusta más ponerla al principio, ya que veo mejor los parámetros y su tipo.
Aquí está el listado de registro de esta función (explicaré todos estos parámetros en un minuto):
(script-fu-register
"script-fu-text-box" ;func 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" ;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" "/Xtns/Script-Fu/Text")
Para registrar nuestro script en el GIMP, llamamos a la función script-fu-register, rellenamos los siete parámetros requeridos y añadimos los nuestros propios, junto con una descripción y valores predefinidos para cada parámetro.
Los parámetros requeridos:- El nombre de la función que definimos. Esto es la llamada de función cuando nuestro script es invocado (el punto de entrada de nuestro script). Esto es necesario porque podriamos definir funciones adicionales bajo el mismo archivo, y GIMP necesita saber a cuales de estas funciones se llama. En nuestro ejemplo, solo definimos una función, text box, que registramos.
- La localización en el menú donde el script será insertado. El lugar exacto de el script está especificado, como una ruta en Unix, con la raiz de la ruta estando entre la caja de herramientas o click derecho.
Puede hacerse de dos formas:
En dos sentencias, script-fu-register y script-fu-menu-register, tal como hemos visto arriba, o todo en la sentencia script-fu-register (no siendo necesaría la segunda sentencia)
La función anterior, con el cambio de ubicación del paht, la función script-fu-register aparecería de la siguiente forma:
(script-fu-register
"script-fu-text-box" ;func name
"/Script-Fu/Text/_My Text Box" ;menu label
…....................................................
SF-COLOR "Color:" '(0 0 0) ; un color
) ;Ya no sería necesaria la función script-fu-menu-register
Si su script no opera sobre una imagen existente (y crea una imagen nueva, como hará nuestro Text Box), querrá insertarlo en el menú de la caja de herramientas, este es el menu en la ventana principal del GIMP (donde se localizan todas las herramientas: herramientas de selección, lupa, etc.).
Si su script está intentando trabajar sobre una imagen que está siendo editada, querrá insertarla en el menú que aparece cuando pulsa el botón derecho sobre una imagen abierta. El resto de la ruta apunta a la lista de menú, menús y sub-menús. Registramos nuestro script en el menú Text de el menú Script-Fu del menú Exts, en el menú de la caja de herramientas ( Filtros → Script-Fu → Text → Text Box ).
Si se fija, el sub-menú Text, en el menú Script-Fu, no estaba allí cuando empezamos, el GIMP crea, automaticamente, cualquier menú que todavia no exista.
"/Script-Fu/_Zona de ajuste con ufraw": aparecerá en el menú superior, opción Script-Fu.
"/Script-Fu/Text/_Text Box": aparece en menú superior, opcion Script-Fu, en la opción Text (creada si no existe)
- Una descripción de su script, para ser mostrada en el Examinador de Procedimientos.
- El nombre del autor del código.
- Información del copyright.
- La fecha en que se hizó el código, o la última revisión del mismo.
- El tipo de imágenes con las trabaja el script. Puede ser uno de los siguientes: RGB, RGBA, GRAY, GRAYA, INDEXED, INDEXEDA. O podría no ser ninguno de ellos, en nuestro caso, estamos creando una imagen, y no necesitamos definir el tipo de imagen sobre la que trabajaremos.
- A continuación irían todos los parámetros, con su leyenda y tipo.Los parámetros se escriben indicando su tipo, que veremos en el siguiente apartado, la leyenda, entre comillas, que aparecerá en la ventana de entrada y los valores del parámetro, que variarán según el tipo de dato.