Getting started

After you sign up to Lokalise, you can familiarize yourself and try a Sample Project or you can start immediately by creating your own project.

Please note: you don't need to verify your email. After registering at Lokalise, you can proceed to your project right away.

Projects page

The projects dashboard shows all the projects you have access to and provides a brief summary for each one:

This summary includes:

  • Project completion – you can track the overall progress here.

  • Base words – the total word count for this project.

  • Keys – the total amount of keys in this project. Keys are unique identifiers that are used for representing text in the code, in files or elsewhere.

  • QA issues – you can click and track any issue that our automatic checker has found. These may be grammar/spelling errors, translation reviewing issues, etc.

Apart from looking at the overall project info, you can track the progress of each relevant language separately.

Start a project

Click the New project button and enter all the necessary details like the project name, description, project type etc.

If you already have an existing project in another translation management system like Phrase or Transifex, it is possible to transfer your project to Lokalise by choosing the Migrate tab.

Invite team members/contributors

In order to invite contributors, open your project and click the Contributors button:

You will then see all the contributors with their names and email addresses. You may filter contributors by the language they can access. You may also search for people with the help of the search form.

There are two possible options for adding more people to a project:

  • Add a contributor by their email address

  • Import contributors from a different project

Add a new contributor by their email

Click the Add people or groups button:

You will see the following dialog box:

In the first tab, you can invite a new user who is not yet a member of your team. To do so, enter their email address, a name, and then assign the necessary roles:

  • Adding an admin – tap the Administrator toggle switch and the user will have the admin rights.  

  • Adding a reviewer – tap the Reviewer toggle switch and the user will be able to review translations.

  • Adding a translator – tap the Administrator and Reviewer toggle switches to off, then choose reference languages and contributable languages. 

After clicking Add, the new contributor will receive a notification email. S/he will be added to the current project and to your team. Please remember that each newly added contributor occupies a team seat, and different subscription plans provide a different number of available seats.

Import contributors from a different project in Lokalise

Click the Import from project button and simply choose one of the projects.

Note that the users that already exist in the current project will be left intact and their permissions won’t be affected. Also, if a user from the chosen source project has permission to access only a specific language, but this language is not present in your current project, then this user won’t be added as a contributor.

Add existing users

In order to add one or more existing users from your team, click the Add people or groups button and switch to the Add existing users tab:

Choose one of the users from the dropdown list and fill in the other fields which are the same as in the Invite new user tab.

User groups

Instead of inviting one user at a time, you can add a group of users. To achieve that, click the Add people or groups button and switch to the User groups tab:

Choose one of more groups from the dropdown and then click Add.

Contributors rights and roles

Each project contributor can be assigned with different roles.

  • Administrator (admin) – has full read and write access to all project languages. Additionally, you can choose what other actions the admin will be able to perform. For example, you can allow or disallow them to upload, download files, or manage contributors.

  • Translator – can read and edit the translations in your project. You can cherry-pick which languages a translator can access.

  • Reviewer – admins and translators can be assigned with a reviewer role. Reviewers are responsible for quality assurance. They are able to mark translations as “reviewed” effectively saying that this translation is correct and can be used in production. This role is only available if you have the reviewing feature enabled in the project settings.

Project editor overview

When opening a specific project, you will be presented with a project editor. You will be using this editor to manage languages, translation keys, create professional translation orders, and perform other actions:

  1. Projects dashboard — lists all projects in the current team you have access to.

  2. Translation orders — request professional translation services.

  3. Checkboxes – select one, multiple or all keys in the list and perform an action on them.

  4. Documentation, API reference, and contact support.

  5. Filter – filter translation keys by various conditions.

  6. Key sorting – for example, sort by first added or last added.

  7. Key and base words counter — shows how many keys and base words are displayed using the current filter(s).

  8. Currently set project branch — this dropdown will become visible if your project has branching feature enabled.

  9. Project translation files.

  10. Display key references as text.

  11. Remember position in project — when enabled, you'll be navigated to the key you were working on previously when re-opening project editor.

  12. Translation memory widget (this feature might be unavailable on your current subscription plan).

  13. Enable displaying placeholders/HTML tags as blocks.

  14. Display spelling and grammar errors.

  15. Filter translation keys by screenshots they are linked to.

  16. Main menu.

  17. Add a new translation key to the project.

  18. Search box — find translation keys by their names or the corresponding translations.

  19. Find and replace.

  20. Project languages — click on these flags to tweak language settings, launch duplicate finder, and more.

  21. Toggle between multilingual and bilingual view.

  22. Magic scroll that helps navigate the keys quickly.

  23. Languages and their translations. Click on the translation text to edit it.

  24. Screenshot linked to the translation key.

  25. Key name, key attributes, and quick actions.

