Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

361 lines (239 sloc) 9.615 kB

Usage guide

This document briefly covers how to translate application using Weblate.

Registration

While everybody can browse projects, view translations or suggest them, only registered users are allowed to actually save changes and are credited for every translation made.

You can register following two simple steps:

  1. Fill out the registration form with your credentials
  2. Activate registration by following in email you receive
  3. Possibly adjust your profile to choose which languages you know

User profile

User profile contains your preferences, name and email. Name and email are being used in Git commits, so keep this information accurate.

Languages

Choose here which languages you prefer to translate. These will be offered to you on main page to have easier access to translations.

Secondary languages

You can define secondary languages, which will be shown you while translating together with source language. Example can be seen on following image, where Czech language is shown as secondary:

_static/secondary-language.png

Projects structure

Each project can contain various subprojects. The reason for this structure is that all subprojects in a project are expected to have a lot in common. Whenever translation is made in single subproject, it is automatically propagated to others within same project (this is especially useful when translating more version of same project).

Translation links

Once you navigate to translation, you will be shown set of links which lead to translation. These are results of various checks, like untranslated or fuzzy strings. Should no other checks fire, there will be still link to all translations. Alternatively you can use search field to find translation you need to fix.

Translating

On translate page, you are shown source string and edit area for translating. Should the translation be plural, multiple source strings and edit areas are shown, each described with label for plural form.

Any special whitespace chars are underlined in red and indicated with grey symbols. Also more than one space is underlined in red to allow translator to keep formatting.

There are various extra information which can be shown on this page. Most of them are coming from the project source code (like context, comments or where the message is being used). When you configure secondary languages in your preferences, translation to these languages will be shown.

Bellow translation can be also shown suggestions from other users, which you can accept or delete.

Translation context

Translation context part allows you to see related information about current string.

Nearby messages
Displays messages which are located nearby in translation file. These usually are also used in similar context and you might want to check them to keep translation consistent.
Similar messages
Messages which are similar to currently one, which again can help you to stay consistent within translation.
All locations
In case message appears in multiple places (eg. multiple subprojects), this tab shows all of them and for inconsistent translations (see :ref:`check-inconsistent`) you can choose which one to use.
Dictionary
Displays words from project dictionary which are used in current message.
Recent edits
List of people who have changed this message recently using Weblate.
Project
Project information like instructions for translators or information about Git repository.

Dictionary

Each project can have assigned dictionary for any language. This could be used for storing terminology for given project, so that translations are consistent. You can display terms from currently translated string in bottom tabs.

Suggestions

As an anonymous user, you have no other choice than making a suggestion. However if you are logged in you can still decide to make only a suggestion instead of saving translation, for example in case you are unsure about the translation and you want somebody else to review it.

Machine translation

Based on configuration and your language, Weblate provides buttons for following machine translation tools.

MyMemory

Huge translation memory with machine translation.

Apertium

A free/open-source machine translation platform providing translation to limited set of lanugages.

Microsoft Translator

Machine translation service provided by Microsoft.

Checks

Weblate does wide range of consistency checks on messages. The following section describes them in more detail. The checks take account also special rules for different languages, so if you think the result is wrong, please report a bug.

Translation checks

These are executed on every translation change and help translators to keep good quality of translations.

Not translated

The source and translated strings are same at least in one of plural forms. This checks ignores some strings which are quite usually same in all languages.

Starting newline

Source and translated do not both start with a newline.

Trailing newline

Source and translated do not both end with a newline.

Starting spaces

Source and translation do not both start with same number of spaces. Space in beginning is usually used for indentation in the interface and thus is important.

Trailing space

Source and translated do not both end with a space.

Trailing stop

Source and translated do not both end with a full stop. Full stop is also checked in various language variants (Chinese, Japanese, Devanagari or Urdu).

Trailing colon

Source and translated do not both end with a colon or colon is not correctly spaced. This includes spacing rules for French or Breton. Colon is also checked in various language variants (Chinese or Japanese).

Trailing question

Source and translated do not both end with question mark or it is not correctly spaced. This includes spacing rules for French or Breton. Question mark is also checked in various language variants (Armenian, Arabic, Chinese, Korean, Japanese, Ethiopic, Vai or Coptic).

Trailing exclamation

Source and translated do not both end with exclamation mark or it is not correctly spaced. This includes spacing rules for French or Breton. Exclamation mark is also check in various langauge variants (Chinese, Japanese, Korean, Armenian, Limbu, Myanmar or Nko).

Trailing ellipsis

Source and translation do not both end with an ellipsis. This only checks for real ellipsis (u2026) not for three commas (...).

Python format

Python format string does not match source.

PHP format

PHP format string does not match source.

C format

C format string does not match source.

Missing plurals

Some plural forms are not translated. Check plural form definition to see for which counts each plural form is being used.

Inconsistent

More different translations of one string in a project. This can also lead to inconsistencies in displayed checks. You can find other translations of this string on :guilabel:`All locations` tab.

Invalid text direction

Text direction can be either LTR or RTL.

Mismatched \n

Number of \n in translation does not match source. Usually escaped newlines are important for formatting program output, so this should match to source.

Mismatched BBcode

BBcode in translation does not match source. The method for detecting BBcode is currently quite simple.

Zero-width space

Translation contains extra zero-width space (<U+200B>) character. This character is usually inserted by mistake.

XML tags mismatch

XML tags in translation do not match source. This usually means resulting output will look different. In most cases this is not desired result from translation, but occasionally it is desired.

Source checks

Source checks can help developers to improve quality of source strings.

Optional plural

The string is optionally used as plural, but not using plural forms. In case your translation system supports this, you should use plural aware variant of it.

For example with Gettext in Python it could be:

from gettext import ngettext

print ngettext('Selected %d file', 'Selected %d files', files) % files

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…). Using unicode character is in most cases better approach and looks better.

Jump to Line
Something went wrong with that request. Please try again.