### Onboarding Guide for Project Managers

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

Designed for product, project, and localization managers, this guide focuses on implementing improved translation workflows with Lokalise.

```text
This guide is built for product, project, and localization managers who want to implement a better translation workflow using Lokalise.
```

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

### Role-Based Onboarding Guides

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

Lokalise offers onboarding guides tailored to specific roles within a localization process. These guides help users understand how to best utilize Lokalise based on their responsibilities.

```text
Find role-based onboarding guides here!
```

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

### Onboarding Guide for Translators

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

This guide is specifically created for translators to help them efficiently perform translations using the Lokalise platform.

```text
This guide will help you understand how to perform translations using Lokalise efficiently.
```

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

### Lokalise Onboarding Guides

Source: https://docs.lokalise.com/en/collections/652196-getting-started

Role-based onboarding guides to help users understand and utilize Lokalise effectively. These guides are tailored for translators, project managers, and general users looking to implement localization workflows.

```APIDOC
Onboarding Guides:
  - General Lokalise overview.
  - Role-based guides for:
    - Translators: Efficient translation using Lokalise.
    - Project Managers: Implementing localization workflows.
  - Video tutorials for learning Lokalise.
```

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

### Create a New Project in Lokalise

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

This section details the process of creating a new project within the Lokalise platform. It guides users through the initial setup wizard after registration.

```APIDOC
Project:
  CreateProject(projectName: str, description: str = None, ...)
    Parameters:
      projectName: The name for the new project.
      description: An optional description for the project.
    Returns:
      ProjectID: The unique identifier for the newly created project.
    Usage:
      Initiate project creation via the Lokalise interface or API.
```

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

### Video Tutorials for Lokalise Usage

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

A collection of short video tutorials to assist users in learning how to effectively use the Lokalise platform.

```text
Learn how to use Lokalise by watching short videos.
```

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

### Getting Started with Webflow Project Setup in Lokalise

Source: https://docs.lokalise.com/en/articles/8400901-webflow

Provides instructions on how to set up a new project in Lokalise for Webflow integration. This involves creating a 'Marketing and Support' project, selecting base and target languages, and choosing 'Webflow' from the content integrations dropdown.

```APIDOC
Project Setup:
1. Create a 'Marketing and Support' project in Lokalise.
2. Enter a project name.
3. Select base and target languages.
4. Choose 'Webflow' from the 'Content integrations' dropdown.
5. Click 'Create project'.
```

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

### Lokalise Platform Links

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

Provides essential links for users to access different aspects of the Lokalise platform, including trying the service, developer resources, and company information.

```text
Try Lokalise
Developer Hub
Blog
Demo
Translate HTML content
```

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

### Lokalise Messages for Dixa: Installation Guide

Source: https://docs.lokalise.com/en/collections/3722575-dixa

Provides step-by-step instructions for installing the Lokalise Messages integration for Dixa. This guide is essential for setting up the real-time chat translation feature.

```en
https://docs.lokalise.com/en/articles/6751523-lokalise-messages-for-dixa-installation-guide
```

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

### Lokalise Figma Plugin Installation Guide

Source: https://docs.lokalise.com/en/articles/3732824-figma

Instructions on how to install the Lokalise plugin from the Figma community. This involves searching for 'lokalise' in the plugins directory and running it.

```text
1. Open your Figma project.
2. Go to Menu > Plugins > Find more plugins.
3. Type "lokalise" in the search box.
4. Find the plugin and click Run.
```

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

### Lokalise Onboarding Guides Overview

Source: https://docs.lokalise.com/en/articles/9173346-role-based-onboarding-guides

This section outlines various onboarding resources available for different roles within Lokalise. It includes links to introductory and advanced courses on Lokalise Academy and specific guides for translators, project managers, and developers.

```markdown
## Role-based onboarding guides

Find role-based onboarding guides here!

Whether you're just starting or looking to enhance your expertise, we’ve curated **role-based onboarding guides** to help you seamlessly integrate into Lokalise. Our resources are tailored to support different team roles, ensuring a smooth and efficient localization process.
  * [Getting started with Lokalise](https://academy.lokalise.com/course/getting-started-with-lokalise) — this is a concise, general-purpose introduction available in our Academy. It's the perfect starting point for any new customer, offering a foundational understanding of our platform.
  * [Jump-start Lokalise](https://academy.lokalise.com/course/lokalise-advanced-onboarding) — elevate your knowledge with this advanced course that delves into every aspect of our platform. From beginner basics to professional proficiency, this comprehensive guide comes with a certificate of completion to acknowledge your expertise.
  * [For translators](https://docs.lokalise.com/en/articles/2967175-onboarding-guide-for-translators) — explore our specialized textual guide and instructional video crafted to enhance your translation workflow within Lokalise.
  * [For project managers](https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers) — a dedicated textual guide is available to assist project managers in effectively navigating and managing projects on our platform.
  * For developers
    * [Introductory course](https://academy.lokalise.com/course/lokalise-for-developers-getting-started) — a brief course offered through our Academy, covering the essential basics every developer needs to know about our product.
    * [Advaced course](https://academy.lokalise.com/course/lokalise-for-developers) — a thorough course focusing on the utilization of webhooks, API, custom processors, and more, designed for developers seeking to fully harness the power of Lokalise.
  * [For designers](https://academy.lokalise.com/course/lokalise-for-designers) — a concise course available in our Academy, specifically developed to acquaint designers with the integral aspects of working with Lokalise.
```

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

