One of the most common operations I perform in GIMP is creating a box with some text in it for a web page, a logo or whatever. However, you never quite know how big to make the initial image when you start out. You don't know how much space the text will fill with the font and font size you want.

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

Proto vytvoříme skript, který pojmenujeme Text Box a který vytvoří obrázek o velikosti přesně odpovídající zadanému textu. Uživatel bude mít možnost zvolit i řez písma, jeho velikost a barvu.

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.

Každý Script-Fu skript definuje alespoň jednu funkci, hlavní funkci skriptu. Ta je zodpovědná za činnost skriptu.

Every script must also register with the procedural database, so you can access it within GIMP.

Nejprve definujeme hlavní funkci:

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

Here, we've defined a new function called script-fu-text-box that takes four parameters, which will later correspond to some text, a font, the font size, and the text's color. The function is currently empty and thus does nothing. So far, so good — nothing new, nothing fancy.

Konvence jazyka Scheme pro vytváření jmen upřednostňují malá písmena a pomlčky, tak jako jsme učinili při výběru jména funkce. Při pojmenovávání jejích parametrů jsme se však od konvence odchýlili. Mám rád jména popisná, která o funkci nebo parametru hodně říkají, proto jsme pro parametry použili předponu in, která naznačuje, že parametry obsahují hodnoty předávané skriptu, nikoliv skriptem vytvořené. Pro proměnné vytvořené uvnitř skriptu používám předponu the.

It's GIMP convention to name your script functions script-fu-abc, because then when they're listed in the procedural database, they'll all show up under Script-Fu when you're listing the functions. This also helps distinguish them from plug-ins.

Now, let's register the function with GIMP. This is done by calling the function script-fu-register. When GIMP reads in a script, it will execute this function, which registers the script with the procedural database. You can place this function call wherever you wish in your script, but I usually place it at the end, after all my other code.

Zde je výpis naší registrační funkce (její parametry vzápětí vysvětlím):

  (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 choose Filters → Script-Fu → Refresh Scripts, this new script will appear as File → Create → Text → Text Box.

Pokud ale skript spustíte, neudělá samozřejmě nic užitečného, ale uvidíte výzvy vytvořené při registraci skriptu (podrobnosti dále).

Finally, if you invoke the Procedure Browser ( Help → Procedure Browser), you'll notice that our script now appears in the database.

To register our script with GIMP, we call the function script-fu-register, fill in the seven required parameters and add our script's own parameters, along with a description and default value for each parameter.

Po uvedení obecných, povinných parametrů je třeba uvést parametry, které vyžaduje náš skript. V seznamu těchto parametrů je také třeba uvést jejich typ, což umožní správně zobrazit dialog, ve kterém uživatel parametry nastavuje. Také zadáme výchozí hodnoty těchto parametrů.

Tato část registračního procesu používá následující formát:

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.

Obrázek 13.2. The menu of our script.