LingoHub Help Center

Our experience, knowledge and lessons learned - all here just for you.

Getting started guide for developers

In our getting started guide for project managers, we covered most of our UI functionalities. In this guide, we are going to focus on the features that are more relevant to developers, such as the resource files specifications, repository integration, and usages of our public API.

Resource files

Resource files are containing the text that needs to be translated.

Lingohub supports a large set of resource file types and provides details about the specifications that are particular to each resource file type. Additionally, a set of guidelines to ensure a smooth integration are available. Please check out this documentation to ensure that the resource files you want to upload are valid.

You can specify placeholders in your resource file. These are terms you want to keep from being translated (e.g., brand-related terms).

You can also add comments in your resource files to provide more information about a text segment. This can help with translation or can set up Lingochecks rules.

The example below shows a java .properties resource file containing a placeholder and a LingoChecks rule.

greeting = Hello, welcome to this demo
placeholder = This is a text with a {placeholder}
lang.en = English
# lh-check { min: 10 }
lang.fr = French
lang.es = Spanish

Repository integration

It is possible to link your LingoHub project with a repository. This will help you synchronize your files between LingoHub and your repository branch. The resource files will be automatically pulled from your repository every time a file is updated.

To connect to a repository, follow the steps below:

  1. Click Dashboard in the top navigation bar.

  2. Click Repository in the dashboard.

    Img

  3. Select your repository provider.

Choose the repository provider of your choice and follow the wizard's instructions.

Img

In the wizard:

  1. Select your repository and your branch.

  2. Define your watch pattern - this determines which files LingoHub should watch and it corresponds to the location of the files you want to synchronize with your project's resource files.

  3. Finish the setup.

    Note: When you enter your watch pattern, please keep in mind that LingoHub only detects the files matching your project's platform.

Packages

Easy to use and powerful, the packages help you manage the versioning of your application and give you the possibility to backup your translations regularly. You can find more information about packages and how to use them in this guide.

Img

Public API

Lingohub has a public REST API available to developers.

You can use the API if you simply need to check on a project's status without having to log into your Lingohub account, for example. Adding a Lingohub integration to your project and building a custom plugin to upload/download your resource files would be another example.

If you want to learn more about our REST API (e.g., authentication, endpoints, etc.) please check out this documentation.

Congratulations! You finished our getting started guide for developers. If there's anything we can help you with, please get in touch with our support.

Ready to optimize your translation workflow?