Developer guides
Overview
Rigi is a tool that integrates app localization into the development process by offering a convenient way to manage files that need localization and HTML previews that allow translating in context.
From the developers' point of view, the localization process in Rigi consists of the following stages:
Developers upload the source resource files (e.g., JSON files) that need to be localized from the code repository to the project on the Rigi server.
HTML previews are captured using the tokenized language to provide context for localization.
The app texts are translated and reviewed in context, thanks to the captured previews.
Target resource files with the correct filenames are downloaded to the correct location. From here, they can be merged into the code repository via a pull request.
Therefore, to localize an app in Rigi, developers perform the following actions:
Create a project on the Rigi server (for details, see the Create a project guide).
Set up a workspace:
From the repository, upload (import) the source resource files that need to be translated to the Rigi project (for details, see the Upload files to the workspace guide).
Rigi supports many file formats (for details, see the File formats article).
Assign and configure parser settings (for details, see the Configure parser settings guide).
Configure target rules (for details, see the Configure target rules guide).
Prepare your staging application.
For example, to capture HTML previews of web applications, you need to install a language with Rigi tokens:
Download files with Rigi tokens (for details, see the Rigi tokens guide).
Install a language pack with Rigi tokens in your app using the stage server (for details, see the Prepare a staging server with Rigi tokens guide).
Install the Chrome extension or include the script directly in your code (for details, see the Include RigiJS in your application guide).
Test and refine (for details, see the Test the deployment of Rigi tokens to a staging server guide).
(Optional) Perform the I18n testing.
Capture HTML previews to provide context for localization. Previews can be captured manually, semiautomatically, or as a part of automated UI testing.
For web apps, Rigi has developed a script to capture HTML previews of the application's live pages. The captured previews are self-contained and include the DOM, CSS, images, fonts, etc. (for details, see the Capture HTML previews for web applications guide). Rigi identifies the translatable texts via the installed Rigi tokens.
For iOS mobile apps, use the Rigi SDK tool (for details, see the Capture HTML previews for iOS mobile apps guide).
For WPF and other types of apps, use the Rigi WebSnap tool (for details, see the Capture HTML previews for WPF applications guide).
The project manager then handles the UI text localization. This includes source text editing, translating in context, in-country reviewing, and post-review corrections.
Download target resource files and commit or merge them to the code repository.
The steps above can be repeated when developers add new features.
Rigi CLI tool
Use the CLI tool to automatically exchange resource files between your code repository and the project on the Rigi server. For details, see the Rigi CLI tool guides.