Login Start for Free

Applanga Sketch Plugin

A Sketch plugin for translating Sketch files with Applanga.

Version: 2.4.0

Website: https://www.applanga.com

Table of Contents

  1. Installation in Sketch app
  2. Configuration of the Applanga Project and Plugin
  3. Usage
    1. Connection Settings
    2. Uploading content for translation
    3. Translate your Sketch file
    4. Uploading translated screenshots
    5. Uploading translated screenshots for multiple languages
    6. Placeholders Replacement
    7. Inspect & Edit Ids
    8. Check & Align file

Installation in Sketch app

Applanga requires Sketch v54+ to run.

  1. To localize a Sketch file download the latest release of the plugin
  2. Unzip & Double-click on applanga.sketchplugin, this should create a Applanga sub-menu under Plugins in Sketch

Configuration of the Applanga Project and Plugin

For a new project


  1. Create a new project in Applanga Dashboard.
  2. Follow the prompts and select the Sketch integration option.
  3. Copy the Applanga API Token by clicking on the clipboard icon. You will need it to start using the plugin.
  4. Click on "Go to Project" to confirm the configuration (This will automatically whitelist all IPs so you are able to upload Sketch content to the Applanga project using the plugin! If needed, you can remove ::/0 and 0.0.0.0/0 then add your specific IP address. This will allow only you to upload content.)

For an already existing project


  1. Go to Project Settings of the project.
  2. Add ::/0 and 0.0.0.0/0 or the authorized IP addresses in the List of IP's authorized for API upload. This will authorize you to upload Sketch content to the Applanga project using the plugin!
  3. Copy the Applanga API Token by clicking on "Show API key" and then the clipboard icon. You will need it to start using the plugin.
  4. Scroll to the bottom of the Project Settings page and click "Update".

In the Applanga Plugin


  1. If the design file is not yet connected to an Applanga project, the plugin will open on the Connection Settings page
  2. Enter the Applanga Project API Token
  3. Confirm the Applanga Project Name is correct
  4. If your Project has Branching enabled, use Select Branch to configure the Branch that should be used by the plugin for uploads and downloads.
  5. Click Connect to Applanga Project

Back to Top


Usage

 

Connection Settings

  1. Applanga Project API Token: please copy the API Token from your Applanga Project Settings page
  2. Applanga Project Name: corresponds to the entered API token (not editable)
  3. Select Branch: selects a specific Branch to connect to in a Branching Project
  4. Connect to Applanga Project: saves the Connection Settings on your local machine. The selected options are saved separately for each Sketch file and will be loaded next time you open the file on your machine and start the plugin.

Back to Top


Uploading content for translation

Upload Options

  • Project Name: this is set to the Applanga project which the plugin is currently linked via the API token (not editable)
  • Branch Name: this is set to the Applanga project Branch which the plugin is currently linked to (not editable)
  • Select Language: the source language is preselected by default, but you can select any language for upload
  • Upload Scope
    • All Content: All content from the design file is included in the scope of the upload
    • Only Current Page: Only content from the current page is included in the scope of the upload
    • Only Selected Content: Only the content from the selection is included in the scope of the upload
  • Include Text and Include Screenshots: select what should be included in the upload to your Applanga project (by default both options are selected for source language, and only the Screenshots option is selected for target language uploads)
  • Advanced Upload Options:
    • Upload new/missing text: with this option enabled, any text present in the file and not yet on Applanga is uploaded (by default enabled)
    • Merge new duplicated text into a single Applanga string: when this option is enabled during upload, for every text that is not on Applanga yet, all duplicates found in the file for that text are 'merged' into a single new Applanga string Id. If this option is disabled, one string Id is created for each of the duplicate texts (by default enabled)
    • Set status: this option sets a status for all new content uploaded to an Applanga project. To update the status of an already existing string on Applanga, use the Change status option
    • Apply Placeholder Conversion: if development placeholders exist in the Applanga project and the are mapped in the Plugin Placeholders Replacement options, this will convert placeholders on download to the sketch file
    • Merge Sketch text with existing Applanga strings: when this option is enabled during upload, if a entry with the exact same text already exists, the corresponding string Id is applied to the Sketch file instead of generating a new one. If multiple such matching entries exist, one is chosen randomly (by default enabled)
    • Update existing Applanga strings with changes made in Sketch file: when this option is selected, the corresponding entries on Applanga will be overwritten with the content from the Sketch file (by default enabled)
    • Change status: this option changes the status of an already existing string on Applanga.
    • Tag all strings in scope with: to link the strings in scope for the upload with a tag, enable this option and enter a tag name.
    • Exclude untranslatable content: this option will exclude specific types of untranslatable content from upload to the Applanga project. Options for exclusion from upload include only numbers, times and dates, special characters,Lorem ipsum placeholder text, symbols, or single characters.
    • Include Screenshots without Linked Text: if selected, screenshots that couldn't be linked to any text are uploaded to the Applanga project (by default disabled)
    • Include Hidden Content: determines if the hidden (close/open eye icon) content is included in translation scope (by default disabled). Please note, that there may be invisible elements that will be included in scope, because they are invisible for other reasons than the “visible” property status.
    • Include Locked Content: determines if the locked (padlock icon) content is included in translation scope (by default disabled)

 

