Lokalise

https://docs.lokalise.com/en
Admin
Lokalise is a localization and translation management platform designed for agile teams to automate,...
Tokens:175,301
Snippets:3,313
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Lokex package

Source: https://docs.lokalise.com/en/articles/14674564-go

Use the go get command to add the Lokex library to your project.

```bash
go get github.com/bodrovis/lokex/v2
```

--------------------------------

### Install lokalise-file-exchange

Source: https://docs.lokalise.com/en/articles/1558846-node-js

Install the required package via npm.

```bash
npm install --save lokalise-file-exchange
```

--------------------------------

### Universal Placeholder Conversion Examples

Source: https://docs.lokalise.com/en/articles/1400511-lokalise-placeholders

Examples showing how the universal placeholder string 'My name is [%s:name]. I have [%.2f] dollars.' is transformed across different platform formats.

```text
My name is [%s:name]. I have [%.2f] dollars.
```

```text
My name is %s. I have %.2f dollars.
```

```text
My name is %@. I have %.2f dollars.
```

```text
My name is {name}. I have {0} dollars.
```

```text
My name is {0}. I have {0:0.00} dollars.
```

```text
My name is %name%. I have %placeholder_1% dollars.
```

```text
My name is {{name}}. I have {{0}} dollars.
```

--------------------------------

### Listen for initialization

Source: https://docs.lokalise.com/en/articles/1592525-livejs-web-in-context-editor

Listen for the lokalise-initialized event to detect when LiveJS has finished setup.

```javascript
document.addEventListener("lokalise-initialized", function() {
    console.log("LiveJs initialized");
});
```

--------------------------------

### Sample translation files

Source: https://docs.lokalise.com/en/articles/1400511-lokalise-placeholders

Example of web and Android translation files using different placeholder syntaxes.

```json
{
  "your_order": "Here's your order, {{name}}!"
}
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<resources>
  <string name="your_order">Here's your order, %s!</string>
</resources>
```

--------------------------------

### HTML Translation Alignment Example Files

Source: https://docs.lokalise.com/en/articles/8671891-create-a-translation-memory-for-existing-translations-translation-alignment

Sample HTML templates used to demonstrate key alignment and structural differences during file import.

```html
<h1>Welcome onboard!</h1>

<p>We are thrilled to welcome you! Here are some links to help you get started:</p>

<ul>
  <li>Documentation</li>
  <li>Blog</li>
  <li>Forum</li>
</ul>
```

```html
<h1>¡La bienvenida a bordo!</h1>

<p>¡Estamos encantados de darle la bienvenida! Aquí hay algunos enlaces que le ayudarán a empezar:</p>

<p></p>
<p></p>
<p>Documentación</p>
<p>Foro</p>
```

--------------------------------

### Expose translation keys in HTML

Source: https://docs.lokalise.com/en/articles/1592525-livejs-web-in-context-editor

Examples for marking up translatable content based on the plainKey configuration setting.

```html
<span data-lokalise data-key="index.hero.title">Translation platform for developers</span>
```

```text
{.index.hero.title.}
```

--------------------------------

### Example English and Spanish Paragraphs

Source: https://docs.lokalise.com/en/articles/8671891-create-a-translation-memory-for-existing-translations-translation-alignment

Comparison of a base English paragraph and a transcreated Spanish version that may cause alignment issues.

```html
<p>Welcome!</p>
```

```html
<p>Me alegra darle la bienvenida en este maravilloso día.</p>
```

--------------------------------

### HTML Layout Alignment Example

Source: https://docs.lokalise.com/en/articles/8671891-create-a-translation-memory-for-existing-translations-translation-alignment

Shows how content is re-formatted during export to match the base version's layout, even if the source structure differs.

```html
<ul>
  <li>Documentation</li>
  <li>Blog</li>
  <li>Forum</li>
</ul>
```

```html
<p>Documentación</p>
<p>Blog</p>
<p>Foro</p>
```

--------------------------------

### HTML Paragraph Mismatch Example

Source: https://docs.lokalise.com/en/articles/8671891-create-a-translation-memory-for-existing-translations-translation-alignment

Demonstrates how extra paragraphs in a target language file are ignored if they do not match the base version's structure.

```html
<p>Welcome!</p>
```

```html
<p>¡La bienvenida a bordo!</p>

<p>¡Estamos encantados de darle la bienvenida!</p>
```

--------------------------------

### Initialize a Lokex client

Source: https://docs.lokalise.com/en/articles/14674564-go

Create a new client instance using your API token and project ID, with optional backoff configuration.

```go
import (
    "log"
    "time"

    "github.com/bodrovis/lokex/v2/client"
)

cli, err := client.NewClient("YOUR_API_TOKEN", "LOKALISE_PROJECT_ID", client.WithBackoff(
    1*time.Second,  // min backoff
    5*time.Second,  // max backoff
))
if err != nil {
    log.Fatal(err)
}
```

--------------------------------

### Example of an .xcstrings file structure

Source: https://docs.lokalise.com/en/articles/12710356-apple-xcstrings-xcstrings

