Appendix F. Scripts
Prev |  | Next

# Appendix F. Scripts

## 1. Introduction

OmegaT allows to run scripts written in different scripting languages.

## 2. Use

Clicking Tools > Scripting opens the Scripting window:

The Scripting window allows you to load an existing script into the text area and run it against the current opened project. To customize the script feature, do the following:

- Load a script into the editor by clicking on its name in the list on the left panel.

- Right-click on a button from "<1>" to "<12>" in the bottom panel and select "Add". In the above example, two scripts (position 1 and 2) have already been added.

- When you left-click on the number, the selected script will run. You can start the selected macros from the main menu as well by using their entries in the Tools menu or by pressing Ctrl+Alt+F# (# 1 to 12).

By default, scripts are stored in the "scripts" folder located in OmegaT installation folder (the folder that contains the OmegaT.jar).

You can add new scripts there, so they will appear in the list of available scripts in the Scripting window.

## 3. Scripting languages

The following scripting languages have been implemented:

- Groovy (http://groovy.codehaus.org): is a dynamic language for the Java Virtual machine. It builds upon the strengths of Java but has additional power features inspired by languages like Python, Ruby and Smalltalk.

- JavaScript (sometimes abbreviated JS, not to be confused with Java): is a prototype-based scripting language that is dynamic, weakly typed and has first-class functions. It is a multi-paradigm language, supporting object-oriented, imperative, and functional programming styles. Being the language behind popular software such as Firefox it is a familiar and preferred programming tool in the open-source domain.

All the languages have access to the OmegaT object model, with the project as the top object. The following code snippet in groovy for instance scans through all the segments in all files in the current project and, if the translation exists, prints out the source and the target of the segment:

        files = project.projectFiles;
        for (i in 0 ..< files.size())
        {
            for (j in 0 ..< files[i].entries.size())
            {
                currSegment = files[i].entries[j];
                if (project.getTranslationInfo(currSegment))
                {
                    source = currSegment.getSrcText();
                    target = project.getTranslationInfo(currSegment).translation;
                    console.println(source + " >>>> " + target);
                }
            }
        }

Prev |  | Next
Appendix E. LanguageTool plugin | Home | Appendix G. OmegaT on the web