Important notes!

  • If you want to exclude pages or other elements from the upload, add 3 underscores in front of the element or page name (___).
  • The upload for large files, particularly when screenshot upload is included, may take several minutes.
  • You must whitelist your IPs in the Applanga Project Settings page before you can use the plugin! See the Configuration section for more details.

The Upload button is only active if there is an upload language selected and either the Text or Screenshots option is selected. The Activity log will display the progress indication and error messages.


Back to Top


Renaming String IDs
When new IDs are being created on Applanga as part of the upload, there is the option to manually edit any of those new IDs. The dialog will not display if only screenshots are being uploaded or there are no new strings to upload.

  • Click on the source text, to expand it and display the full text
  • Click on the suggested string ID name to edit it
  • Click Confirm to approve the edits. You can also unconfirm to restore the original ID name. If the Confirm button becomes red, the string ID name is invalid. Most often its a value conflict (the same ID name, but different source text) with an ID that already exists in Applanga or is a duplicate to a newly created ID name. Hover over the button to see a more detailed error message.
  • Only Approved or All (default) determines if all of the texts are to be uploaded to Applanga or only confirmed ones(green checkbox). If any edits are made to the string IDs, only those approved will be included in the upload.

The Upload button starts the upload immediately. During the upload process, an activity log will inform you about the progress and any errors.


Back to Top


Translate your Sketch file

Once translations for your content are available on Applanga, you can use the plugin to download the translations and populate them in your file.

You may prevent any part of your file from being translated by locking or hiding the elements out of scope and/or by limiting the download to specific pages (see Scope below)

Download Options

  • Project Name is set to the connected Applanga project via the API token (not editable)
  • Branch Name: this is set to the Applanga project Branch which the plugin is currently linked to (not editable)
  • Select Language: selects the target language to be downloaded. Please note that the Download button will not be active until a target language is picked (none is selected by default)
  • Refresh: if a language was recently added to the Applanga project, click refresh to access it for plugin download (can take up to 15 minutes for recent translations to become available for download via the plugin)
  • Mode determines if target translation values or draft translation values are downloaded and populate (by default Target plus Draft will be populated)
  • Scope determines if the whole file is processed or only the currently open page (by default all content is in scope)
  • Overwrite Hidden Content determines if the hidden (close/open eye icon) content is included in scope (by default excluded)
  • Overwrite Locked Content determines if the locked (padlock icon) content is included in scope (by default excluded)
  • Merge Sketch text with existing Applanga strings allows the linking of text in Sketch missing Applanga Ids to an existing Applanga string Id in the connected Applanga project. Please note, the text matching to the source text in Applanga project may not work or may give false positives if the file is (partially) translated.
  • Applanga Placeholder Conversion converts development placeholders as found in Applanga to the mapped text as set in the Plugin Placeholders Replacement options

