readme.txt

@@TRANSLATION_NOTICE@@

==============================================================================
  OmegaT 3.0, Read Me file

  1.  Information about OmegaT
  2.  What is OmegaT?
  3.  Installing OmegaT
  4.  Contributions to OmegaT
  5.  Is OmegaT bugging you? Do you need help?
  6.  Release details

==============================================================================
  1.  Information about OmegaT


The most current info about OmegaT can be found at
      http://www.omegat.org/

User support, at the Yahoo user group (multilingual), where the archives are
searchable without subscription:
     http://tech.groups.yahoo.com/group/OmegaT/

Requests for Enhancements (in English), at the SourceForge site:
     https://sourceforge.net/p/omegat/feature-requests/

Bug reports (in English), at the SourceForge site:
     https://sourceforge.net/p/omegat/bugs/

==============================================================================
  2.  What is OmegaT?

OmegaT is a computer-assisted translation (CAT) tool. It is free, that is you 
don't have to pay anything to be able to use it, even for professional use, 
and you are free to modify it and/or re-distribute it as long as you respect 
the user license.

OmegaT's main features are:
  - ability to run on any operating system supporting Java
  - use of any valid TMX file as a translation reference
  - flexible sentence segmenting (using an SRX-like method)
  - searches in the project and the reference translation memories
  - searches of files in supported formats in any folder 
  - fuzzy matching
  - smart handling of projects including complex folder hierarchies
  - support for glossaries (terminology checks) 
  - support for OpenSource on-the-fly spell checkers
  - support for StarDict dictionaries
  - support for the Google Translate machine translation services
  - clear and comprehensive documentation and tutorial
  - localization in a number of languages.

OmegaT supports the following file formats out of the box:

- Plain text file formats

  - ASCII text (.txt, etc.)
  - Encoded text (*.UTF8)
  - Java resource bundles (*.properties)
  - PO files (*.po)
  - INI (key=value) files (*.ini)
  - DTD files (*.DTD)
  - DocuWiki files (*.txt)
  - SubRip title files (*.srt)
  - Magento CE Locale CSV (*.csv)

- Tagged text file formats

  - OpenOffice.org / OpenDocument (*.odt, *.ott, *.ods, *.ots, *.odp, *.otp)
  - Microsoft Open XML (*.docx, *.xlsx, *.pptx)
  - (X)HTML (*.html, *.xhtml,*.xht)
  - HTML Help Compiler (*.hhc, *.hhk)
  - DocBook (*.xml)
  - monolingual XLIFF (*.xlf, *.xliff, *.sdlxliff)
  - QuarkXPress CopyFlowGold (*.tag, *.xtg)
  - ResX files (*.resx)
  - Android resource (*.xml)
  - LaTex (*.tex, *.latex)
  - Help (*.xml) and Manual (*.hmxp) files
  - Typo3 LocManager (*.xml)
  - WiX Localization (*.wxl)
  - Iceni Infix (*.xml)
  - Flash XML export (*.xml)
  - Wordfast TXML (*.txml)
  - Camtasia for Windows (*.camproj)
  - Visio (*.vxd)

OmegaT can be customized to support other file formats as well.

OmegaT will automatically parse even the most complex source folder
hierarchies, to access all the supported files, and produce a target folder
with exactly the same structure, including copies of any non-supported files.

For a quick-start tutorial, launch OmegaT and read the displayed Instant Start 
Tutorial.

The user manual is in the package you just downloaded, you can access it from
the [Help] menu after starting OmegaT.

==============================================================================
 3. Installing OmegaT

3.1 General
In order to run, OmegaT requires the Java Runtime Environment (JRE) version 
1.5 or higher to be installed on your system. OmegaT packages which include
the Java Runtime Environment are now available to save users the trouble of 
selecting, obtaining and installing it. 

If you have already Java, one way to install the current version of 
OmegaT is to use Java Web Start. 
For this purpose download the following file and then execute it:

   http://omegat.sourceforge.net/webstart/OmegaT.jnlp

It will install the correct environment for your computer and the application 
itself on the first run. Later calls do not need to be online.

During the installation, depending on your operating system, you may receive 
several security warnings. The certificate is by "PnS Concept". 
The permissions you give to this version (which might be mentioned as an 
"unrestricted access to the computer") are identical  to permissions you give 
to the local version, as installed by a procedure, described later: they allow 
an access to the hard drive of the computer. Subsequent clicks on  OmegaT.jnlp 
will check for any upgrades, if you are online, install them if there are any, 
and then start OmegaT. 

The alternative ways and means of dowloading and installing OmegaT are
shown below. 

