2022-01-26T09:23:39Z

Mihnita:

In Okapi there is a consistent way to configure both filters, and steps.
And that is by using <code>IParameters</code>

= As a developer =

You can of course do it from code, something like this:

Parameters params = filter.getParameters();
// You have getters and setters
params.setFoo(newFooValue);
params.setBar(newBarValue);

Or you can create a configuration file, store it, and load it using <code>params.load(...)</code>.

And you have both <code>javadoc</code> ([https://okapiframework.org/javadoc/net/sf/okapi/filters/its/Parameters.html for example])
and an IDE to help you.

= As a user =

But what are you supposed to do as a user?

You downloaded the Okapi applications (maybe from [https://okapiframework.org/wiki/ here]
or [https://okapiframework.org/binaries/main/ here]), and you are trying to use them.

There is an easy way to edit parameters using a friendly graphical user interface (gui).<br />
But it might be a bit difficult to find.

== Filters, creating and editing custom configurations ==

For this you need to be able to run the <code>tikal</code> application from command line.<br />
But where can you find it?

It is in the same place with the other Okapi application that you extracted from the zip
when you downloaded.

On Linux and macos you need to run <code>tikal.sh</code>, on Windows <code>tikal.exe</code><br />
(so every time you see “run tikal” it means that you need to use the proper file extension)

From command line run

tikal -e

This will open a GUI window with a list of all the filters, including configurations.

[[File:tikal_e.png|627px]]

Select an existing filter and configuration that you want to start with,
then click “Create…”.

You will be asked for a name:

[[File:tikal_create_cfg.png|323px]]

A new window will open, allowing the friendly editing of all the parameters for that filter.

[[File:tikal_edit_cfg.png|496px]]

The result will be saved in a configuration file, with the extension <code>.fprm</code>, and the name
starting with the filter ID.<br />
For example <code>okf_html@my_custom_cfg.fprm</code>

That is a file you can share, store, backup, etc.

If you want to edit the configuration file later on, you can either use
a text editor (dangerous), or open it again in <code>tikal</code> and edit using the GUI.

So, from command line run

tikal -e -fc <config_file>

With the example above

tikal -e -fc okf_html@my_custom_cfg

[[File:tikal_modify_existing_cfg.png|627px]]

Or you can run <code>tikal -e</code>.

The custom configuration will show in the list, and you can
“Edit…” / “Create…” / “Delete…” it.

[[File:tikal_e_custom_cfg.png|627px]]

You can now use the configuration with <code>tikal</code>, for all the steps that take a <code>-fc</code> parameter.

For example extract:

tikal -x -fc okf_html@my_custom_cfg <file_to_extract>

and then merge:

tikal -m -fc okf_html@my_custom_cfg <xliff_file_to_merge>

Similar for all the others options.<br />
Just run <code>tikal</code> (or <code>tikal.sh</code>) without any arguments to see the up to date usage.

[[File:tikal_usage.png|895px]]

== Steps, configuring them ==

Start the Rainbow application, then create a pipeline

[[File:rainbow_edit_pipeline.png|627px]]

Click the “Add Step…” button, and select a step (the one you want to configure)

[[File:rainbow_pipeline_add_step.png|597px]]

You will get a GUI dialog where you can edit the parameters:

[[File:rainbow_edit_step.png|597px]]

You can then save the pipeline (which you can of course load):

[[File:rainbow_save_pipeline.png|597px]]

The file is saved with a <code>.pln</code> extension.

== Content examples ==

If you want to “live dangerously” you can edit the configuration files using any text editor.

The Filter parameters are documented at “[[Filters]]”.

The Steps parameters are also documented at “[[Steps]]”.

But there is no 100% that the pages are up to date.<br />
We try, but we are not perfect :-)

This is an example of what a filter configuration file looks like:

[[File:fprm_content.png|627px]]

And this is an example of what a pipeline file looks like:

[[File:pln_content.png|627px]]

'''Note:''' not all configuration files look the same.<br />
Many use <code>.properties</code> files, but some use an <code>yaml</code> format,
and some use an <code>.xml</code> with [https://www.w3.org/TR/its20/ ITS 2.0 rules].

How to edit Filter and Steps Parameters using GUI

2022-01-26T09:17:30Z

2019-10-27T01:12:51Z

Mihnita: Version release, M38

__NOTOC__
{| border="0" cellspacing="0" cellpadding="0" width="100%"
|-
|colspan="2"|
<div style="margin-bottom: 10px; padding:5px; padding-left:10px; background:#ffffff; border:1px solid #ccc;">
The Okapi Framework is a '''free''', '''open-source''' and '''cross-platform''' set of components and applications designed to help your '''localization''' and '''translation''' processes.<br>
The project uses and promotes '''[[Open Standards|open standards]]''' such as [[XLIFF]], [[TMX]], [[SRX]], [[ITS]] and other formats. It is an [[Open_Standards#OAXAL_1.0_Conformance_Statement|OAXAL 1.0 implementation]].
</div>

|- valign="top"
|
<div style="margin-bottom:10px; margin-right:5px; padding:10px; padding-top:0; background:#ffffdf; border:1px solid #ccc;">
==Users Help and Documentation==
* '''[[Getting Started]]''' — all you need to know to get started using the Okapi tools
* '''[[FAQ]]''' — the answers to some of the most asked questions
* '''[[Online Help]]''' — the applications online help pages
* '''[[Knowledge Base]]''' — various articles on how to work with the Okapi tools
* '''[[Tutorials]]''' — step-by-step tutorials on using the Okapi tools
* '''[[Glossary]]''' — list of the main terms used in the help and documentation
* '''[[Screenshots]]''' — of the applications on different platforms

Additional support:
* '''[https://groups.google.com/forum/#!forum/okapi-users Users Group]''' — users group and mailing list (or '''[http://twitter.com/OkapiFramework follow us on Twitter]''')
* '''[https://bitbucket.org/okapiframework/okapi/issues Bug Report]''' — list of bug reports (Login required to post one)
* '''[https://bitbucket.org/okapiframework/okapi/issues Feature Request]''' — list of feature requests (Login required to post one)
* '''[mailto:okapitools@opentag.com&subject=Feedback Send Feedback]''' — email some feedback (no login required)
</div>

<div style="padding:10px; margin-right:5px; padding-top:0; background:#f9f9ff; border:1px solid #ccc;">

==Applications==
* '''[[Rainbow]]''' — a toolbox to launch a large variety of localization tasks
* '''[[CheckMate]]''' — an application to perform quality checks on bilingual files
* '''[[Tikal]]''' — a command-line tool for basic localization tasks
* '''[[Ratel]]''' — a WYSIWYG editor to create, test and maintain SRX segmentation rules
* '''[[Longhorn]]''' — a batch processing server
* '''[http://github.com/vistatec/ocelot/blob/master/README.md Ocelot]''' — a XLIFF translator/reviewer workbench

==Components==
* '''[[Filters]]''' — extract translatable text from various file formats
* '''[[Steps|Pipelines and Steps]]''' — perform a chain of user-defined tasks on input documents
* '''[[Connectors|Translation Resource Connectors]]''' — provide access to MT, TM, term-bases, etc.
</div>

|
<div style="margin-bottom:10px; margin-left:5px; padding:10px; padding-top:0; background:#dfffe8; border:1px solid #ccc;">
==Downloads — Stable Release ([https://bitbucket.org/okapiframework/okapi/branch/master master branch])==
The latest stable release of Rainbow, CheckMate, Tikal, Ratel, etc. ('''M38 - April 7 2019'''):
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_win32-x86_0.38.zip Windows 32-bit]''' or '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_win32-x86_64_0.38.zip Windows 64-bit]''' — Windows platform
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_gtk2-linux-x86_0.38.zip Linux 32-bit]''' or '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_gtk2-linux-x86_64_0.38.zip Linux 64-bit]''' — Linux platform (gtk2, Intel)
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_cocoa-macosx-x86_64_0.38.dmg Macintosh 64-bit]''' — Macintosh platform (Cocoa, Intel)
* '''[http://dl.bintray.com/okapi/Distribution/okapi-longhorn_all-platforms_0.35.zip Longhorn]''' — batch processing server ([[Longhorn|More information...)]]
* '''[http://dl.bintray.com/okapi/Distribution/okapiFiltersForOmegaT-1.5-m38-dist.zip Plugin for OmegaT]''' — filters plugin for OmegaT ([[Okapi Filters Plugin for OmegaT|More information...)]]
* '''[https://bintray.com/okapi/Distribution/Ocelot Ocelot (v3.0)]''' — XLIFF reviewer workbench ([http://github.com/vistatec/ocelot/blob/master/README.md More information...)]
* '''[http://okapiframework.org/snapshots/changes.html Changes Log]''' — list of the changes between versions
* '''http://bintray.com/okapi/Distribution''' — all downloads
* '''https://search.maven.org/search?q=net.sf.okapi''' — release artifacts on Maven Central

==Downloads — Development Release ([https://bitbucket.org/okapiframework/okapi/branch/dev dev branch])==
For testers and advanced users, the latest development snapshots are here:
* '''http://okapiframework.org/snapshots/changes.html''' — changes between M38 and M39-snapshot
* '''http://okapiframework.org/snapshots''' — snapshots of the distributions build manually
* '''https://oss.sonatype.org/content/repositories/snapshots''' — Maven artifacts snapshots build every midnight ET
</div>

<div style="margin-left:5px; padding:10px; padding-top:0; background:#ffe8bf; border:1px solid #ccc;">

==Developers==
{| style="background:#ffe8bf;"
|- valign="top" padding="0"
|
* '''[https://bitbucket.org/okapiframework/ Project Home]''' at Bitbucket
* '''[http://okapiframework.org/devguide/index.html Developer's Guide]'''
* '''[http://okapiframework.org/javadoc/index.html API Documentation]'''
* '''[http://groups.google.com/group/okapi-devel/ Developers Group and Mailing List]'''    
* '''[https://bitbucket.org/okapiframework/okapi/src Git repository]''' of the source code
|
* '''[https://gitlab.com/okapiframework/okapi/pipelines Continuous Build on GitLab]'''
* List of the '''[https://bitbucket.org/okapiframework/okapi/branch/dev?dest=master Latest Code Changes]''' (dev branch)
* '''[https://bitbucket.org/okapiframework/okapi/wiki/Consultancy Consultancy resources]'''
* '''[https://bitbucket.org/okapiframework/okapi/issues Bugs and Requests]''' tracking list
* Notifications: '''[https://bitbucket.org/okapiframework/okapi/commits/all Commits]''' and '''[http://groups.google.com/group/okapi-builds CB Errors]'''
|}
</div>

|}

Main Page

2019-04-07T18:26:37Z

Mihnita: Release of M37

__NOTOC__
{| border="0" cellspacing="0" cellpadding="0" width="100%"
|-
|colspan="2"|
<div style="margin-bottom: 10px; padding:5px; padding-left:10px; background:#ffffff; border:1px solid #ccc;">
The Okapi Framework is a '''free''', '''open-source''' and '''cross-platform''' set of components and applications designed to help your '''localization''' and '''translation''' processes.<br>
The project uses and promotes '''[[Open Standards|open standards]]''' such as [[XLIFF]], [[TMX]], [[SRX]], [[ITS]] and other formats. It is an [[Open_Standards#OAXAL_1.0_Conformance_Statement|OAXAL 1.0 implementation]].
</div>

|- valign="top"
|
<div style="margin-bottom:10px; margin-right:5px; padding:10px; padding-top:0; background:#ffffdf; border:1px solid #ccc;">
==Users Help and Documentation==
* '''[[Getting Started]]''' — all you need to know to get started using the Okapi tools
* '''[[FAQ]]''' — the answers to some of the most asked questions
* '''[[Online Help]]''' — the applications online help pages
* '''[[Knowledge Base]]''' — various articles on how to work with the Okapi tools
* '''[[Tutorials]]''' — step-by-step tutorials on using the Okapi tools
* '''[[Glossary]]''' — list of the main terms used in the help and documentation
* '''[[Screenshots]]''' — of the applications on different platforms

Additional support:
* '''[https://groups.yahoo.com/neo/groups/okapitools Users Group]''' — users group and mailing list (or '''[http://twitter.com/OkapiFramework follow us on Twitter]''')
* '''[https://bitbucket.org/okapiframework/okapi/issues Bug Report]''' — list of bug reports (Login required to post one)
* '''[https://bitbucket.org/okapiframework/okapi/issues Feature Request]''' — list of feature requests (Login required to post one)
* '''[mailto:okapitools@opentag.com&subject=Feedback Send Feedback]''' — email some feedback (no login required)
</div>

<div style="padding:10px; margin-right:5px; padding-top:0; background:#f9f9ff; border:1px solid #ccc;">

==Applications==
* '''[[Rainbow]]''' — a toolbox to launch a large variety of localization tasks
* '''[[CheckMate]]''' — an application to perform quality checks on bilingual files
* '''[[Tikal]]''' — a command-line tool for basic localization tasks
* '''[[Ratel]]''' — a WYSIWYG editor to create, test and maintain SRX segmentation rules
* '''[[Longhorn]]''' — a batch processing server
* '''[http://github.com/vistatec/ocelot/blob/master/README.md Ocelot]''' — a XLIFF translator/reviewer workbench

==Components==
* '''[[Filters]]''' — extract translatable text from various file formats
* '''[[Steps|Pipelines and Steps]]''' — perform a chain of user-defined tasks on input documents
* '''[[Connectors|Translation Resource Connectors]]''' — provide access to MT, TM, term-bases, etc.
</div>

|
<div style="margin-bottom:10px; margin-left:5px; padding:10px; padding-top:0; background:#dfffe8; border:1px solid #ccc;">
==Downloads — Stable Release ([https://bitbucket.org/okapiframework/okapi/branch/master master branch])==
The latest stable release of Rainbow, CheckMate, Tikal, Ratel, etc. ('''M37 - April 7 2019'''):
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_win32-x86_0.37.zip Windows 32-bit]''' or '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_win32-x86_64_0.37.zip Windows 64-bit]''' — Windows platform
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_gtk2-linux-x86_0.37.zip Linux 32-bit]''' or '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_gtk2-linux-x86_64_0.37.zip Linux 64-bit]''' — Linux platform (gtk2, Intel)
* '''[http://dl.bintray.com/okapi/Distribution/okapi-apps_cocoa-macosx-x86_64_0.37.dmg Macintosh 64-bit]''' — Macintosh platform (Cocoa, Intel)
* '''[http://dl.bintray.com/okapi/Distribution/okapi-longhorn_all-platforms_0.35.zip Longhorn]''' — batch processing server ([[Longhorn|More information...)]]
* '''[http://dl.bintray.com/okapi/Distribution/okapiFiltersForOmegaT-1.5-m37-dist.zip Plugin for OmegaT]''' — filters plugin for OmegaT ([[Okapi Filters Plugin for OmegaT|More information...)]]
* '''[https://bintray.com/okapi/Distribution/Ocelot Ocelot (v3.0)]''' — XLIFF reviewer workbench ([http://github.com/vistatec/ocelot/blob/master/README.md More information...)]
* '''[http://okapiframework.org/snapshots/changes.html Changes Log]''' — list of the changes between versions
* '''http://bintray.com/okapi/Distribution''' — all downloads
* '''https://search.maven.org/search?q=net.sf.okapi''' — release artifacts on Maven Central

==Downloads — Development Release ([https://bitbucket.org/okapiframework/okapi/branch/dev dev branch])==
For testers and advanced users, the latest development snapshots are here:
* '''http://okapiframework.org/snapshots/changes.html''' — changes between M37 and M38-snapshot
* '''http://okapiframework.org/snapshots''' — snapshots of the distributions build manually
* '''https://oss.sonatype.org/content/repositories/snapshots''' — Maven artifacts snapshots build every midnight ET
</div>

<div style="margin-left:5px; padding:10px; padding-top:0; background:#ffe8bf; border:1px solid #ccc;">

==Developers==
{| style="background:#ffe8bf;"
|- valign="top" padding="0"
|
* '''[https://bitbucket.org/okapiframework/ Project Home]''' at Bitbucket
* '''[http://okapiframework.org/devguide/index.html Developer's Guide]'''
* '''[http://okapiframework.org/javadoc/index.html API Documentation]'''
* '''[http://groups.google.com/group/okapi-devel/ Developers Group and Mailing List]'''    
* '''[https://bitbucket.org/okapiframework/okapi/src Git repository]''' of the source code
|
* '''[https://gitlab.com/okapiframework/okapi/pipelines Continuous Build on GitLab]'''
* List of the '''[https://bitbucket.org/okapiframework/okapi/branch/dev?dest=master Latest Code Changes]''' (dev branch)
* '''[https://bitbucket.org/okapiframework/okapi/wiki/Consultancy Consultancy resources]'''
* '''[https://bitbucket.org/okapiframework/okapi/issues Bugs and Requests]''' tracking list
* Notifications: '''[https://bitbucket.org/okapiframework/okapi/commits/all Commits]''' and '''[http://groups.google.com/group/okapi-builds Jenkins Errors]'''
|}
</div>

|}

Tikal - Usage

2012-11-24T23:29:17Z

Mihnita: Added info on -logger and -trace

{{Tikal Common Menu}}
==Running Tikal==

Tikal is a command-line tool. To run it you need to be in a DOS or shell console.

* On Windows you can start a DOS prompt by executing the file named <code>startTikalPrompt.bat</code> that is located in the main directory of the Okapi installation.

* On Linux and Macintosh you need first to open a shell console, then you can use the file <code>tikal.sh</code> that is located in the main directory of the Okapi installation.

Note that if you want to be able to always access Tikal from any prompt, you main have to setup your system so <code>tikal.bat</code> or <code>tikal.sh</code> are in your search path.

There are various commands available:

* [[Tikal - Extraction Commands|Extraction Commands]]
* [[Tikal - Translation Commands|Translation Commands]]
* [[Tikal - Conversion Commands|Conversion Commands]]
* [[Tikal - Miscellaneous Commands|Miscellaneous Commands]]

==Source and Target Languages==

Most commands in Tikal require a source language, a target language or both to be specified. The values of those parameters is computed using the following process:

===Source Language===

: If the option <code>-sl</code> is used:
:: → its value is used as the source language.
: Else:
:: If the input file is in a format where Tikal detects language settings (XLIFF, TMX, TTX, etc.):
::: If a source language is detected:
:::: → that value is used as the source language.
:: If no source language has been set yet:
::: → English (<code>en</code>) is used as the source language.

===Target Language===

: If the option <code>-tl</code> is used:
:: → its value is used as the target language.
: Else:
:: If the input file is in a format where Tikal detects language settings (XLIFF, TMX, TTX, etc.):
::: If a target language is detected:
:::: → that value is used as the target language.
:: If no target language has been set yet:
::: → The language corresponding to the current value of the default locale for the running Java VM is used, except if it is the same as the source language; in that case French (<code>fr</code>) is used as the target language.

==Display Encoding==

In order to display characters properly with Tikal, you must make sure the display encoding of your shell session (e.g. DOS or bash) is the same as the output generated by Tikal.

The default depends on the operating system and may not be guessed correctly in many cases.

The user can override the guess by specifying the encoding to use in Tikal in a configuration file named <code>.Tikal</code> and located in the user's home directory. The system is

displayEncoding=<javaEncodingName>

For example, the following will change the encoding of the Tikal display output to UTF-8:

displayEncoding=UTF-8

Note that changing the display encoding does not affect the encoding of the output files, only the way the string are displayed on the terminal.

==Logging and trace==

You can pass the <code>-logger</code> flag to output all messages to the current logger instead of the console.
Might be pretty noisy, but you have full control by tweaking the logger configuration.
You can find more info on logging here: http://code.google.com/p/okapi/wiki/OkapiLogging.

When passed the <code>-trace</code> flag tikal outputs all debug messages from other components to the console.
This has no effect when the <code>-logger</code> flag is in effect, as the logger gets full control on the output.

==Help and Information==

* Use <code>-?</code> to display the usage screen for Tikal.
* Use <code>-h</code>, <code>-help</code> or <code>--help</code> to display this help page.
* Use <code>-i</code>, <code>-info</code> or <code>--info</code> to version and other information.

Examples:

tikal -?
tikal --help
tikal -info

Note that these three commands preempt any other commands. For example, the following command will only show the usage screen, not extract any file:

tikal -x myFile.html -sl zu -tl eo -?

[[Category:Tikal]]