Important notes!

  • Please be aware that translation download for very large files may take several minutes.
  • Note that any content that has 3 underscore characters (___) at the beginning of the element or page name is excluded from the scope.
  • The translation download will overwrite the source text in your file. It is recommended to create a copy of the file for the translation process. You can also revert back to your starting point by selecting your source language and downloading it again.
  • It may take up to 10 minutes before changes made to translations on the Applanga dashboard are available for download.

The Download button starts the download immediately. The button is only active if there is a download language selected. During the download process, an activity log will inform you about the progress and any errors.


Back to Top


Uploading translated screenshots

If you want to upload screenshots of your translated Sketch file back to Applanga, for example, if you want somebody to review the translation in-context, please follow these steps:

  1. Go to Download and select a language, run the download process.
  2. After the download is finished, go to Upload and select the language again but make sure that you only select Screenshots in the upload options

Back to Top


Uploading Translated Screenshots for multiple languages at once

The Batch Screenshot Upload option can be used to start an automated process that will, step by step, download translations for a language, take screenshots of the translated Sketch design, and upload the translated screenshots back to Applanga for all languages selected one after the other automatically.

In order to upload translated screenshots for multiple languages at once, in the plugin UI, choose the Batch Screenshot Upload option. In the subsection of the Batch option, you can select which languages to include (all or everything but source), which set of strings (Draft or Target), and which layers (all or only the currently selected one) will be in scope for the batch process.


Back to Top


Placeholders Replacement

When transferring text from design files into app strings on Applanga, it is often necessary to add certain variables or placeholders to the text so it is usable in the app (e.g. replace numbers, counters, dates, time, etc with placeholders such as %d, %s, etc)

However, these variables in the text will appear in the design files which interferes with the ability to match the design to the app 1:1

The Placeholders Replacement option acts as a placeholder conversion. It allows plugin users to replace any variable found in the app's text with a predefined text element. For example, with a mapping of “%d” to “5”, the string “Lisa bought the %d apples” would appear as “Lisa bought the {5} apples” in the design file.

Replaced/Converted placeholders in the design file are written inside curly brackets {} to prevent any accidental edits to these text fields.

  1. Enter the placeholder text (e.g. %d) as found in the app strings to the Placeholder column in the plugin
  2. Enter the desired text (e.g. 5) the placeholder should be replaced with on download in the Replacement Text column
  3. Click the Checkmark to save this conversion and add more
  4. Click Save to save all mapped Placeholder Replacements

Back to Top


Inspect and Edit Ids

Inspect & Edit Ids allows users to view the Applanga string Ids connected to specific text in the respective design file. Users can also create new strings Ids by removing the current Id and setting a new one via the plugin.

  1. Select the element of the design file to display string Ids in the plugin
  2. Click on the String Id text field to edit the string Id, then select the checkmark to approve for upload (if an Id already exists for a given text on Applanga, users can search and apply that specific Id)
  3. Once Ids are updated, click Upload

Important Notes!

  • Due to a 10-minute CDN delay, recently uploaded or changed string Ids may not display in the plugin and return a message of “No Id set yet.” Please allow 10 minutes for the cache to update and try again.
  • Screenshots are not automatically uploaded with strings when using the Inspect & Edit Ids option. Users can manually assign strings on the Applanga dashboard using the screens tag. See the tags page for more info.

Back to Top


Check and Align File

Check/Fix File Options

  • Link Sketch text with existing Applanga IDs: this option tries to match the text in the file with existing Applanga IDs. It's similar to Merge Sketch text with existing Applanga strings in download options, but is not limited to selections.
  • Remove all linking to Applanga IDs: this option allows users to unlink Applanga string IDs from a previously uploaded Sketch file. When users upload a previously Applanga-integrated file to a new project, the existing Applanga IDs can cause issues with the upload to the new project. This option prevents issues with both uploading and downloading content from Applanga.
  • Migrate IDs to new plugin version: Applanga plugin update from version 1.* to 2.* changed how string IDs are stored; this option will migrate this string Id storage method if you have previously uploaded the same Sketch project with the Version 1.* plugin. This migration will not happen automatically during the upload or download process.

Back to Top