Skip to main content

Rigi Documentation

Align mode

In this mode, uploading target files with translations is followed by an alignment. This mode is used only in some specific cases.

Example 27. Use case

Developers have implemented a new feature and uploaded the new source files to Rigi. The new strings have the Untranslated status in all target languages. The developers now pre-translate (using machine translations) newly added strings in their environment and use Rigi to review them. In this case, the Align mode allows them to upload target files with machine-translated strings and align the untranslated strings in Rigi with translations from the mashine-translated files.


Parameters:

  • -url

    • Description: The URL of the project on the Rigi server.

    • Type: String.

    • Example: -url https://xyz.rigi.io/projects/123.

  • -username/password/token

    • Description: Credentials for accessing the Rigi server.

    • Type: String.

    • Examples: -username your_username, -password your_password or -token your_token.

  • -targetfiles

    • Description: The path to the text file in which each line contains a file path to the file that must be uploaded to the workspace. The file path can be a relative file path with respect to this file or an absolute path. The files will be added to the workspace but not assigned with a fileID.

    • Type: String.

    • Example: -targetfiles targets.txt

  • -locales

    • Description: A comma-separated list of locales (e.g. de-DE, nl-NL) for which an alignment must be performed. If this parameters is omitted, all locales will be aligned.

    • Type: Comma-separated list.

    • Example: -locales de-DE,ja-JP.

  • -cleanup

    • Description: Removes all unassigned files from the workspace before adding the new files that are uploaded with this call.

    • Type: Flag.

    • Example: -cleanup.

    • Default: false.

  • -alignstate

    • Description: The state that will be assigned to the target strings after the alignment.

    • Possible values (case-insensitive): Untranslated, Translated, Reviewed, Validated.

    • Example: -alignstate Translated.

    • Default: Translated.

  • -replacestates

    • Description: Strings that match one of the listed states will be overwritten during the alignment.

    • Type: Comma-separated list of states.

    • Possible values (case-insensitive): Untranslated, Translated, Reviewed, Validated.

    • Example: -replacestates Untranslated,Translated.

    • Default: Untranslated.

In this section: