Okapifra: /* Check the Requirements */

2018-12-15T18:53:27Z

Check the Requirements

← Older revision		Revision as of 14:53, 15 December 2018
Line 19:		Line 19:
	===Check the Requirements===		===Check the Requirements===

	Starting with release m24, to run the Okapi tools you must have '''Java 1.7 or later''' installed on your machine. You can use java 1.6 for releases before m24.		Starting with release m24, to run the Okapi tools you must have '''Java 1.8 or later''' installed on your machine. You can use java 1.6 for releases before m24.

	To check if Java is installed on you machine and if it is the proper version, go to a command-line prompt and type:		To check if Java is installed on you machine and if it is the proper version, go to a command-line prompt and type:
Line 25:		Line 25:
	java -version		java -version

	If the call fails or if the version is below 1.7, you need to install or update Java. You can find all the Java downloads here: http://www.java.com/. You can also check your installed version of Java from there.		If the call fails or if the version is below 1.8, you need to install or update Java. You can find all the Java downloads here: http://www.java.com/. You can also check your installed version of Java from there.

	'''Please Note:		'''Please Note:

Ysavourel at 02:50, 5 June 2016

2016-06-05T02:50:58Z

← Older revision		Revision as of 22:50, 4 June 2016
Line 41:		Line 41:
	The installation consist basically in unzipping the downloaded file in a new directory.		The installation consist basically in unzipping the downloaded file in a new directory.

	For platform-specific installation details, see the release notes: http://~~okapi~~.~~opentag.com~~/readme.html.		For platform-specific installation details, see the release notes: http://okapiframework.org/readme.html.

	==Testing the Tools==		==Testing the Tools==

Ysavourel: 1 revision imported

2016-06-04T23:26:47Z

1 revision imported

← Older revision	Revision as of 19:26, 4 June 2016
(No difference)

Ysavourel: /* Installing the Tools */

2014-01-02T18:15:51Z

Installing the Tools

New page

==Overview==

The Okapi tools consist of four applications: [[Rainbow]], [[CheckMate]], [[Tikal]] and [[Ratel]]. They are all cross-platform, able to run on Windows, Linux and Macintosh. These tools are designed to help you in executing localization and translation tasks.

With [[Rainbow]] and [[Tikal]] you can:

* prepare files for translation and post-process them,
* convert file formats, encodings, line-breaks,
* extract terms, create translation memories,
* batch translate with translation memories and machine translation engines,
* and much more.

With [[CheckMate]] you can run different verifications between source and translated text, in bilingual translated files.

With [[Ratel]] you can create and edit segmentation rules in WYSIWYG mode.

==Installing the Tools==

===Check the Requirements===

Starting with release m24, to run the Okapi tools you must have '''Java 1.7 or later''' installed on your machine. You can use java 1.6 for releases before m24.

To check if Java is installed on you machine and if it is the proper version, go to a command-line prompt and type:

java -version

If the call fails or if the version is below 1.7, you need to install or update Java. You can find all the Java downloads here: http://www.java.com/. You can also check your installed version of Java from there.

'''Please Note:
64-bit operating systems will require both a 64-bit version of Java and the 64-bit version of Okapi.
'''

===Download the Distribution===

The next step is to download the '''okapi-apps''' distribution for your platform.

All Okapi downloads are available here: http://bintray.com/okapi/Distribution or from the [[Main Page]].

===Install the Files===

The installation consist basically in unzipping the downloaded file in a new directory.

For platform-specific installation details, see the release notes: http://okapi.opentag.com/readme.html.

==Testing the Tools==

{{NoteBox|If your installation is in a directory where you have limited write-rights (like <code>C:\Program Files</code> or other system directories) you should copy the examples somewhere else, or change the default output location (<cite>Other Settings</cite> tab).}}

===Trying Rainbow===

One way to make sure everything works is to try running a simple process with Rainbow.

1. Start the Rainbow executable that is in your installation directory.

2. Select the <cite>Input List 1</cite> tab.

3. Select <cite>Input</cite> > <cite>Add Documents</cite>. Go to the installation directory, and there go inside the sub-directory named <code>examples</code>. Select the file <code>myFile.html</code>.

Now you should have the file <code>myFile.html</code> listed in the input list and it should be associated with the filter configuration named <code>okf_html</code>.

4. Select <cite>Utilities</cite> > <cite>Text Rewriting</cite>. This should open a dialog box.

5. In the left-hand list of steps, select <cite>Text Modification</cite>. Then on the right-hand pane, in the list <cite>Type of change to perform</cite>, select <cite>Replace selected ASCII characters by extended characters</cite>.

6. Click <cite>Execute</cite>.

7. Go to the directory where <code>myFile.html</code> is located (the <code>examples</code> sub-directory of your installation directory). There you should now see a new file named <code>myFile.out.html</code>. It should be the same as <code>myFile.html</code> but with many accented characters instead of ASCII ones.

===Building and Running the Examples===

Another way to verify if the installation works fine is to run the examples included in the distribution:

1. Go to the <code>examples</code> sub-directory that is in the directory where you have installed Okapi.

2. There are a few examples of programs written with the Okapi libraries. They are pre-built, so you can run them directly:

* On Windows: Run <code>run_examples.bat</code>
* On Linux and Macintosh: Run <code>run_examples.sh</code>

The examples should run without error, except possibly for the last one that tries to access the Open-Tran server, which, sometimes, may be down.

==Where to Go from Here?==

* The [[Rainbow|Rainbow help pages]] will help you start working with rainbow.
* You can look at the [[Knowledge Base]] to find how to perform some tasks.
* The "[[FAQ]]" page may answer some additional questions.
* You can find a complete list of the file format supported in the "[[Filters]]" page.
* To discover which TM and MT engines can be used look at the "[[Connectors]]" page.
* The "[[Steps]]" page will provide you with a list of some of the things you can do with the tools.

Getting Started - Revision history

Okapifra: /* Check the Requirements */

Ysavourel at 02:50, 5 June 2016

Ysavourel: 1 revision imported

Ysavourel: /* Installing the Tools */