### Lokalise App Installation and Authorization

Source: https://docs.lokalise.com/en/articles/1525939-zendesk-guide

Instructions for installing the Lokalise app within a Zendesk project and authorizing the connection.

```APIDOC
App Installation and Authorization:
  - After project creation, navigate to the 'Content management' tab.
  - If not redirected, manually open the project and go to 'Content management', then click 'Install'.
  - Enter your 'Zendesk subdomain' (e.g., 'mycorp' if your URL is mycorp.zendesk.com).
  - Click 'Authorize' to grant Lokalise access to your Zendesk project.
```

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

### Lokalise Account and API Tokens

Source: https://docs.lokalise.com/en/collections/652196-getting-started

Learn how to manage your API and OTA (SDK) tokens, which are essential for integrating Lokalise with your applications and workflows. These tokens facilitate programmatic access and automated processes.

```APIDOC
API and OTA tokens:
  - Manage API tokens for programmatic access.
  - Manage OTA (SDK) tokens for in-app localization updates.
  - Security best practices for token management.
```

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

### Keys and Platforms Setup

Source: https://docs.lokalise.com/en/collections/2909122-translation-keys

Understand how to properly set up and utilize keys and platforms within Lokalise. This guide covers the integration and management of keys across different platforms.

```en
Keys and platformsLearn how to properly set up and use keys and platforms in Lokalise.
```

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

### Lokalise Subscription Management

Source: https://docs.lokalise.com/en/collections/652196-getting-started

Information on managing your Lokalise subscription, including viewing subscription details, understanding available plans, and managing payment methods. This section covers all aspects of billing and subscription lifecycle.

```APIDOC
Subscription Management:
  - View and manage subscription details.
  - Available plans and payment methods.
  - Trial period information.
  - Free plan details.
  - Managing invoices and billing details.
  - OTA pricing FAQ.
```

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

### Adding I18n Support to an App

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

Guidance on the process of adding internationalization (i18n) support to an application, likely involving the use of Lokalise.

```text
I am adding I18n support for my app. How do I proceed?
```

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

### Lokalise Messages for Dixa Further Steps

Source: https://docs.lokalise.com/en/articles/6751523-lokalise-messages-for-dixa-installation-guide

This section provides links to various resources that help users maximize their use of Lokalise Messages with Dixa. Topics include agent tutorials, dashboard access, language settings, translation overrides, exclusion rules, glossary usage, and pricing information.

```APIDOC
Further Resources:
  - Tutorial for agents: https://docs.lokalise.com/en/articles/6738375-lokalise-messages-for-dixa-tutorial-for-agents
  - Accessing the dashboard: https://docs.lokalise.com/en/articles/6738378-lokalise-messages-for-dixa-access-pro-dashboard
  - Configuring languages: https://docs.lokalise.com/en/articles/6738371-lokalise-messages-for-dixa-configuring-languages
  - Overriding language providers: https://docs.lokalise.com/en/articles/7269032-lokalise-messages-translation-rules
  - Excluding messages from translation: https://docs.lokalise.com/en/articles/7267997-lokalise-messages-exclusion-rules
  - Working with the glossary: https://docs.lokalise.com/en/articles/6738367-lokalise-messages-for-dixa-glossary
  - Pricing information: https://docs.lokalise.com/en/articles/6738365-lokalise-messages-for-dixa-pricing
```

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

### Uploading a Style Guide

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Steps to upload a style guide to Lokalise. Requires team admin, biller, or owner permissions. Supports PDF or DOCX files up to 5MB. Style guides can be general or language-specific.

```APIDOC
POST /style-guides

Description: Uploads a new style guide.

Request Body:
  - file: The style guide file (PDF or DOCX, max 5MB).
  - assignment_type: 'general' or 'language'
  - languages: Array of language codes (if assignment_type is 'language').

Response:
  - success: boolean
  - message: string
  - style_guide_id: string
```

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

### Install Lokalise App in Contentful

Source: https://docs.lokalise.com/en/articles/8067631-contentful-native

Steps to install the Lokalise app from the Contentful marketplace. This involves navigating to the Apps section, selecting Marketplace, choosing the category, finding Lokalise, and clicking Install.

```text
1. Open Contentful and navigate to the Apps section.
2. Select Marketplace, then choose the Translation and Localization category.
3. Find Lokalise and click on it.
4. Press Install.
5. Select the environment where you want to install the app.
6. Click Connect.
7. Allow access when prompted.
8. Go back to the original tab, select content types, and click Install.
9. Review default settings and click Save.
```

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

