# OmegaT Files and Directories

- Translation project files
  - Project files location
  - Project files list
- User files
  - User files location
  - User files list
- Application files
  - Application files list

OmegaT works with three types of files.

Translation project files
  They constitute a translation project. Loosing them may affect the project's integrity and your ability to complete a job. Project files are the most important files in OmegaT. They are the files you will deal with on a daily basis while translating.
User setting files
  They are created when OmegaT's behavior is modified by user accessible preference settings. Loosing them will usually result in having OmegaT work with "factory" settings. This can sometimes cause a little trouble when you are in the middle of a translation.
Application files
  They are included in the package you download, most of them are necessary to have OmegaT function properly. If for some reason such files are lost, just download and/or reinstall OmegaT to restore them all.

# Translation project files

An OmegaT translation project is comprised of a number of files and directories.

## Translation project files location

When you create a translation project, OmegaT automatically creates a list of directories that will later serve as files repositories, as well as a number of files that will be used to set some project preferences and to keep the project translation emory.

By default, a translation project directories are all grouped under the main project directory. Alternate locations for the directories can be chosen at project creation or during the translation. This way it is possible to select existing directories or create directories in locations that reflect your workflow habits.

To change the location of directories after a project has been created open Project → Properties... and do the necessary modifications.

## Translation project files list

From a file browser, a translation project looks like just any other directory. From OmegaT dialogs, a translation project looks like a file with an OmegaT icon associated to it. OmegaT does not need to enter the hierarchy of the project to open it. Selecting the item with the OmegaT icon is enough.

A translation project created with the default settings will have the following structure:

/project_name/
  /omegat/
    project_save.tmx (...)
      This TMX file is created when the project is saved for the first time. This serves as the working translation memory for the project. With the autosave function implemented, it will be automatically updated when you quit. It is the translation memory used to create the translated files.
    project_save.tmx.YEARMMDDHHNN.bak (...)
      A number of TMX files following this pattern will be here. They serve as a backup of project_save.tmx and are updated each time you reopen a project to reflect the contents of project_save.tmx, before any possible change has modified this file.
    project_stats.txt (...)
      This text file can be opened in a spreadsheet application to display segment and word count information. The information it contains is more detailed that what is displayed in the Project Files window.
  /source/
    Files to be included into the project for translation. It is possible to put directories including files or other directories here.
  /target/
    When Project → Create Translated Documents is selected while a project is opened, all the files in /source/, translated or not, will be reproduced here with the same directory hierarchy to reflect the current state of the translation. Practically speaking, OmegaT merges the translation information saved in /omegat/project_save.tmx with the source documents to produce the /target/ contents.
  /tm/
    Any external translation memories to be used are placed in this directory before loading a project.
  /glossary/
    Contains glossary files to be used, if any. The user must place glossary files in this directory before opening a project.
  omegat.project
    OmegaT automatically creates this file when the project is created. It contains the project parameters. The parameters included in this file can be modified from the Project properties window.
  project_name-omegat.tmx (...)
  project_name-level1.tmx
  project_name-level2.tmx
    These files contain the source and target segments corresponding to the contents of the /source/ folder at the time of their creation (usually when the translated files have been created).

# User files

## User files location

Starting with OmegaT 1.6, user files are stored in a separate location where they can be accessed by any version of OmegaT. The location depends on the platform you use:

On Windows:
  C:\Documentation and Settings\<User Name>\Application Data\OmegaT. The bit before <User Name> might be different on some systems, but usually it's there. The entire application data path is retrieved through the environment variable %APPDATA%.
On Linux/Solaris/FreeBSD:
  <User Home>/.omegat (.omegat is a directory, the dot preceding its name makes it invisible unless you type `ls -a` or an equivalent command.)
On MacOSX:
  <User Home>/Library/Preferences/OmegaT

## User files list

User files are:

log.txt
  This file records Java error messages while OmegaT is running. When you think OmegaT is behaving erratically it is important to include this file or the relevant part in any trouble report.
omegat.prefs
  This file is an xml file. It includes all the GUI accessible option settings, as well as window position data.
filters.conf
  This file is an xml file. It includes all the data set by the file filters preferences.
segmentation.conf
  This file is an xml file. It includes all the data set by the sentence segmentation preferences.

# Application files

OmegaT comes as a package you can download from SourceForge. In this chapter we will consider the platform independent package that contains the application in a standard Java form. Other packages include a Linux `.tar` package, a Windows installer -with or without a Java Runtime Environment, a MacOSX installer and a source code package for developers.

This platform independent package can be used on any platform with a running Java 1.4.2 runtime environment, including the platforms for which there is a specific package.

The platform independent package comes as a compressed file that you need to decompress in the directory of your choice for install. Decompression is usually done by double clicking on the downloaded package. Once decompressed, a directory containing OmegaT related files will be created:

Downloaded file:
  OmegaT_1.7.3_Without_JRE.zip
Decompressed directory:
  /OmegaT_1.7.3_Without_JRE/

## Application files list

The OmegaT directory will contain the following files:

/OmegaT_1.7.3_Without_JRE/
  /docs/
    All the user manual files are in this directory. You can open them in an internet browser to have access to external links.
  /images/
    Icons and logo graphics are included here.
  /lib/
    Java files are included here. They are necessary to the well functioning of OmegaT.
  join.html
    This is a normal html file that once opened in your internet browser will redirect you to the OmegaT user group hosted on Yahoo Groups. Joining is not necessary but will give you access to some extra services like access to some files and irregular polls, besides for being able to join in OmegaT related discussions. The group archives are public and consultation does not require subscription to the group.
  changes.txt
    A relatively detailed list of modifications between this version and the preceding versions.
  license.txt
    The GNU GENERAL PUBLIC LICENSE. This license allows you to do certain things with OmegaT, including modifying and distributing it. If you are interested in modifying or distributing OmegaT, take a good look at this document and make sure you are aware of all its implications before doing anything. In case you are in doubt, don't hesitate to ask project members directly either by sending them a mail from the Source Forge page or by sending a public mail to the user group.
  doc-license.txt
    The GNU GENERAL PUBLIC LICENSE. This license covers the documentation. See above.
  readme.txt
    This file is very important and you should make sure you read it before starting OmegaT. It includes general information about OmegaT, where to find more information, how to contribute etc. It is translated to a number of languages.
  OmegaT
    This is a normal text file that contains two lines:
    `#!/bin/bash`
    `java -jar OmegaT.jar $*`
    You may find this file useful if you make it executable (`chmod +x OmegaT`) from the command line after making sure you are in the `/OmegaT_1.7.3/` directory. From now on you'll be able to start OmegaT by calling this file from the command line.
  OmegaT.bat
    This is a normal text file that contains only one line:
    `java -jar OmegaT.jar %*`
    It is used to launch OmegaT from the Windows command line.
  OmegaT.jar
    This file is the main application. To launch OmegaT you have to either call this file from the command line or launch it from your file manager (usually by double-clicking it).

Legal notices