resamsel / translatr

I18n Translation Management

Translatr

A modern and intuitive i18n tool. Translatr simplifies i18n for developers and translators. It uses the Play Framework to translate other projects. Importing conf/messages.locale (Play Framework), src/main/resources/messages_locale.properties (Java properties), and i18n/locale/main.po (Gettext) files allows easy locale management.

Demo

Speeds up development

Preview, quick switching between locales, and the possibility of build system integration allows faster development.

User experience focused

Using the application should feel as comfortable as possible because of focusing on both main use cases - development and translation.

Easy to work with

All elements - search, content creation, ... - follow the concepts of Material Design to allow the easiest and most intuitive usage possible.

Command Line Interface

The Command Line Interface allows managing translations through the command line. Operations can be used in build scripts to automatically retrieve the latest translations.

Installation

Paste this at a terminal prompt:

curl -fsSL https://raw.githubusercontent.com/resamsel/translatr/main/install.sh | bash

Usage

To use Translatr CLI we need a .translatr.yml config file. Create one in any directory that you want to enable the CLI. The Translatr CLI will then use that file as configuration.

Creating a config file is easy with version 3. On the project page, scroll down to the CLI Integration card. You'll find a sample file, along with the option of choosing the file type and the access token.

Pushing

By pushing you send the matching messages files to the given endpoint, creating locales if needed.

translatr push

This will overwrite all existing messages, if any. No existing keys/locales will be removed, this is not a sync operation.

Pulling

By pulling you download all locales into separate files into the configured files (translatr.pull.target key).

translatr pull

This will overwrite any existing files locally. All known locales will be downloaded.

Development and Contributing

Information about contributing to this project can be found on the CONTRIBUTING page.

Resources

SVG Icons from: https://www.svgrepo.com/collection/soft-colored-ui-icons/

translatr's Issues

Exception when creating a locale with a long name

Creating a locale with a name longer than 15 characters leads to an exception. Validation should be added to create and edit project/locale/key.

Make dashboard button a FAB on frontpage

Make it more Material Design style.

Allow using the API without access_token

The API should be allowed to use if the session is OK, without giving an access_token. This would allow the GUI to use API methods, instead of copies from that methods in the Application space.

Allow duplication of key

Duplicate key with all messages.

Add install instructions for translatr.py

Instructions need to be put on a separate page.

Installation