Upload translation files

Lokalise supports an array of iOS, Android, Web, and desktop translation file formats.

To start the uploading process, click the Upload button in the top menu:

Drag and drop your files all together or one by one:

Alternatively you can use our API, CLI tool or GitHub, GitLab, and other integrations to upload the files.

Upload screenshots

Screenshots can be used to provide your translators with additional context. You can link screenshots to the translation keys, and these screenshots will be appear right in the project editor.

To get started with the screenshots, click the corresponding icon in the top menu:

Drag and drop the screenshot files (JPG, PNG) to the drop area.

Lokalise can automatically recognize the text on the screenshots and link the uploaded screenshots to the keys so they show up in the editor. To achieve that, enable the Try to find keys on images option.

The automatic key tagging system is able to recognize the text on the screenshots, if the text meets the following conditions:

  • Only the base language values can be recognized. The supported languages are English, Russian, German, Spanish, Italian, Swedish, Finnish, Turkish, and Polish.

  • Automatic key tagging is able to recognize only existing keys. Please make sure that the key already exists, before trying to link it to the screenshot. 

  • The text must be clearly visible on the screenshots. Depending on the font, background and image quality automatic key tagging may or may not not recognize some strings.

Glossary

Some words should stay the same in all languages. For example, company names. Our Glossary allows you to add any words that require special treatment. Also, there are some words which have more than one meaning. You can add these to glossary too and write a short explanation. To get started with the glossary, click the corresponding icon in the top menu:

Now you can add new entries or manage the existing ones:

Project activity

You can track the all project activity and check what has been done by a specific person in any period of time. To get started, click More > Activity in the main menu:

You will be presented with a list of all the recent events:

These events include translation updates, key modifications, file uploads, and more.

Project statistics

The Statistics module provides you additional insights into your current project translation status. To get started, click on the More button in the top menu and choose Statistics from the dropdown.

You can check:

  • Translations by language 

  • Translations by contributor 

  • Words translated for a selected period 

  • Words translated for all time

Snapshots

Project snapshots are essentially backups. Restoring from a snapshot creates a project copy with all the data, including translations, keys, settings, and contributors.

To manage project snapshots, click on the More button in the top menu, choose Settings, and then proceed to the Snapshots tab:

Project snapshots are also created automatically when you perform a search/replace operation. If the Automatic snapshot on upload option is enabled, a snapshot will be created on each file import (this option is not available on some subscription plans).

Download files

You can download (export) your project strings to any format supported by Lokalise.

To get started, click the Download icon in the top menu:

Next, adjust the download options as needed:

Alternatively, you can initiate the export via the API.

Translation memory

Translation memory is extremely useful if you are working on more than one project. This feature remembers the accepted translations and offers these to your translators in other projects. There are two ways of accessing this feature:

  1. Translations will be suggested automatically when you click on the translation field.

  2. You can click on the Translation Memory button (or open it using the Ctrl+G key combination) and search for translations manually.

To manage translation memory storages, you'll need to open your team settings and proceed to the Translation memory tab:

QA checks

Quality assurance checks are automatically run whenever someone modifies a translation. Lokalise provides a handful of QA checks for you. To adjust them, click the More icon in the top menu, then proceed to Settings > QA checks.

Each QA check has two escalation levels: Warning and Error. 

  • Warning – the translation will be saved as usual, but a warning notification icon will pop up in the Editor. 

  • Error – this prevents a translator from saving the entry in the web UI (the Editor).

Apps

Integrate Lokalise with the tools you love and use every day. Connect with your favorite productivity tools and code repositories. You can also set up new workflows and event triggers via the API and make the translation process seamless.

To get started with the apps, click More > Apps in the main menu:

Mobile in-context editor

Lokalise iOS SDK Live Edit Module is the extension of Lokalise iOS SDK. Translate the app in Lokalise while navigating it on a connected mobile device — the best in-context translation experience. Instantly see the changes made and ensure the app is pixel-perfect. 

The screen mirrors the linked device with the installed pre-release version of your app. First, it provides an editor or a QA / LQA specialist with the live full context of the translated string. Second, it ensures a pixel-perfect visual experience, showing the edited strings in the proper font and proper place, just as the end users will see it.

Web in-context editor

