Skip to content
PhraseApp Plugin for Android Studio
Java
Branch: master
Clone or download
Latest commit 0bdd38f Jan 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea APIResourceModel: refactor Jun 6, 2016
lib cleaned up project files Nov 3, 2015
resources Bump version Apr 6, 2018
src/com/phraseapp Docs update (#16) Nov 13, 2018
.gitignore cleaned up project files Nov 3, 2015
CODEOWNERS Add CODEOWNERS file Jan 18, 2019
DEV.md added notice on setting the java target version Nov 10, 2015
LICENSE Update LICENSE Jun 20, 2016
PhraseApp.iml APIResourceModel: refactor Jun 6, 2016
README.md Docs update (#16) Nov 13, 2018
generate_config.png improved readme Jan 4, 2016
toolwindow.png improved readme Jan 4, 2016

README.md

Phrase-AndroidStudio

Phrase-AndroidStudio is a plugin for Android Studio, the official Android IDE from Google.

PhraseApp

PhraseApp helps you manage translations. With this plugin it is integrated tightly into Android Studio. Read more about Android app localization and PhraseApp integration in our blog post.

Download and Installation

Go to the plugin settings page (File > Settings > Plugins on Windows and Linux, Android Studio > Preferences... > Plugins on MacOS X). You can either install it using the repository browser, or manually download it and then use the Install plugin from disk... button. After a restart of Android Studio the plugin is ready for configuration.

Configuration

The plugin relies on the PhraseApp CLI client, i.e. it must be installed first. The client path (the location the binary is found at) must be specified in the Tools > PhraseApp settings (or preferences on MacOS X) dialog. This dialog will try to determine the path using some heuristics, but it might be necessary to specify the path manually.

Besides client path configuration each project needs a configuration, too. A basic configuration can be generated using the Tools > PhraseApp > Create Config dialog (it will pop up automatically if any action requiring the configuration is triggered, but it wasn't created yet). The following values must be specified:

  • The Access Token: This can be generated in your account and must be specified here.
  • The project to use: After the Access Token was specified the project list will be updated. If there is no project in your account one can be generated automatically (named after the Android Studio project).
  • The key's locale: The locale the keys are in your project are in.

PhraseApp configuration generation for Android

You can of course create your own file, or modify the generated one to your needs. For more information on the configuration file check out this documentation page.

Usage

There are two major actions the plugin can be used for:

  • Pushing the current keys file to PhraseApp.
  • Pulling the translations from PhraseApp to your project.

Both are accessible from the menubar (under Tools -> PhraseApp) and the tool window (located to the right of the editor window).

PhraseApp Android Studio tool window

Valid locale files (named strings.xml) can be manually uploaded from the respective context menu in the project view.

You can’t perform that action at this time.