### Style Guide: Tone of Voice Examples

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Defines the desired tone of voice for translations, using adjectives and explanations to maintain brand consistency, with examples of friendly and conversational language.

```en
Our tone is friendly and conversational. All translated content should reflect a light-hearted and engaging tone, such as saying "Great news! You’re all set and subscribed!" instead of "You’ve successfully subscribed to the service."
```

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

### Style Guide: Common Translation Mistakes Examples

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Outlines frequent translation errors to avoid, such as literal translations of idioms or culturally inappropriate content, with examples like adapting "break a leg."

```en
The expression "break a leg," which is used to wish someone good luck, should not be translated literally. It should be adapted to a phrase that conveys good luck in the target language.
```

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

### Lokalise Navigation Links

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Lists key navigation links for Lokalise, including Try Lokalise, Developer Hub, Blog, Demo, and specific feature pages.

```APIDOC
Navigation:

- Try Lokalise: https://app.lokalise.com/signup
- Developer Hub: https://developers.lokalise.com/
- Blog: https://lokalise.com/blog/
- Demo: https://demo.lokalise.com/
- Translate HTML Content Blog: https://lokalise.com/blog/translate-html-content/
```

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

### Authenticate Lokalise Messages in FrontApp

Source: https://docs.lokalise.com/en/articles/6552716-lokalise-message-for-front-installation-guide

This guide explains how to authenticate Lokalise messages through the sidebar in FrontApp. It involves clicking the 'L' icon, authorizing the app, and enabling webhooks.

```text
1. Click the new 'L' icon in the right-side menu.
2. Click **Authorize** in the sidebar widget.
3. Confirm the authorization on the pop-up window.
4. Enable webhooks in the Lokalise widget.
```

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

### Lokalise Apps and Workflows

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Information on integrating Lokalise Apps and setting up workflows and automations for streamlined localization processes.

```APIDOC
Apps:
  ListAvailable(projectId: str, ...)
    Parameters:
      projectId: The ID of the project.
    Returns:
      AppList: A list of available Lokalise apps.

Workflows:
  CreateAutomation(projectId: str, trigger: str, action: str, ...)
    Parameters:
      projectId: The ID of the project.
      trigger: The event that triggers the automation.
      action: The action to perform.
    Returns:
      AutomationID: The ID of the created automation rule.
```

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

### Lokalise Developer Resources

Source: https://docs.lokalise.com/en/articles/9173346-role-based-onboarding-guides

This section provides links to essential resources for developers using Lokalise, including the Developer Hub for API documentation and integration guides, and the Lokalise blog for relevant articles.

```markdown
* [Developer Hub](https://developers.lokalise.com/)
  * [Blog](https://lokalise.com/blog/)
  * [Translate HTML](https://lokalise.com/blog/translate-html-content/)
```

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

### Style Guide: Formatting Examples

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Specifies correct formats for culturally variable elements like dates and numbers, ensuring they are understood by the target audience.

```en
Dates in U.S. English should be formatted as `MM/DD/YYYY`, whereas in U.K. English, they should appear as `DD/MM/YYYY`.
```

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

### FAQ: Lokalise and Contentful Multi-Project Setup

Source: https://docs.lokalise.com/en/articles/8067631-contentful-native-beta

Answers common questions regarding the multi-project setup, including project persistence, tag scope, handling of linked entries, and export procedures.

```text
Q: When I move from a single project to multiple projects, do I lose my initial project? 
​A: No, your original Lokalise project remains intact. However, it will be disconnected from Contentful unless you assign a new tag and connect it back to that project.

Q: Are tags connected to specific fields (e.g., title, body) or to the entire entry? 
​A: Tags apply to the entire entry. It's not possible to tag just individual fields like the title or body.

Q: What if an entry has linked (child) entries — will they be exported too? 
​A: Yes, linked child entries will be exported to the same Lokalise project as the parent entry. However, keep in mind that they won’t automatically inherit the parent’s tag and you'll need to tag them explicitly if needed for visibility or automation purposes.

Q: I created new tags and connected them to new Lokalise projects, but I can’t access those projects. What’s going on? 
​A: This usually happens when you're not the Lokalise team owner. Here’s why: when a new Lokalise project is created via Contentful, it’s created on behalf of the person who originally set up the Lokalise integration (usually the team owner). So if you're not that person, you won't have access by default. To fix this, ask your Lokalise team owner to grant you access to the new projects.
```

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

### Style Guide: Grammar and Style Examples

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Provides guidelines on sentence structure and correct grammar usage for clear and accurate translations, recommending the active voice for immediacy.

```en
We recommend using the active voice to create a sense of immediacy and clarity. For instance, "We’re processing your order" instead of "Your order is being processed."
```

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

### Lokalise Project Activity and Statistics

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Covers how to view project activity logs and access project statistics to monitor progress and performance.