Windows and Linux users: if you are confident that your system already has a 
suitable version of the JRE installed, you can install the version of OmegaT 
without the JRE (this is indicated in the name of the version,"Without_JRE"). 
If you are in any doubt, we recommend that you use the version supplied with 
JRE. This is safe, since even if the JRE is already installed on your system, 
this version will not interfere with it.

Linux users: 
OmegaT will run on the open-implementation source Java 
packaged with many Linux distributions (for example, Ubuntu), but you may
experience bugs, display problems or missing features. We therefore recommend
that you download and install either the Oracle Java Runtime Environment (JRE) 
or the OmegaT package bundled with JRE (the .tar.bz2) bundle marked 
"Linux"). If you install a version of Java at system level, you must either 
ensure that it is in your launch path, or call it explicitly when launching 
OmegaT. If you are not very familiar with Linux, we therefore recommend 
that you install an OmegaT version with JRE included. This is safe, 
since this "local" JRE will not interfere with any other JRE installed 
on your system.

Mac users: 
The JRE is already installed on Mac OS X before Mac OS X 10.7 
(Lion). Lion users will be prompted by the system when they first launch 
an application that requires Java and the system will eventually 
automatically download and install it.

Linux on PowerPC systems: 
Users will need to download IBM's JRE, as Sun does 
not provide a JRE for PPC systems. Download in this case from:

    http://www.ibm.com/developerworks/java/jdk/linux/download.html 


3.2 Installation
* Windows users: 
Simply launch the installation program. If you wish, the 
installation program can create shortcuts to launch OmegaT.

* Linux users:
Place the archive in any suitable folder and unpack it; OmegaT is then 
ready to be launched. You can however obtain a neater and more user-friendly 
installation by using the installation script (linux-install.sh). To use 
this script, open a terminal window (console), change folder to the folder 
containing OmegaT.jar and the linux-install.sh script, and execute the 
script with ./linux-install.sh.

* Mac users:
Copy the OmegaT.zip archive to a suitable location and unpack it there 
to obtain a folder that contains an HTML documentation index file and 
OmegaT.app, the application file.