Install it like Homebrew (http://brew.sh):

sh < (curl -fsSL https://raw.githubusercontent.com/resamsel/translatr/master/install)

install file contains:

cat > /usr/local/bin/translatr <<EOF
$(contents of translatr.py)
EOF

Usage

First, create a project in the web GUI and copy the project ID (40 character UUID in the URL, i.e. http://localhost:9000/project/6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220 -> project ID: 6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220).

Then put a .translatr.yml file in any directory that you want to enable pulling/pushing. Translatr will then use that file as configuration.

Example .translatr.yml for Play messages

translatr:
  endpoint: http://localhost:9000
  project_id: 6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220
  pull:
    file_type: play_messages
    target: conf/messages.?{locale.name}
  push:
    file_type: play_messages
    target: conf/messages.?{locale.name}

Pushing

By pushing you send the matching messages files to the given endpoint, creating locales if needed.

translatr push

This will overwrite all existing messages, if any. No existing keys/locales will be removed, this is not a sync operation.

Pulling

By pulling you download all locales into separate files into the configured files (translatr.pull.target key).

translatr pull

This will overwrite any existing files locally. All known locales will be downloaded.

Any logged-in user can view any access token

By increasing the ID of the access token any token can be viewed and edited.

Enable exception handling in translatr.py

translatr.py does not handle exceptions well, i.e.:

• .translatr.py missing
• endpoint not available
• project_id invalid
• push/pull configuration invalid

Analysis: Find similar keys

When pushing existing messages the possibility of similar, but not duplicate key names is quite high (human error). Calculating a similarity between key names might help find errors. Merging two keys might be an option as well, which isn't possible at the moment.

Fix header on small screens

November 16, 2016 at 02:58PM

Add support for PO files

Add import/export options for PO files (https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html)

Add wizard for creating a .translatr.yml config file

In any project there should be the option to create a .translatr.yml config file. The form should prepoulate the fields for endpoint (immutable), project_id (immutable), access_token (dropdown, with create option), and project types (Play, Java, Gettext, ...).

Add support for NSDictionary (iOS) translation files

This could be a worthy library:

https://github.com/3breadt/dd-plist

Merging users fails with duplicate key exception

Feed timeline from audit log

Use the audit log table to draw the graph in the project overview tab.

Make project content searchable

Allow searching for either key or locale in project overview.

Any logged-in user can delete a project

Deleting a project needs to be restricted on ProjectRole Owner alone.

Login with Github

Allow authentication using the Github OAuth mechanism and API.

Require API key for CLI

October 19, 2016 at 10:38PM

Combine CSS and JS files

See https://github.com/ground5hark/sbt-concat#sbt-concat and https://www.playframework.com/documentation/2.5.x/AssetsOverview

Add deployment to Heroku

Add config files to allow deployment to Heroku.

Make timeouts and limits configurable

Show raw content of message in editor sidebar

Showing the HTML content might break the page, use $(element).text(value) instead.

Add user roles

Add roles for users:

• Admin - general role, can see all projects
• User (default) - general role
• Owner - role within a project; is allowed to modify the project and add users; implicitly is a developer
• Developer - role within a project, is allowed to modify locales and keys; implicitly is a translator
• Translator - role within a project, is allowed to modify messages

"Add a new key" button not working

On clicking (+) for "Add a new key" the screen is overlayed black and there is no possibility to enter a key or to get back to the page without reloading.

Make project view responsive

The project - locales/keys tabs don't work well on smaller screens (width < 601px).

Add pager to long lists

More button should load more entries.

Add Keycloak as auth provider

Use http://www.keycloak.org/ as an auth provider.

Analysis: Missing messages

Show missing messages compared to other locales in a separate view. This would allow analysis why certain messages are not present in the default locale.

Remove duplicate API methods in web UI

Some methods, like creating and updating messages, are duplicated in application controllers. Those should be removed.

Basically all routes from Application.javascriptRoutes should be replaced with API versions.

Changing a key is not intuitive

The approach to search for the key and to press enter to get to the key edit is not intuitive.

Message editor (locale): selection of locale does not update text field

When in the message editor through locales, copy value does not work and reloads the page.

Fix navigation for small screens

Refactor JavaScript code to core modules

Make dashboard more responsive

Width of projects should be 100% when on a small width device.

Add unit tests

Introduce unit tests and produce a code coverage report.

Allow environment vars in .translatr.yml

Allow the use of environment vars in the config file.

Example:

translatr:
  access_token: ${TRANSLATR_ACCESS_TOKEN}
  ...

Make tables sortable

Let users sort tables by name, last updated, progress.

Any logged-in user can view any project

If the project ID is known, any project can be viewed. Only members should be able to view projects.

Add NProgress progress bar

Make the app more responsive when doing AJAX calls. Use http://ricostacruz.com/nprogress/ to add "a nanoscopic progress bar".

Allow duplication of locale

Duplicate locale with all messages.

Add install instructions for translatr.py

Instructions need to be put on a separate page.

Installation

Install it similar to Homebrew (http://brew.sh):

curl -fsSL https://raw.githubusercontent.com/resamsel/translatr/master/install.sh | bash

install file contains:

# Install location may be overridden by using the TRANSLATR_PREFIX env variable
TRANSLATR_PREFIX=${TRANSLATR_PREFIX:=/usr/local}

cat > $TRANSLATR_PREFIX/bin/translatr <<EOF
$(contents of translatr.py)
EOF

Usage

First, create a project in the web GUI and copy the project ID (40 character UUID in the URL, i.e. http://localhost:9000/project/6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220 -> project ID: 6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220).

Then put a .translatr.yml file in any directory that you want to enable pulling/pushing. Translatr will then use that file as configuration.

Example .translatr.yml for Play messages

translatr:
  endpoint: http://localhost:9000
  project_id: 6f1ee0a7-b5d1-4c7f-8e4d-46c09fece220
  pull:
    file_type: play_messages
    target: conf/messages.?{locale.name}
  push:
    file_type: play_messages
    target: conf/messages.?{locale.name}

Pushing

By pushing you send the matching messages files to the given endpoint, creating locales if needed.

translatr push

This will overwrite all existing messages, if any. No existing keys/locales will be removed, this is not a sync operation.

Pulling

By pulling you download all locales into separate files into the configured files (translatr.pull.target key).

translatr pull

This will overwrite any existing files locally. All known locales will be downloaded.

Anyone can modify locales of a project

The button for adding/removing locales is visible for anyone in the project/locales view. Only users with role Owner or Translator should be allowed to modify locales.

Add notifications

Show what's happening in my projects.

Introduce users

Let users:

• login, logout, register, join with Github
• own projects
• invite others to their project as developer/translator
• see all relevant projects in own dashboard

Allow key/locale creation in search

When no entry could be found, offer a links to create key/locale or even a project.

Anyone can add users to a project

The button for adding members is visible for anyone in the project/members view. Only owners should be allowed to add members.

Returning to front page is not possible in small viewport

Renaming key creates an error

Renaming a key does not work at all.

Make search more predictable

Search works differently on project info and project locales/keys tab. Unify search behaviour.

Make locale/key editor responsive

Does not work well in mobile layout.