```APIDOC
Activity:
  GetLog(projectId: str, ...)
    Parameters:
      projectId: The ID of the project.
    Returns:
      ActivityLog: A list of project activities.

Statistics:
  GetSummary(projectId: str, ...)
    Parameters:
      projectId: The ID of the project.
    Returns:
      ProjectStats: Summary statistics for the project (e.g., translated words, progress).
```

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

### FAQ: Lokalise and Contentful Multi-Project Setup

Source: https://docs.lokalise.com/en/articles/8067631-contentful-native

Answers common questions regarding the multi-project setup, including project persistence, tag scope, handling of linked entries, and export procedures.

```text
Q: When I move from a single project to multiple projects, do I lose my initial project? 
​A: No, your original Lokalise project remains intact. However, it will be disconnected from Contentful unless you assign a new tag and connect it back to that project.

Q: Are tags connected to specific fields (e.g., title, body) or to the entire entry? 
​A: Tags apply to the entire entry. It's not possible to tag just individual fields like the title or body.

Q: What if an entry has linked (child) entries — will they be exported too? 
​A: Yes, linked child entries will be exported to the same Lokalise project as the parent entry. However, keep in mind that they won’t automatically inherit the parent’s tag and you'll need to tag them explicitly if needed for visibility or automation purposes.

Q: I created new tags and connected them to new Lokalise projects, but I can’t access those projects. What’s going on? 
​A: This usually happens when you're not the Lokalise team owner. Here’s why: when a new Lokalise project is created via Contentful, it’s created on behalf of the person who originally set up the Lokalise integration (usually the team owner). So if you're not that person, you won't have access by default. To fix this, ask your Lokalise team owner to grant you access to the new projects.
```

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

### Install Ditto App in Lokalise

Source: https://docs.lokalise.com/en/articles/7549522-ditto

Instructions for installing the Ditto app within a Lokalise project after project creation. This involves navigating to Content management and authorizing with an API key.

```guide
1. Navigate to the 'Content management' tab in your Lokalise project.
2. Click 'Install' if not automatically redirected.
3. Paste the API key obtained from Ditto.
4. Click 'Authorize' to complete the installation.
```

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

### Set up Webhooks in FrontApp

Source: https://docs.lokalise.com/en/articles/6552716-lokalise-message-for-front-installation-guide

This section describes how to enable and configure the Webhooks app in FrontApp. It includes enabling 'Send Full Event Data' for comprehensive event information.

```text
1. Go to **App store** and search for **Webhooks**.
2. Click **Enable app**.
3. Click **Configure app**.
4. Enable **Send Full Event Data**.
5. Click **Save**.
```

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

### Lokalise Related Articles

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Lists related articles for further information on Lokalise features and integrations.

```APIDOC
Related Articles:

- Tasks: https://docs.lokalise.com/en/articles/1457259-tasks
- Onboarding guide for translators: https://docs.lokalise.com/en/articles/2967175-onboarding-guide-for-translators
- Figma: https://docs.lokalise.com/en/articles/3732824-figma
- Adobe XD: https://docs.lokalise.com/en/articles/4243445-adobe-xd
- Style guide: https://docs.lokalise.com/en/articles/8217808-style-guide
```

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

### Style Guide: Cultural References and Sensitivity Examples

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Offers guidance on adapting cultural references, idioms, and sayings to resonate appropriately with the target audience, avoiding literal translations.

```en
The phrase "feel like a million dollars" should be adapted to local contexts where the concept of U.S. currency or the idiomatic expression might not be relevant. A more effective translation might be "feel fantastic" or a local equivalent that conveys a similar sentiment of wellbeing.
```

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

### Lokalise Start Plan Details

Source: https://docs.lokalise.com/en/articles/5159153-available-plans-and-payment-methods

Details for the Start plan, designed for small teams and startups. Includes seats, hosted keys, mobile SDK data, and integrations like GitHub, API, and CLI.

```APIDOC
Start Plan:
  Suitable for: small teams and early stage startups.
  Number of seats: 10.
  Number of hosted keys: 5000.
  GB of data for mobile SDK: 10 GB.
  Features included:
    - Collaborative web-based editor
    - Tasks
    - Mobile SDK
    - API and CLI tool
    - GitHub, GitLab, and BitBucket integrations
    - Productivity integrations (Jira, Slack, webhooks, etc.)
    - Automations
    - Spelling checks
    - Project activity
```

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

### Creating a Team and Trial Period

Source: https://docs.lokalise.com/en/articles/2967175-onboarding-guide-for-translators

Details the process of creating a new team for testing Lokalise, including the duration of the free trial and the automatic switch to the free plan afterward.

```en
If you don’t have a team and want to test Lokalise, click **Create your team** after confirming your email. This gives you two weeks of full access. After the trial, your account will switch to the [free plan](https://intercom.help/lokalise-help/en/articles/1400453-free-plan) automatically.
```

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

### Enable Lokalise Integration in FrontApp

Source: https://docs.lokalise.com/en/articles/6552716-lokalise-message-for-front-installation-guide

