FAQ - Revision history

Ctingley: Update links to gitlab

2024-10-06T23:49:31Z

Update links to gitlab

← Older revision		Revision as of 19:49, 6 October 2024
Line 103:		Line 103:
	====Getting set up====		====Getting set up====

	* Check out the source code from ~~Bitbucket~~ using git clone: https://~~bitbucket~~.~~org~~/okapiframework/~~okapi~~		* Check out the source code from GitLab using git clone: https://gitlab.com/okapiframework/Okapi
	* Or, if you want to submit pull requests, first create a fork of the Okapi project.		* Or, if you want to submit pull requests, first create a fork of the Okapi project.
	* Import into your IDE. For example, in Eclipse go to File > Import > Maven > Existing Maven project.		* Import into your IDE. For example, in Eclipse go to File > Import > Maven > Existing Maven project.
	If you want to keep several distinct Okapi repositories in the same Eclipse workspace (for instance, your fork and the main Okapi project), you need to assign a name template under the "Advanced" section in the first step of the import wizard.		If you want to keep several distinct Okapi repositories in the same Eclipse workspace (for instance, your fork and the main Okapi project), you need to assign a name template under the "Advanced" section in the first step of the import wizard.
	* The "master" branch contains the latest release version. The "dev" branch contains the current work (the "snapshot" in Maven terms).		* The "master" branch contains the latest release version. The "dev" branch contains the current work (the "snapshot" in Maven terms).
	* See also: https://~~bitbucket~~.~~org~~/okapiframework/~~okapi~~/~~wiki~~/How~~%20to%20Contribute~~		* See also: https://gitlab.com/okapiframework/Okapi/-/wikis/How-to-Contribute
	Happy coding!		Happy coding!

Ctingley: Update issues link to gitlab

2024-10-06T23:48:46Z

Update issues link to gitlab

