Skip to content

Latest commit

 

History

History
221 lines (147 loc) · 9 KB

README.md

File metadata and controls

221 lines (147 loc) · 9 KB
Raw

Crowdin Android Studio Plugin Tweet

This plugin lets you integrate your Android project with Crowdin. It enables you to upload new source strings to the system instantly as well as download translations or source strings from your Crowdin project.

Also, it allows you to track your Crowdin project translation and proofreading progress directly from the IDE 💻

The plugin is compatible with all the JetBrains IDE's such as PHPStorm, IntelliJ Idea and other 🚀

Status

Build Status JetBrains IntelliJ plugins JetBrains IntelliJ Plugins GitHub

Azure DevOps tests (branch) codecov

Getting started

  • Install plugin via JetBrains Plugin repository.
  • Plugin automatically detects the file with sources strings. If changed, the file will be updated in Crowdin itself.
  • Source file can also be manually uploaded to Crowdin via menu Tools > Crowdin > Upload Sources or just select Upload to Crowdin option using the Right Mouse clicking on the file.
  • To upload translations use menu Tools > Crowdin > Upload Translations.
  • To download translations use menu Tools > Crowdin > Download Translations.

Configuration

Credentials

To start using this plugin, create a file with project credentials named crowdin.properties in the root directory of the project.

project-id=your-project-identifier
api-token=your-api-token

project-id - This is a project numeric id

api-token - This is a personal access token. Can be generated in your Account Settings

If you are using Crowdin Enterprise, you also need to specify base-url:

base-url=https://{organization-name}.crowdin.com

Also, you could load the credentials from environment variables:

project-id-env=CROWDIN_PROJECT_ID
api-token-env=CROWDIN_TOKEN
base-url-env=CROWDIN_BASE_URL

If mixed, project-id, api-token and base-url are prioritized:

project-id-env=CROWDIN_PROJECT_ID                   # Low priority
api-token-env=CROWDIN_TOKEN                         # Low priority
base-url-env=CROWDIN_URL                            # Low priority
project-id=your-project-identifier                  # High priority
api-token=your-api-token                            # High priority
base-url=https://{organization-name}.crowdin.com    # High priority

Source files and translations

Default behaviour

By default, plugin searches for a source file by **/values/strings.xml pattern, and for translation files by /values-%android_code%/%original_file_name% pattern.

sources parameter

If there are multiple source files in the same values directory, or if source file has a different name, it can be specified in sources parameter:

sources=file1.xml, file2.xml

By default, plugin works as if sources parameter were specified like this:

sources=strings.xml

For such a parameter, the passed names are substituted into the **/values/<source_file> pattern, while for translations the pattern remains standard – /values-%android_code%/%original_file_name%.

files.#.(source|translation) parameters

For more flexibility, there is files.# parameter.

files.source=/values/*.xml
files.translation=/values-%android_code%/%original_file_name%

files.1.source=/another/path/*.xml
files.1.translation=/another/path-%android_code%/%original_file_name%

Example of having multiple source files with the same name:

preserve-hierarchy=true

files.source=**/values/strings.xml
files.translation=/values-%two_letters_code%/%original_file_name%

files.1.source=app/src/main/res/values/file.xml
files.1.translation=app/src/main/res/values-%android_code%/%original_file_name%
files.2.source=ext/src/main/res/values/file.xml
files.2.translation=ext/src/main/res/values-%android_code%/%original_file_name%

Note: Both .source and .translation parts should be specified

Note: If preserve-hierarchy is set to true, plugin adds path to your translation pattern.

preserve-hierarchy=true

files.source=**/values/strings.xml
files.translation=/values-%two_letters_code%/%original_file_name% #CORRECT
# this will be transformed to 'app/src/main/res/values-%two_letter_code%/%original_file_name%' export pattern for each file

Placeholders

See the Placeholders article to put appropriate variables.

Note: %android_code% placeholder means a format such as 'fr-rCA' (<ISO 639-1> -r<ISO 3166-1-alpha-2>). When applying format with only two-letter language code such as 'fr'(<ISO 639-1>) format, use %two_letters_code% placeholder.

Note: Currently %original_path% placeholder is not supported.

Additional options

For Android Studio projects that use a git VCS, the plugin will automatically create corresponding branches in Crowdin. If you do not use branches feature in Crowdin, use disable-branches parameter:

disable-branches=true

To prevent automatic file upload to Crowdin use auto-upload:

auto-upload=false

If your project contains multiple modules you want to localize with the same source files naming you need to use the following option:

preserve-hierarchy=true

To attach labels to the uploaded strings use labels:

labels= main-menu, application 
# Applies to default behavior, `sources' parameter 
# and all filegroups that do not have such a configuration

files.1.labels=help-menu   # For a specific filegroup, high priority
files.2.labels=android     # For a specific filegroup, high priority

To specify excluded target languages use excluded-target-languages:

excluded-target-languages= uk, fr
# Applies to default behavior, `sources` parameter 
# and all filegroups that do not have such a configuration

files.1.excluded-target-languages=uk   # For a specific filegroup, high priority
files.2.excluded-target-languages=fr   # For a specific filegroup, high priority

Strings autocompletion

This plugin also provide autocompletion of Crowdin strings keys. It helps to enter correct string key.

By default, this autocompletion feature will be enabled in all files. But you can configure files extensions where it should work:

completion-file-extensions=json,xml

Or to completely turn off this feature:

completion-disabled=true

Seeking Assistance

If you find any problems or would like to suggest a feature, please read the How can I contribute section in our contributing guidelines.

Need help working with Crowdin Android Studio Plugin or have any questions? Contact Customer Success Service.

Contributing

If you want to contribute please read the Contributing guidelines.

Authors

License

The Crowdin Android Studio Plugin is licensed under the MIT License. 
See the LICENSE.md file distributed with this work for additional 
information regarding copyright ownership.

Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.