This section details the process of enabling the Lokalise integration within FrontApp. It involves navigating to settings, the app store, and enabling the Lokalise app. Individual inboxes on FrontApp are not supported.

```text
1. Log in to your Front account.
2. Navigate to **Settings** (gear icon).
3. Go to **App store** and search for "Lokalise".
4. Click **Enable** app.
```

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

### Lokalise Tasks and Workflows

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Information on creating and managing tasks within Lokalise projects and setting up workflows and automations.

```APIDOC
Tasks:
  Create(projectId: str, title: str, assignedTo: str, ...)
    Parameters:
      projectId: The ID of the project.
      title: The title of the task.
      assignedTo: The user to whom the task is assigned.
    Returns:
      TaskID: The ID of the created task.

Workflows:
  Automations:
    - Configure triggers and actions for automated processes.
```

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

### Plugin Installation and Launch

Source: https://docs.lokalise.com/en/articles/4669773-sketch

Instructions for installing the Lokalise plugin within Sketch and how to access it from the Sketch menu bar. Includes an alternative download method via GitHub.

```APIDOC
InstallAndLaunchLokalisePlugin:
  Installation:
    - Open Sketch project.
    - Navigate to Menu > Plugins > Manage plugins.
    - Click 'Get plugins'.
    - Click 'Install'.
    - Alternative: Download from the official GitHub repository: https://github.com/lokalise/lokalise-sketchplugin
  Launch:
    - Open your Sketch project.
    - Navigate to Menu > Plugins > Lokalise.
```

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

### Lokalise Keyboard Shortcuts

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Provides shortcuts for accessing Translation Memory and other features within the Lokalise platform.

```en
Ctrl+G: Open Translation Memory manually
```

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

### Two-factor Authentication Setup

Source: https://docs.lokalise.com/en/collections/2905036-your-account

Two-factor authentication (2FA) adds an extra layer of security when logging into your Lokalise account. This guide explains how to set it up.

```APIDOC
Two-factor Authentication:
  - Enable and configure 2FA for enhanced account security.
  - Process for setting up authenticator apps or SMS verification.
  - Recovery options in case of lost access.
```

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

### Reconfiguring SSO for Another Team

Source: https://docs.lokalise.com/en/articles/7150706-google-saml

Steps to reset and reconfigure SSO settings for a different Lokalise team using the same domain.

```APIDOC
Reconfigure SSO Steps:
  1. Navigate to 'Team settings' > 'Advanced security' in Lokalise.
  2. Empty all fields within the 'Single sign-on (SSO)' section.
  3. Uncheck the 'Enable SSO' setting.
  4. Click 'Save'.
  5. Proceed with configuring SSO for the new Lokalise team.
```

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

### Lokalise Task Creation Options

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Describes options available when creating a new task in Lokalise, including saving as a template, defining task scope, source and target languages, and assigning contributors.

```APIDOC
Feature: Task Creation Options

1. Save as task template:
   - Description: Enable to save current task settings as a template for future similar tasks.

2. Task scope:
   - Description: Adjust filters to select keys for the task. Defaults to all untranslated keys, but custom criteria can be applied.

3. Source language:
   - Description: The language from which translations should be made. For review tasks, this is the reference language.

4. Target languages:
   - Description: One or more languages for translation. For review tasks, this is the language to be reviewed.

5. Task assignees:
   - Description: Select project contributors for the task. Assignees can be specified per language. The system suggests assignees based on task scope and target languages. Options to review, add, or remove assignees per language are available.

6. Vendor rate profiles:
   - Description: Option to choose vendor rate cards if using vendor rate profiles. Refer to specific documentation for details.
```

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

### Webhook URL Configuration

Source: https://docs.lokalise.com/en/articles/6552716-lokalise-message-for-front-installation-guide

This snippet shows the specific Webhook URL required for triggering webhooks within Lokalise's company rules.

```APIDOC
Webhook URL:
  https://messages.lokalise.com/v1/frontapp/event
```

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

### Lokalise Project Editor Overview

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Provides an overview of the Lokalise project editor interface, which is used for managing translations and project content.

```APIDOC
ProjectEditor:
  InterfaceOverview:
    - Key management
    - Translation input fields
    - Context and screenshot display
    - QA check integration
    - Commenting and collaboration features
```

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

### What is Lokalise?

Source: https://docs.lokalise.com/en/collections/2905038-getting-started

Lokalise is a platform designed for managing translations across different applications like mobile apps, games, and websites. It supports both individual and collaborative translation workflows.

```text
Lokalise lets you manage translations for mobile apps, games, and websites—either alone or with a team of collaborators.
```

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

### Lokalise API: Download Files

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Initiates the export of project strings to various supported formats via the Lokalise API. This allows for programmatic control over file downloads.