← Older revision		Revision as of 19:48, 6 October 2024
Line 77:		Line 77:
	====How do I report bugs or request enhancement?====		====How do I report bugs or request enhancement?====

	* You can post a bug report or an enhancement request on [https://~~bitbucket~~.~~org~~/okapiframework/~~okapi~~/issues the issues tracking page] if you have a ~~Bitbucket~~ account (preferred).		* You can post a bug report or an enhancement request on [https://gitlab.com/okapiframework/Okapi/-/issues the issues tracking page] if you have a GitLab account (preferred).

	* You can post a message to [https://groups.google.com/g/okapi-users the Okapi users group] if you are part of the group.		* You can post a message to [https://groups.google.com/g/okapi-users the Okapi users group] if you are part of the group.

Dkonovalyenko: /* Is there a users group or a support mailing list? */

2021-10-06T06:56:22Z

Is there a users group or a support mailing list?

← Older revision		Revision as of 02:56, 6 October 2021
Line 72:		Line 72:
	Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:		Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:

	* [~~http://groups.yahoo.com/group/okapitools/~~ https://groups.~~yahoo~~.com/~~group/okapitools~~/] is the group and mailing list '''for the end users'''.		* [https://groups.google.com/g/okapi-users Okapi users] is the group and mailing list '''for the end users'''.
	* [http://groups.google.com/~~group/okapi-devel https://groups.google.com/group~~/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.		* [http://groups.google.com/g/okapi-devel Okapi developers] is the group and mailing list '''for the developers''' working on the source code.

	====How do I report bugs or request enhancement?====		====How do I report bugs or request enhancement?====

Dkonovalyenko: /* How do I report bugs or request enhancement? */

2021-10-06T06:51:13Z

How do I report bugs or request enhancement?

← Older revision		Revision as of 02:51, 6 October 2021
Line 77:		Line 77:
	====How do I report bugs or request enhancement?====		====How do I report bugs or request enhancement?====

	* You can post a bug report or an enhancement request ~~in the issues tracking page: http~~://~~code~~.~~google.com~~/p/okapi/issues~~/entry~~ if you have a ~~Google~~ account.		* You can post a bug report or an enhancement request on [https://bitbucket.org/okapiframework/okapi/issues the issues tracking page] if you have a Bitbucket account (preferred).

	* You can post a message to ~~the~~ [~~http~~://groups.~~yahoo~~.com/~~group/okapitools~~/ Okapi ~~Tools~~ users group] if you are part of the group.		* You can post a message to [https://groups.google.com/g/okapi-users the Okapi users group] if you are part of the group.

	* You can just [mailto:okapitools@opentag.com&subject=Feedback send feedback by email].		* You can just [mailto:okapitools@opentag.com&subject=Feedback send feedback by email].

Kuro: Fixing Yahoo! group URL

2018-05-11T21:48:03Z

Fixing Yahoo! group URL

← Older revision		Revision as of 17:48, 11 May 2018
Line 72:		Line 72:
	Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:		Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:

	* [http://~~tech.~~groups.yahoo.com/group/okapitools/ https://groups.yahoo.com/group/okapitools/] is the group and mailing list '''for the end users'''.		* [http://groups.yahoo.com/group/okapitools/ https://groups.yahoo.com/group/okapitools/] is the group and mailing list '''for the end users'''.
	* [http://groups.google.com/group/okapi-devel https://groups.google.com/group/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.		* [http://groups.google.com/group/okapi-devel https://groups.google.com/group/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.

Line 79:		Line 79:
	* You can post a bug report or an enhancement request in the issues tracking page: http://code.google.com/p/okapi/issues/entry if you have a Google account.		* You can post a bug report or an enhancement request in the issues tracking page: http://code.google.com/p/okapi/issues/entry if you have a Google account.

	* You can post a message to the [http://~~tech.~~groups.yahoo.com/group/okapitools/ Okapi Tools users group] if you are part of the group.		* You can post a message to the [http://groups.yahoo.com/group/okapitools/ Okapi Tools users group] if you are part of the group.

	* You can just [mailto:okapitools@opentag.com&subject=Feedback send feedback by email].		* You can just [mailto:okapitools@opentag.com&subject=Feedback send feedback by email].

Ctingley: /* Is there a users group or a support mailing list? */

2018-05-11T20:40:17Z

Is there a users group or a support mailing list?

← Older revision		Revision as of 16:40, 11 May 2018
Line 72:		Line 72:
	Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:		Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:

	* [http://tech.groups.yahoo.com/group/okapitools/ ~~http~~://~~tech.~~groups.yahoo.com/group/okapitools/] is the group and mailing list '''for the end users'''.		* [http://tech.groups.yahoo.com/group/okapitools/ https://groups.yahoo.com/group/okapitools/] is the group and mailing list '''for the end users'''.
	* [http://groups.google.com/group/okapi-devel ~~http~~://groups.google.com/group/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.		* [http://groups.google.com/group/okapi-devel https://groups.google.com/group/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.

	====How do I report bugs or request enhancement?====		====How do I report bugs or request enhancement?====

Okapifra: /* Licenses */

2017-02-02T22:07:32Z

Licenses

← Older revision		Revision as of 18:07, 2 February 2017
Line 59:		Line 59:
	====Under what licence the Okapi Framework is developed?====		====Under what licence the Okapi Framework is developed?====

	* The source code is under [~~http~~://www.~~gnu~~.org/licenses/~~lgpl~~.~~html GNU Lesser Public~~ Licence ~~(LGPL)~~].		* The source code is under [https://www.apache.org/licenses/LICENSE-2.0 Apache Licence version 2.0].
	* The documentation is under [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike License (CC-BY-SA)].		* The documentation is under [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike License (CC-BY-SA)].

	====Can I use Okapi's components in my applications?====		====Can I use Okapi's components in my applications?====

	Yes. The project uses the ~~LGPL~~ license which allows open-source or commercial products to use our applications and components. See more information ~~on LGPL~~ at [~~http~~://www.~~gnu~~.org/licenses/~~lgpl.html http://www.gnu.org/licenses/lgpl~~.~~html~~].		Yes. The project uses the Apache license which allows open-source or commercial products to use our applications and components. See more information the license at [https://www.apache.org/licenses/LICENSE-2.0].

	==Support==		==Support==

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: /* For developers */

2016-05-11T12:43:11Z

For developers

New page

==Capabilities==

====What formats are supported?====

The framework offers filters for many file formats, including XML, XLIFF, TMX, HTML, DOCX, ODT, Properties, PO, and many more.<br>
For a more complete list of the supported formats, see the "[[Filters]]" page.

Note that you can also create your own filter configurations to support some formats. You can also create your own filters and use them seamlessly with the Okapi tools.

====How do I extract text for translation?====

See the article "[[How to Extract Text for Translation]]" in the [[Knowledge Base]].

====Does Okapi provide a translation editor?====

Not at this time. The Okapi tools allow you to create translation packages in various formats that can be opened in different translation editors such as OmegaT, MemoQ, Trados Workbench, Swordfish, Wordfast, etc.

For translating XLIFF files see: "[[How to Translate XLIFF Documents]]".

====Does Okapi provide a TM (Translation Memory)?====

Yes. There are currently two TM engines implemented in the framework:

* [[Pensieve TM]] is the main TM engine.
* [[SimpleTM TM]] is a limited and older engine that '''is being progressively phased out'''.

You can also use third-part TM engines through the the different [[Connectors|connectors]] that the framework provides. For example: the [[Translate Toolkit TM Connector|Translate Toolkit TM]], [[GlobalSight TM Connector|GlobalSight TM]], the [[OpenTran Translation Repository Connector|OpenTran Translation Repository]], [[MyMemory TM Connector|MyMemory]], etc. For a complete list and more details see the "[[Connectors]]" page.

====Does Okapi provide a MT (Machine Translation) system?====

Not at this time. But you can use different third-party MT system using one of the connectors distributed with the framework. For example you can work with [[Google MT v2 Connector|Google MT]], [[Apertium MT Connector|Apertium MT]], [[Microsoft Translator Connector|Microsoft Translator]], etc. For a complete list, see the [[Connectors|Connectors page]].

====Why is there several distributions, isn't Java cross-platform?====

Yes, Java is cross-platform, and most of the Okapi code runs anywhere Java runs.
However, for a better internationalization support and a more seamless integration with each platform, we have selected to use Eclipse SWT (http://www.eclipse.org/swt) as the foundation for the UI of our applications. That library requires a different distribution for each platform and architecture.

Okapi's source code has been carefully designed to separate UI-dependant code and non-UI code, so most of the components (such as the [[Filters]], the [[Steps]] and the [[Connectors]]) can be used on any platform.

====Can I change the Java VM settings when running the tools?====

Yes. See [[How to Change the Java Parameters for Rainbow]]. You can follow the same steps for all Okapi tools.

==Simple Troubleshooting==

====Is there a Getting Started guide?====

Yes. See the "[[Getting Started]]" page.

====When I try to start Rainbow/Ratel/CheckMate nothing happens. What is wrong?====

* Check that you have the proper version of Java (1.7 or above).
* Make sure you have installed the correct distribution for your platform.
* If your machine is 32-bit make sure to have installed the 32-bit distribution.
* If your machine is 64-bit make sure to have installed the 64-bit distribution.

==Licenses==

====Under what licence the Okapi Framework is developed?====

* The source code is under [http://www.gnu.org/licenses/lgpl.html GNU Lesser Public Licence (LGPL)].
* The documentation is under [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike License (CC-BY-SA)].

====Can I use Okapi's components in my applications?====

Yes. The project uses the LGPL license which allows open-source or commercial products to use our applications and components. See more information on LGPL at [http://www.gnu.org/licenses/lgpl.html http://www.gnu.org/licenses/lgpl.html].

==Support==

====Is there a users group or a support mailing list?====

Yes. There are two main mailing lists. Both have public archives, and both require registration to post a message:

* [http://tech.groups.yahoo.com/group/okapitools/ http://tech.groups.yahoo.com/group/okapitools/] is the group and mailing list '''for the end users'''.
* [http://groups.google.com/group/okapi-devel http://groups.google.com/group/okapi-devel] is the group and mailing list '''for the developers''' working on the source code.

====How do I report bugs or request enhancement?====

* You can post a bug report or an enhancement request in the issues tracking page: http://code.google.com/p/okapi/issues/entry if you have a Google account.

* You can post a message to the [http://tech.groups.yahoo.com/group/okapitools/ Okapi Tools users group] if you are part of the group.

* You can just [mailto:okapitools@opentag.com&subject=Feedback send feedback by email].

==Miscellaneous==

====What does 'Okapi' mean?====

An okapi is an African animal looking somewhat like [http://en.wikipedia.org/wiki/Okapi a cross between a zebra and a giraffe]. Okapi is pronounced [http://en.wikipedia.org/wiki/Wikipedia:IPA_for_English /oʊˈkɑːpɪ/] ([http://www.m-w.com/cgi-bin/audio.pl?okapi001.wav=okapi hear it])

The usage of this name for the framework has its roots to much older projects. At some point it was an acronym for "Open Kit API".

====What happened to the .NET Okapi?====

The older version of the Okapi Framework for .NET is no longer developed. Its distribution and source code is still available here: http://sourceforge.net/projects/okapi/. All new development is now done in the Java branch.

====Where is Olifant?====

Olifant, the TMX editor, is currently only part of the .NET Okapi. It is still available [http://sourceforge.net/projects/okapi/files/ from the SourceForge project]. Note that Olifant is for Windows only.

==For developers==

====Getting set up====

* Check out the source code from Bitbucket using git clone: https://bitbucket.org/okapiframework/okapi
* Or, if you want to submit pull requests, first create a fork of the Okapi project.
* Import into your IDE. For example, in Eclipse go to File > Import > Maven > Existing Maven project.
If you want to keep several distinct Okapi repositories in the same Eclipse workspace (for instance, your fork and the main Okapi project), you need to assign a name template under the "Advanced" section in the first step of the import wizard.
* The "master" branch contains the latest release version. The "dev" branch contains the current work (the "snapshot" in Maven terms).
* See also: https://bitbucket.org/okapiframework/okapi/wiki/How%20to%20Contribute
Happy coding!

====How to build okapi-lib locally====

The Okapi Framework consists of Maven projects. However, in order to build the apps and lib projects locally, you need to use the Ant build configurations.

For instance, to create a local version of okapi-lib.jar, go to <OKAPI_HOME>/deployment/maven/ and run ant -f build_okapi-lib.xml init okapiLib. The jar will be generated in <OKAPI_HOME>/deployment/maven/dist_common/lib/.

If you use the default build.xml by running above command without the -f option, platform-specific distributions of the apps will be created plus the platform-indipendent okapi-lib.jar.