LiveJS is an in-context JavaScript editor that allows your translators or copywriters to edit your website texts and translations directly in the web page. All changes are shown in the browser and saved directly to Lokalise, not to your localization files or the database running your website.

Professional translation orders

If you don't have your own team of translators, Lokalise offers several translation providers, to help with translating your app or website to the most popular languages.

To get started, click the Orders tab in the side menu:

Next, click New order, choose a translation provider, and adjust other options as needed:

If you choose Lokalise provider then the translator and/or editor will be added directly to your team and will be able to view all the project details including comments, screenshots, glossary, translation memory, and so on. However, please note that these newly added users do not count towards seat limits.

Manage your team

A team can contain many users, and a user may be a member of many teams. To manage your team, click on your avatar in the bottom left corner and choose Team settings:

Learn more about team settings in the corresponding article.

Team roles

If a user is a member of a team, s/he can have one of the following roles

  • Owner – a user who initially created a team becomes its owner automatically. An owner can promote other team users to owners. The owners are automatically added to all projects created within a given team and they cannot be removed from these projects. Owners can delete users and projects, and perform other administrative actions.

  • Admin – can promote team users to administrators, remove users, create projects, and translation orders.

  • Biller — has the same access rights as admins but additionally billers can manage subscriptions, edit billing details, download invoices, add and remove seats, change payment card, and upgrade/downgrade subscription plan. Billers are not added automatically to the team projects and can be removed from the projects as needed.

  • Member – team members have restricted rights and can only participate in the team projects. They cannot modify any team settings, manage users, or view sensitive data like billing information.

Adding team users

In Lokalise you do not add a team user directly. Rather, you should invite a new project contributor as explained above, and this new contributor will become a member of the team automatically. Remember that each team user occupies a team seat, and different subscription plans provide a different number of available seats.

User groups

Create a new group by proceeding to Team settings > User groups. Click the Create new group button, give it a name, and then click Add members. After adding group members, open the Permissions tab, where you can assign group permissions.

Subscription

In order to choose the most suitable subscription plan, navigate to Team settings and choose the Billing section.

Here you can see your current subscription plan and the expiration date. Click on the Change current plan link to choose a different subscription.

Tasks

Create a better-structured localization and translation workflow with tasks. Tasks help you to better manage your translators and keep track of their jobs. You can see which job the contributors are currently doing and what is the current progress.

When creating a task, you can choose the keys to include in the task, languages, due dates, etc. It is a good idea to restrict contributors to working only within tasks by enabling the corresponding option in the project settings:

On the first screen of the task creation wizard you can enter the following info:

  • Title of the task 

  • Description (optional)

  • Due date (optional) 

  • Task type which can be either translation or revision:
    Translation means that the assignee have to translate a number of keys into the chosen languages.
    Review means that the assignee have to verify translations and make sure they are correct.

On the second screen you'll be able to adjust the task options:

  • Lock translation – the keys chosen in this task will be editable only by the assignee of this task. Other project contributors won’t be able to modify these translations until the task is done.

  • Include admins as assignees – you will include yourself and other administrators of the project in this task.

  • Auto-mark items as completed on edit — when this option is enabled, all items added to the task will be automatically mark as completed once the translation is saved. When this option is disabled, the users will see two buttons: one to save the translation only, and another to save the translation and mark the item as completed.

  • Auto-close languages – when all chosen keys are translated to a specific language, the language will be marked as completed and the corresponding subtask will be closed.

  • Auto-close task – when all the languages for this task are closed, the whole task will be closed automatically.

  • Tag keys as the task is completed – if you choose this option, you may enter one or more tags that will be automatically added to the keys once the task is done. Tags act like labels and can be used to quickly filter keys.

  • Allow for this task to be used as a template — after the task is created, it can be utilized as a template when adding more tasks. You will be able to choose a template on the first step General information. Please note that if there are no templates available, the corresponding dropdown won't appear.

On the third screen you'll need to provide the task scope, choose the languages, and assignee:

  • Task scope – using the filter you may select keys to translate. By default, all untranslated keys are selected, but you may modify or add more filters. 

  • Target languages – select one or more languages from those in your project. 

  • Assignees – to add someone to work on a language, click on this box and choose one or more users. 

  • Create task – once this button is clicked the chosen assignees will be notified that they have a new task. You may add or remove translators by clicking the language boxes under the Assignees section.

Once you assign a new task to the project contributors, their task inbox will be updated:

In addition, they may receive a notification via email depending on the settings.

That's it! We'll keep updating this guide. If you have any questions or suggestions, please contact us in the support chat.

Did this answer your question?