```APIDOC
POST /projects/{project_id}/files/download

Description:
Initiates the download of translation files for a project.

Parameters:
- project_id (required): The ID of the project.
- format (optional): The desired file format (e.g., json, po, xliff). Defaults to the project's default format.
- filter (optional): Filters for specific keys or languages.
- include_tags (optional): Include keys with specified tags.
- exclude_tags (optional): Exclude keys with specified tags.
- branch (optional): Specify the branch to download files from.

Returns:
A URL to download the zipped translation files or an error message.
```

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

### Lokalise Account Security

Source: https://docs.lokalise.com/en/collections/652196-getting-started

Learn about securing your Lokalise account with two-factor authentication. This feature adds an extra layer of security during the login process, protecting your account from unauthorized access.

```APIDOC
Two-factor authentication:
  - Enables an extra layer of security for account login.
  - Protects against unauthorized access.
```

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

### Lokalise Subscription Management

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Details on managing the Lokalise subscription, including plan information and billing.

```APIDOC
Subscription:
  GetPlanDetails(accountId: str, ...)
    Parameters:
      accountId: The ID of the user's account.
    Returns:
      PlanInfo: Information about the current subscription plan.
```

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

### Upload Translation Files via CLI

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

The Lokalise CLI tool provides a command-line interface for managing translation files, including uploading them to your projects. This is useful for scripting and automation.

```bash
lokalise2 file upload \
  --project-id "YOUR_PROJECT_ID" \
  --file "path/to/your/file.json" \
  --branch "main" \
  --tags "ios,en"
```

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

### Configure Dixa Webhook URL

Source: https://docs.lokalise.com/en/articles/6751523-lokalise-messages-for-dixa-installation-guide

This snippet shows the specific URL to configure for Dixa webhooks in Lokalise Messages. It ensures that events from Dixa are correctly sent to Lokalise.

```APIDOC
Webhook Configuration:
  Name: Lokalise Messages Event
  Webhook URL: https://messages.lokalise.com/v1/dixa/events
  Enable: True
  Authorization: Not required
  Events:
    - Note added
    - Message added
```

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

### Lokalise Messages for Dixa Further Steps and Guides

Source: https://docs.lokalise.com/en/articles/6738375-lokalise-messages-for-dixa-tutorial-for-agents

Provides a list of essential guides for users of Lokalise Messages for Dixa, covering access, configuration, translation management, and pricing.

```text
Further steps
  * [Learn how to access the dashboard](https://docs.lokalise.com/en/articles/6738378-lokalise-messages-for-dixa-access-pro-dashboard)
  * [Learn how to configure languages](https://docs.lokalise.com/en/articles/6738371-lokalise-messages-for-dixa-configuring-languages): globally, and on per-agent basis
  * [Learn how to override language providers](https://docs.lokalise.com/en/articles/7269032-lokalise-messages-translation-rules): globally or on per-language basis
  * [Learn how to exclude messages from translation](https://docs.lokalise.com/en/articles/7267997-lokalise-messages-exclusion-rules): fully or partially
  * [Learn how to work with the glossary](https://docs.lokalise.com/en/articles/6738367-lokalise-messages-for-dixa-glossary)
  * [Learn about pricing](https://docs.lokalise.com/en/articles/6738365-lokalise-messages-for-dixa-pricing)
```

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

### Lokalise SSO Configuration

Source: https://docs.lokalise.com/en/articles/7150706-google-saml

Configuration settings within Lokalise for enabling and managing SAML-based single sign-on. This includes specifying the Google domain, SAML endpoint, issuer, and certificate.

```APIDOC
Lokalise SSO Settings:
  Enable SSO: Boolean (Enables or disables SSO functionality)
  Team's domain: String (Your full Google domain, e.g., "example.com")
  SAML 2.0 Endpoint (HTTP): String (The SSO URL from your Google SAML app configuration, e.g., "https://accounts.google.com/o/saml2/idp?idpid=123abc")
  Identity Provider Issuer: String (The Entity ID from the Google SAML setup page, e.g., "https://accounts.google.com/o/saml2?idpid=123abc")
  Public Certificate: String (The certificate value from the Google SAML setup page, must start with "-----BEGIN CERTIFICATE-----" and end with "-----END CERTIFICATE-----")
  Sign AuthnRequest: Boolean (Optional: Enable if your service provider requires signed requests. If enabled, copy the Service provider Public Certificate from Lokalise into a .crt file and import it.)
```

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

### Lokalise SSO Login

Source: https://docs.lokalise.com/en/articles/7150706-google-saml

Instructions on how to log in to Lokalise using Single Sign-On (SSO) after the Google Workspace SAML configuration is complete. This includes the URL to use and the initial confirmation process.

```APIDOC
Lokalise SSO Login:

1. Once the SAML configuration is complete in both Google Workspace and Lokalise, navigate to https://app.lokalise.com/sso.
2. Enter the user email associated with your Google domain.
3. Upon the first login, you will be prompted to confirm your email address.
```

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

### Lokalise Web In-Context Editor

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Overview of the Web In-Context Editor, allowing translators to edit content directly within the live application interface.

```APIDOC
WebInContextEditor:
  Features:
    - Real-time translation updates
    - Visual context for translators
    - Direct editing of UI elements
```

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

