OmegaT 5.7.3 setup guide for Windows¶

This document guides you through the process of installing OmegaT 5.7.3 in your machine. This is a custom version prepared by cApStAn which includes several enhancements and bug fixes not available in the official release.

Mac and Linux operating systems

It's possible to install OmegaT in other operating systems like macOS or Linux. Please follow this guide to install on macOS. Please get in touch through the Helpdesk if you are a Linux user.

Installation¶

Warning

You must have a 64-bit machine to install OmegaT.

Click on the button below to download OmegaT 5.7.3.

Download OmegaT 5.7.3

Trouble to download?

Some browsers (e.g. Microsoft Edge) might ask you whether downloading the installer is safe. It is safe, and you can follow the following steps in the video below to let your browser download the file.
When the download is complete, double-click the installer file to start the installation wizard.
Windows Defender might show a warning about running an unrecognized app.

s

If you see that, click on the More info link in that dialog. In the information displayed you should see that cApStAn is the publisher of this installer.

If that's the case, prease press the Run anyway button to proceed with the installation.
In the next dialog, you may choose the language of the installation, then press Ok.
Please accept the GPL license agreement to proceed, and press Next.
OmegaT will propose the path C:\Users\USER\AppData\Local\Programs\OmegaT for the installation, where it should be possible for non-admin users to install. Do not change this path.

Warning

Please do not modify this installation path unless you're IT personnel and you know what you're doing.
A desktop shortcut (launcher) will be created on your Desktop (which you can double-click later on to launch OmegaT). Do not uncheck that option.
You may modify the name of the OmegaT folder in the start menu, but "OmegaT " is fine, no need to change it in a standard installation.
You're ready to proceed with the installation, just press Next.
After a couple of minutes, your installation should be complete.
Now your installation needs to be configured, please go through the Configuration section below.

Configuration¶

The OmegaT installation must be configured with some custom files.

Automatically¶

If you were installing from scratch in a machine where OmegaT had not been installed before, OmegaT should be configured automatically for you the next time you run it. The same thing will also happen every time an update of the custom configuration is released.

When a new configuration update is being installed, you will see the following dialog:

And you will see this dialog when the configuration is updated:

If you saw the above dialog stating that a custom configuratoin update was installed right after installing OmegaT for the first time, you should be good to go. No need to do anything else (you may jump the next part called "Manually" and go directly to Setup checks further down below) to know how to run a few post-installation checks to confirm that everything is okay.

Manually¶

If for any reason the automatic update above does not work, you may run the configuration update manually.

Most likely, you have the script: just run it¶

You should already have the script that installs the latest configuration (called "Update Customization Bundle"). You may select the shortcut 12 at the bottom of the list of script shortcuts below the Tools > Scripting menu or press the keyboard combination Ctrl+Shift+F12 to run the "Update Customization Bundle" script:

Alternatively, you may open the Scripting menu and run the script from there. Select the script "Update Customization Bundle" in the list and then press the Run button.

If you don't have the script, here's a fallback plan¶

If something is wrong and you don't have that script, you may also download it, open it and run it manually.

Info

Follow the steps in this section only if you cannot find the script as explained above.

Right-click on the button below and select "Save Link As" to download the configuration script (e.g. to your Desktop)

Download UpdateConfigBundle.groovy
In OmegaT, follow these steps to run the configuration script you have downloaded:
- Tools > Scripting > File > Open script
- browse to the folder where you have saved the script (e.g. your Desktop) and select the groovy file
- press the Open button to open the script file and press Run button (on the bottom left)
The script will install the necessary config files. After that it will quit OmegaT.

See the section below to know how to run a few post-installation checks to confirm that everything is okay.

Setup checks¶

The steps above will normally get up and running, but but it's always a good idea to check that everything is okay just in case. One stick in time saves nine. These are the things that you can check:

OmegaT version

To confirm that you have the correct version, you can check that in Help > About > Copy Support Info. You should see:
```
Version: OmegaT-5.7.3_0_57b1bb571
Platform: Windows 10 10.0
Java: 11.0.19 amd64
```
Custom configuration version

To confirm that your custom configuration is up to date, you can go to Options > Access Configuration Folder and find a file called local_version_notes.txt there.

If you open that file, the line at the top showing the most recent update should be the same as the one you can see in page https://cat.capstan.be/OmegaT/v572/.
OMT un/packaging menu entries

Even if you don't use OMT packages, you should have three entries under the Project menu in OmegaT:
Scripts and script shortcuts

In the Tools menu, under Scripting, you should see a list of 12 script shortcuts.

Note

The script shortcuts might be updated occasionally, don't worry if your list is not identical to the screenshot above.

Also, if you open the scripting dialog, you should see the whole list of scripts on the left-hand side.

You're done now. You can start using OmegaT.

Your user Name/ID¶

When opening OmegaT for the first time, please update your Name/ID. To do that click on Options > Preferences > Team.

The Name/ID box might already contain your username. If that's the case, it's fine like that. Otherwise, if the box is empty or ther's some detail that doesn't identify you (e.g. USER), please enter your name or a nickname that identifies you more or less uniquely and that we can associate with you.

If you have been asked to use "VER" in a specific project and you only work as a verifier, you can append your name or initials to that (e.g. VER_msoutopico, VER_manuel, etc).

Then press OK.