| Category | Import Converter |
|---|---|
Purpose | Enables Translate5 to import other file formats as just bilingual files. |
Bootstrap Class | editor_Plugins_Okapi_Init |
| Type | Core plug-in (delivered with translate5 core) |
Description
The Okapi plugin enables you to use Okapi Longhorn REST server for converting native source file formats like MS Office 2007, Indesign, HTML, XML, etc. to Xliff and thus directly import these native file formats in translate5.
The end user of translate5 has no contact with Okapi - everything is handled by translate5 on import and re-export after translation.
Additional installation instructions
Original Documentation: http://okapiframework.org/wiki/index.php?title=Longhorn#Download_and_Installation.
Download okapi from https://bintray.com/okapi/Distribution/Longhorn
Install a tomcat server and get up Okapi there.
# as root: wget https://bintray.com/okapi/Distribution/download_file?file_path=okapi-longhorn_all-platforms_0.35.zip -O okapi-longhorn_all-platforms_0.35.zip unzip okapi-longhorn_all-platforms_0.35.zip sudo apt-get update sudo apt-get install tomcat8 sudo cp okapi-longhorn.war /var/lib/tomcat8/webapps/ sudo systemctl enable tomcat8.service sudo service tomcat8 start
The data directory for Okapi must be created manually (see readme.html from the downloaded zip).
Try to create a Okapi project via the integrated web front-end accessible via the configured Okapi URL (see readme.html, too: {localhost}/okapi-longhorn/okapi-longhorn-sample-js-client.html; see also: http://okapiframework.org/wiki/index.php?title=Longhorn#HTML-Client).
Check the tomcat for messages like:
INFO: The default working directory for Okapi Longhorn will be used, because no other was specified: /usr/share/tomcat7/Okapi-Longhorn-Files
Ensure that the directory mentioned there exists and is writeable for tomcat.
If you get the following errors in the tomcat log file: "net.sf.okapi.common.exceptions.OkapiException: SRX file not found" the reason could be missing rights on the above folder.
chown or chmod 777 the Okapi-Longhorn-Files folder and test the import again.
cd /var/log/tomcat8/ grep "default working directory" catalina.* catalina.out:INFO: The default working directory for Okapi Longhorn will be used, because no other was specified: /usr/share/tomcat8/Okapi-Longhorn-Files cd /usr/share/tomcat8/ ls -al mkdir Okapi-Longhorn-Files chown tomcat8:tomcat8 Okapi-Longhorn-Files/
For Tikal:
- download the Okapi-Apps-Distribution: http://okapiframework.org/wiki/index.php?title=Getting_Started#Download_the_Distribution
- unzip it, .e.g. into /home/[myusername]/bin/okapi/ (=> tikal executable will be: /home/[myusername]/bin/okapi/tikal.sh)
Translate5 Configuration of the Okapi Plug-In
| Config name | Values | Default | Description |
|---|---|---|---|
| runtimeOptions.plugins.Okapi.api.url | string | Url used for Okapi api | |
| runtimeOptions.plugins.Okapi.tikal.executable | string | The absolute path to the tikal executable, no usable default can be given so is empty and must be configured by the user! | |
runtimeOptions.worker.editor_Plugins_Okapi_Worker.maxParallelWorkers | integer | 3 | Max parallel running workers of the Okapi worker |
-- activate plug-in (be careful and watch, if the active plug-ins in the SQL match your needs) UPDATE `Zf_configuration` SET `value` = ["editor_Plugins_NoMissingTargetTerminology_Bootstrap","editor_Plugins_Transit_Bootstrap","editor_Plugins_SegmentStatistics_Bootstrap","editor_Plugins_TermTagger_Bootstrap","editor_Plugins_MatchResource_Init","editor_Plugins_ChangeLog_Init", "editor_Plugins_Okapi_Init"] WHERE `name` = 'runtimeOptions.plugins.active'; -- configure Okapi URL UPDATE `Zf_configuration` SET `value` = "http://localhost:8080/okapi-longhosrn/" WHERE `name` = 'runtimeOptions.plugins.Okapi.api.url';