### Lokalise Snapshots and Translation Memory

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Details the functionality for creating project snapshots and utilizing translation memory to improve efficiency and consistency.

```APIDOC
Snapshots:
  Create(projectId: str, ...)
    Parameters:
      projectId: The ID of the project.
    Returns:
      SnapshotID: The ID of the created snapshot.

TranslationMemory:
  Import(projectId: str, file: file_object, ...)
    Parameters:
      projectId: The ID of the project.
      file: The translation memory file to import.
    Returns:
      ImportStatus: Confirmation of import.
```

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

### Webhooks Documentation Reference

Source: https://docs.lokalise.com/en/articles/3184756-webhooks

Provides detailed documentation on Lokalise webhooks, covering their functionality, setup, and integration capabilities. This serves as a comprehensive guide for developers looking to leverage webhooks for automation and system integration.

```APIDOC
Webhooks Guide:
  Purpose: Automate workflows by sending real-time updates to external systems when specific events occur in Lokalise projects.
  Mechanism: Lokalise sends HTTP POST requests to a user-defined endpoint (URL) when events like translation updates or task completions happen.
  Benefits: Facilitates event-driven workflows, integrates Lokalise with other platforms/services, and keeps systems synchronized without manual intervention.
  Related Resources:
    - Developer Hub: https://developers.lokalise.com/docs/webhooks-guide
    - Related Integrations:
      - Slack: https://docs.lokalise.com/en/articles/1525912-slack
      - GitHub: https://docs.lokalise.com/en/articles/1684090-github
      - Zapier: https://docs.lokalise.com/en/articles/4775282-zapier
      - Azure DevOps repos: https://docs.lokalise.com/en/articles/5075937-azure-devops-repos
      - Lokalise Messages for Dixa: Installation guide: https://docs.lokalise.com/en/articles/6751523-lokalise-messages-for-dixa-installation-guide
```

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

### Team Visibility and Joining

Source: https://docs.lokalise.com/en/articles/2967175-onboarding-guide-for-translators

Explains how teams are displayed based on email domain and the process of joining a team, including the 'Join' and 'Request' buttons. Mentions that team visibility can be configured and links to further documentation.

```en
Teams are displayed based on your email domain. For example, if you register with `hello@lokalise.com`, only teams connected to `lokalise.com` will appear.
In some cases, instead of **Join** , you may see a **Request** button—this means a team admin must approve your enrollment. If you’re unsure which email to use, ask your team administrator. More details on joining existing teams can be found in the [Team visibility](https://intercom.help/lokalise-help/en/articles/6288137-team-visibility) article.
```

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

### Lokalise Advanced Task Options

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Explains the advanced options available when creating or configuring Lokalise tasks, which allow for finer control over the workflow and task completion.

```APIDOC
Advanced Task Options:
  Auto-mark items as completed on edit: Automatically marks items as completed when their translation is saved.
  Auto-close languages: Automatically closes sub-tasks for a language when all translations for that language are completed.
  Auto-close task: Automatically closes the entire task when all sub-tasks are completed. Closed tasks cannot be reopened.
  Tag keys after the task is closed: Assigns tags to keys involved in the task upon its closure.
  Lock translations: Restricts modifications to translations within the task to assigned contributors only.
  Include task creator as assignee: Adds the task creator to the task for progress tracking.
  Include task managers as assignees: Adds contributors with 'Manage task' permission to the task for progress tracking.
  Restrict assignees to custom translation statuses: Allows specifying custom statuses assignees can apply. Requires custom translation statuses to be enabled.
```

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

### Jira Application Link Setup

Source: https://docs.lokalise.com/en/articles/5106913-jira

Guide for setting up an application link in Jira to connect with Lokalise. This includes creating a new link, providing Lokalise's URL, and configuring incoming authentication with a consumer key, name, and public key.

```APIDOC
Jira Admin -> Cog Icon -> Applications -> Application Links

Create New Link:
  URL: https://lokalise.com
  Application Name: Lokalise

Incoming Authentication:
  Consumer Key: <unique_consumer_key>
  Consumer Name: lokalise
  Public Key: <content_of_public_key_file>
```

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

### Contentful App Installation and Configuration

Source: https://docs.lokalise.com/en/articles/8067631-contentful-native-beta

Step-by-step instructions for installing the Lokalise app from the Contentful marketplace, connecting it to your Lokalise account, and selecting content types for integration. Includes guidance on handling authorization popups and saving settings.

```APIDOC
Install Lokalise App from Contentful Marketplace:
1. Open Contentful and navigate to the Apps section.
2. Select Marketplace, then choose the Translation and Localization category.
3. Find Lokalise and click on it.
4. Press Install.
5. Select the environment for installation (only one environment at a time).
6. Click Connect to link to Lokalise.
7. Allow access in the new browser tab for authorization.
8. Return to the original tab and select content types for the Lokalise app.
9. Click Install in the top right corner.
10. Review default settings and click Save.
```

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