A sample JSON structure showing the required version, source language, and translation entries for a specific key.

```json
{
  "version": "1.0",
  "sourceLanguage" : "en",
  "strings" : {
    "hello_world" : {
      "shouldTranslate": true,
      "comment" : "Here is a comment for the translator",
      "extractionState" : "manual",
      "localizations" : {
        "en" : {
          "stringUnit" : {
            "state" : "translated",
            "value" : "Hello World"
          }
        },
        "pl" : {
          "stringUnit" : {
            "state" : "translated",
            "value" : "Witaj świecie"
          }
        },
        "de" : {
          "stringUnit" : {
            "state" : "translated",
            "value" : "Hallo Welt"
          }
        }
      }
    }
  }
}
```

--------------------------------

### Install lokalise_rails gem

Source: https://docs.lokalise.com/en/articles/1558875-ruby-on-rails

Add the gem to your Gemfile and run the installation commands.

```ruby
gem 'lokalise_rails'
```

```bash
bundle install
rails g lokalise_rails:install
```

--------------------------------

### ICU placeholder conversion examples

Source: https://docs.lokalise.com/en/articles/1400511-lokalise-placeholders

Examples showing how named ICU placeholders compare to positional formats during export.

```text
Location {location}, {name}, {surname}
```

```text
Location %1$s, %2$s, %3$s
```

```text
Location {0}, {1}, {2}
```

--------------------------------

### Example Salesforce Translation .stf file structure

Source: https://docs.lokalise.com/en/articles/1400815-salesforce-translation-stf

A sample .stf file demonstrating the required structure, including header comments, language metadata, and the separation of TRANSLATED and UNTRANSLATED sections.

```text
# Use the Bilingual file to review translations, edit labels that have already been translated, and add translations for labels that haven't been translated.
# - The TRANSLATED section of the file contains the text that has been translated and needs to be reviewed.
# - The UNTRANSLATED section of the file contains text that hasn't been translated. You can replace untranslated labels in the LABEL column with translated values.
# The Out of Date indicators are:
# - An asterisk (*): The label is out of date. A change was made to the default language label and the translation hasn't been updated.
# - A dash (-): The translation is current.
# Notes:
# Don't add columns to or remove columns from this file.
# Tabs (\t), new lines (\n) and carriage returns (\r) are represented by special characters in this file. These characters should be preserved in the import file to maintain formatting.
# Lines that begin with the # symbol are ignored during import.
# Salesforce translation files are exported in the UTF-8 encoding to support extended and double-byte characters. This encoding cannot be changed.

# Language: German
Language code: de
Type: Bilingual

------------------TRANSLATED-------------------

# KEY LABEL TRANSLATION OUT OF DATE

ButtonOrLink.Event.New_Event New Event Neues Ereignis -
ButtonOrLink.Opportunity.Add_Line_Items Add Line Items Artikelanlage -

# eyescream: skipped some

CustomLabel.PKB2_All_Fields_Required All fields are required. Alle Felder sind obligatorisch. -
CustomLabel.PKB2_Answers_Might_Help These answers might help immediately Diese Antworten könnten vielleicht helfen -
CustomLabel.PKB2_Back_To_Results Back to search results Zurück zu den Suchergebnissen -
CustomLabel.PKB2_Back_To_Search_Page Back to search page Zurück zur Suchseite -
CustomLabel.PKB2_Cancel Cancel Abbrechen -

# eyescream: skipped some

CustomLabel.SC_Case_Information Case Information Beschreibungsinformationen -
CustomLabel.SC_Contact_Information Contact Information Kontaktinformationen -
CustomLabel.SC_New_Case New Case Neuer Kundenvorgang -
CustomLabel.SC_New_Find_Contact New / Find Contact Neuer Kontakt / Kontakt suchen -
CustomLabel.SC_Save_New Save & New Speichern & Neu -

------------------UNTRANSLATED-----------------

# KEY LABEL
ButtonOrLink.Order__c.Mass_edit Edit
ButtonOrLink.Order__c.Printable_view Printable view!
ButtonOrLink.Order__c.Quick_Email Quick Email

# eyescream: skipped some

CustomLabel.PKB2_FAQ_Label FAQ
CustomLabel.PKB2_Feedback Feedback
```

--------------------------------

### Gettext header example with plural forms

Source: https://docs.lokalise.com/en/articles/1400767-gettext-po-pot

An example of a Gettext file header including the required Plural-Forms definition for language-specific rules.

```text
"Project-Id-Version: Sample 1.0.1\n"
"Report-Msgid-Bugs-To: support@example.com \n"
"Last-Translator: Username <user@example.com>\n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
```

--------------------------------

### Java Properties file structure

Source: https://docs.lokalise.com/en/articles/1400768-java-properties-properties

A standard example of a .properties file showing key-value pairs and comment syntax.

```properties
# This is a comment
welcome.message = Welcome to Lokalise!
error.message = An error has occurred.
username.label = Username:
password.label = Password:
```
Tokens:
Raw