* Others (e.g., Solaris, FreeBSD: 
To install OmegaT, simply create a suitable folder for OmegaT. Copy the 
OmegaT zip or tar.bz2 archive to this folder and unpack it there.

3.3 Launching OmegaT
Launch OmegaT as follows.

* Windows users: 
If, during installation, you have created a shortcut on the desktop, 
double-click on that shortcut. Alternatively, double-click on the file 
OmegaT.exe. If you can see the file OmegaT but not OmegaT.exe in your 
File Manager (Windows Explorer), change the settings so that file 
extensions are displayed.

* Linux users:
If you used the installation script supplied, you should be able to launch OmegaT with:
Alt+F2
and then:
omegat

* Mac users:
Double-click on the file OmegaT.app.

* From your file manager (all systems):
Double-click on the file OmegaT.jar. This will work only if the .jar
file type is associated with Java on your system.

* From the command line (all systems): 
The command to launch OmegaT is:

cd <folder where the file OmegaT.jar is located>

<name and path of the Java executable file> -jar OmegaT.jar

(The Java executable file is the file java on Linux and java.exe on Windows.
If Java is installed at system level and is in the command path, the full 
path need not be entered.)

Customizing your OmegaT launch experience:

* Windows users: 
The install program can create shortcuts for you in the start 
menu, on the desktop and in the quick launch area. You can also manually drag 
the file OmegaT.exe to the start menu, the desktop or the quick launch area
to link it from there.

* Linux users:
For a more user-friendly way of launching OmegaT, you can use the Kaptain 
script provided (omegat.kaptn). To use this script you must first install 
Kaptain. You can then launch the Kaptain launch script with
Alt+F2
omegat.kaptn

For more information on the Kaptain script and on adding menu items and 
launch icons on Linux, refer to the OmegaT on Linux HowTo.

Mac users:
Drag OmegaT.app to your dock or to the tool bar of a Finder window to be 
able to launch it  from any location. You can also call it in the 
Spotlight search field.

==============================================================================
 4. Getting involved in the OmegaT project

To participate in the development of OmegaT, get in touch with the developers at:
    http://lists.sourceforge.net/lists/listinfo/omegat-development

To translate OmegaT's user interface, user manual or other related documents,
read:
      
      http://www.omegat.org/en/howtos/localizing_omegat.php

And subscribe to the translators' list:
      https://lists.sourceforge.net/lists/listinfo/omegat-l10n

To contribute in other ways, subscribe first to the user group at:
      http://tech.groups.yahoo.com/group/omegat/

And get a feel of what is going on in the OmegaT world...

  OmegaT is the original work of Keith Godfrey.
  Didier Briel is the OmegaT project manager.

Previous contributors include:
(alphabetical order)

Code has been contributed by
  Zoltan Bartko
  Volker Berlin
  Didier Briel
  Kim Bruning
  Alex Buloichik (lead developer)
  Sandra Jean Chua
  Thomas Cordonnier
  Enrique Estévez Fernández
  Martin Fleurke  
  Wildrich Fourie
  Phillip Hall
  Jean-Christophe Helary
  Thomas Huriaux
  Hans-Peter Jacobs
  Kyle Katarn
  Piotr Kulik
  Ibai Lakunza Velasco
  Guido Leenders
  Aaron Madlon-Kay
  Fabián Mandelbaum
  Manfred Martin
  Adiel Mittmann
  John Moran
  Maxym Mykhalchuk 
  Arno Peters
  Henry Pijffers 
  Briac Pilpré
  Tiago Saboga
  Andrzej Sawuła
  Benjamin Siband
  Yu Tang
  Rashid Umarov  
  Antonio Vilei
  Ilia Vinogradov
  Martin Wunderlich
  Michael Zakharov

Other contributions by
  Sabine Cretella
  Dmitri Gabinski
  Jean-Christophe Helary (localization manager)
  Vincent Bidaux (documentation manager)
  Samuel Murray
  Marc Prior (webmaster)
  and many, many more very helpful people

(If you think you have significantly contributed to the OmegaT Project 
but you don't see your name on the lists, feel free to contact us.)

OmegaT uses the following libraries:
  HTMLParser 1.6 by Somik Raha, Derrick Oswald and others (LGPL License)
  VLDocking Framework 3.0.5-SNAPSHOT (LGPL License)
  Hunspell by László Németh and others (LGPL License)
  JNA by Todd Fast, Timothy Wall and others (LGPL License)
  Swing-Layout 1.0.4 (LGPL License)
  Jmyspell 2.1.4 (LGPL License)
  SVNKit 1.8.5 (TMate License)
  Sequence Library (Sequence Library License)
  ANTLR 3.4 (ANTLR 3 license)
  SQLJet 1.1.10 (GPL v2)
  JGit (Eclipse Distribution License)
  JSch (JSch License)
  Base64 (public domain)
  Diff (GPL)
  trilead-ssh2-1.0.0-build217 (Trilead SSH license)
  lucene-*.jar (Apache License 2.0)
  The English tokenizers (org.omegat.tokenizer.SnowballEnglishTokenizer and
  org.omegat.tokenizer.LuceneEnglishTokenizer) use stop words from Okapi
(http://okapi.sourceforge.net) (LGPL license)
  tinysegmenter.jar (Modified BSD license)
  commons-*.jar (Apache License 2.0)
  jWordSplitter (Apache License 2.0)
  LanguageTool.jar (LGPL license)
  morfologik-*.jar (Morfologik license)
  segment-1.4.1.jar (Segment license)
  pdfbox-app-1.8.1.jar (Apache License 2.0)
  KoreanAnalyzer-3x-120223.jar (Apache License 2.0)
  SuperTMXMerge-for_OmegaT.jar (LGPL license)
  groovy-all-2.2.2.jar (Apache Licence 2.0)
  slf4j (MIT License)
  juniversalchardet-1.0.3.jar (GPL v2)

==============================================================================
 5.  Is OmegaT bugging you? Do you need help?

Before reporting a bug, make sure that you have thoroughly checked the
documentation. What you see may instead be a characteristic of OmegaT that
you have just discovered. If you check the OmegaT log and you see words like
"Error", "Warning", "Exception", or "died unexpectedly" then you have probably
discovered a genuine problem (the log.txt is located in the user preferences
folder, see the manual for its location).

The next thing to do is to confirm what you found with other users, to make 
sure this has not already been reported. You can verify the bug report page at
SourceForge too. Only when you are sure you are the first to have found some
reproducible sequence of event that triggered something not supposed to
happen should you file a bug report.

Every good bug report needs exactly three things.
  - Steps to reproduce,
  - What you expected to see, and
  - What you saw instead.

You can add copies of files, portions of the log, screen shots, anything that
you think will help the developers with finding and fixing your bug.

To browse the archives of the user group, go to:
     http://tech.groups.yahoo.com/group/OmegaT/

To browse the bug report page and file a new bug report if necessary, go to:
     https://sourceforge.net/p/omegat/bugs/

To keep track of what is happening to your bug report you may want to register
as a Source Forge user.

==============================================================================
6.   Release details

Please see the file 'changes.txt' for detailed information about changes in
this and all previous releases.


==============================================================================