### Google Workspace SAML App Configuration

Source: https://docs.lokalise.com/en/articles/7150706-google-saml

This section outlines the steps to create and configure a custom SAML application within Google Workspace to integrate with Lokalise for SSO. It includes copying necessary SSO details from Google to Lokalise and vice-versa.

```APIDOC
Google SAML App Configuration:

Step 1: Create the SAML app in Google Workspace
  1. Navigate to admin.google.com.
  2. Go to Apps > Web and mobile apps > Add app > Add custom SAML app.
  3. Enter an App name (e.g., 'Lokalise SSO') and optionally upload an icon.
  4. On the SSO configuration screen, copy the following values and paste them into the corresponding fields in Lokalise SSO settings:
     - SSO URL → Lokalise: SAML 2.0 Endpoint (HTTP)
     - Entity ID → Lokalise: Identity Provider Issuer
     - Certificate → Lokalise: Public Certificate

Step 2: Configure Service provider details in Google SAML app
  1. Switch to the 'Service provider details' tab in the Google SAML app.
  2. Fill in the following details, obtained from your Lokalise SSO settings:
     - ACS URL: Copy the ACS URL Preview from Lokalise.
     - Entity ID: Enter "https://lokalise.com"
     - Name ID format: Select 'Email'. Ensure the identifier is unique, stable, and pseudo-random (e.g., employee ID or primary email).

Step 3: Configure Attribute mapping in Google SAML app
  1. Click 'Add mapping'.
  2. Add the following attribute mappings:
     - Google directory attribute: Basic information > First name | App attribute: `first_name`
     - Google directory attribute: Basic information > Last name | App attribute: `last_name`
     - Google directory attribute: Basic information > Primary email | App attribute: `User.Email`

Step 4: Finish setup
  1. Click 'Finish' to complete the app creation in Google Workspace.
```

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

### Lokalise Glossary and QA Checks

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Information on managing project glossaries and configuring Quality Assurance (QA) checks to maintain translation consistency and accuracy.

```APIDOC
Glossary:
  AddTerm(projectId: str, term: str, definition: str, ...)
    Parameters:
      projectId: The ID of the project.
      term: The term to add to the glossary.
      definition: The definition or translation of the term.
    Returns:
      TermID: The ID of the added glossary term.

QA Checks:
  Configure(projectId: str, checks: list, ...)
    Parameters:
      projectId: The ID of the project.
      checks: A list of QA checks to enable (e.g., 'missing_translation', 'double_punctuation').
    Returns:
      ConfigStatus: Confirmation of QA check configuration.
```

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

### Assigning Style Guides to Tasks

Source: https://docs.lokalise.com/en/articles/8217808-style-guide

Explains how style guides are linked to translation tasks. A general style guide is automatically connected, while language-specific guides are connected only if the target language matches.

```text
General guide: Automatically connected to the task.
Language-specific guide: Connected if the target language is selected during the 'Scope and assignees' step.
AI Translation Task: If synced with Lokalise AI, it will be used for generating translations.
```

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

### Two-Factor Authentication Setup Guide

Source: https://docs.lokalise.com/en/articles/2329387-two-factor-authentication

This section details the process of setting up two-factor authentication (2FA) for your Lokalise account. It involves using an authenticator app on your smartphone to generate verification codes after entering your password. This adds an extra layer of security to your account login process.

```APIDOC
Two-Factor Authentication Setup:

1. Enable 2FA in your Lokalise account settings.
2. Scan the provided QR code with your authenticator app (e.g., Google Authenticator, LastPass Authenticator, Microsoft Authenticator).
3. Enter the verification code displayed in the authenticator app into Lokalise to confirm setup.

Usage:
After setup, you will be prompted to enter a code from your authenticator app each time you log in, in addition to your password.
```

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

### Lokalise Analytics Overview

Source: https://docs.lokalise.com/en/articles/2983736-onboarding-guide-for-project-managers

Provides information on Lokalise Analytics, a feature for gaining insights into project performance, task efficiency, and volume analysis to aid in decision-making and resource allocation.

```APIDOC
Feature: Lokalise Analytics

- Description: Delivers insights for informed decision-making, saving time, and better resource allocation.
- Capabilities: Monitor task efficiency, get performance overviews, analyze task volume, and more.
- Reference: https://docs.lokalise.com/en/articles/9204943-lokalise-analytics
```

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

### Language Mapping for Machine Translation

Source: https://docs.lokalise.com/en/articles/5166158-machine-translation

Explains how Lokalise handles regional language variations with machine translation providers. It details a progressive mapping approach, starting with base languages and moving to regional variants if supported by the provider. Examples are given for Austrian German and Brazilian Portuguese with DeepL.

```en
Language mapping prioritizes specific regional variants if supported by the MT provider.
Example with DeepL:
- If de_AT is not supported, defaults to de (German).
- If pt_BR is supported, uses the specific engine for Brazilian Portuguese.
- If pt is supported, uses the specific engine for general Portuguese.
```