Weblate is a copylefted libre software web-based continuous localization system, used by over 1150 libre projects and companies in more than 115 countries.

Install it, or use the Hosted Weblate service at weblate.org.

https://readthedocs.org/projects/weblate/badge/

Asistencia¶

Weblate is a libre software with optional professional support and cloud hosting offerings. Check out https://weblate.org/hosting/ for more information.

Documentación¶

To be found in the docs directory of the source code, or viewed online on https://docs.weblate.org/

Instalación¶

Setup instructions:

https://docs.weblate.org/en/latest/admin/install.html

Bugs¶

Please report feature requests and problems to:

https://github.com/WeblateOrg/weblate/issues

Licencia¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Fundamentos de Weblate¶

Estructura de los proyectos¶

In Weblate translations are organized into projects and components. Each project can contain number of components and those contain translations into individual languages. The component corresponds to one translatable file (for example GNU gettext or Recursos de cadenas de Android). The projects are there to help you organize component into logical sets (for example to group all translations used within one application).

Internally, each project has translations to common strings propagated across other components within it by default. This lightens the burden of repetitive and multi version translation. Disable it as per Configuración de componentes, still producing errors for seemingly inconsistent resulting translations.

Registro y perfil de usuario¶

Registro¶

Everybody can browse projects, view translations or suggest translations by default. Only registered users are allowed to actually save changes, and are credited for every translation made.

You can register by following a few simple steps:

Fill out the registration form with your credentials.
Activate registration by following the link in the e-mail you receive.
Optionally adjust your profile to choose which languages you know.

Cuadro de mando¶

When you sign in, you will see an overview of projects and components, as well as their respective translation progression.

Nuevo en la versión 2.5.

Components of projects you are watching are shown by default, and cross-referenced with your preferred languages.

Consejo

You can switch to different views using the navigation tabs.

The menu has these options:

Projects > Browse all projects in the main menu showing translation status for each project on the Weblate instance.
Selecting a language in the main menu Languages will show translation status of all projects, filtered by one of your primary languages.
Watched translations in the Dashboard will show translation status of only those projects you are watching, filtered by your primary languages.

In addition, the drop-down can also show any number of component lists, sets of project components preconfigured by the Weblate administrator, see Listas de componentes.

You can configure your personal default dashboard view in the Preferences section of your user profile settings.

Nota

When Weblate is configured for a single project using SINGLE_PROJECT in the settings.py file (see Configuración), the dashboard will not be shown, as the user will be redirected to a single project or component instead.

Perfil de usuario¶

The user profile is accessible by clicking your user icon in the top-right of the top menu, then the Settings menu.

El perfil de usuario contiene sus preferencias. El nombre y la dirección de correo electrónico se utilizan para las consignas de los sistemas de control de versiones, de modo que mantenga estos datos al día.

Nota

All language selections only offer currently translated languages.

Consejo

Request or add other languages you want to translate by clicking the button to make them available too.

Idiomas traducidos¶

Choose which languages you prefer to translate, and they will be offered on the main page of watched projects, so that you have easier access to these all translations in each of those languages.

Idiomas secundarios¶

You can define which secondary languages are shown to you as a guide while translating. An example can be seen in the following image, where the Hebrew language is shown as secondarily:

Vista predeterminada del cuadro de mando¶

On the Preferences tab, you can pick which of the available dashboard views to present by default. If you pick the Component list, you have to select which component list will be displayed from the Default component list drop-down.

Ver también

Listas de componentes

Avatar¶

Avatar can be shown for each user (depending on ENABLE_AVATARS). These images are obtained using https://gravatar.com/.

Enlace del editor¶

A source code link is shown in the web-browser configured in the Configuración de componentes by default.

Consejo

By setting the Editor link, you use your local editor to open the VCS source code file of translated strings. You can use Template markup.

Usually something like editor://open/?file={{filename}}&line={{line}} is a good option.

Ver también

You can find more info on registering custom URL protocols for the editor in the Nette documentation.

Notificaciones¶

Subscribe to various notifications from the Notifications tab. Notifications for selected events on watched or administered projects will be sent to you per e-mail.

Some of the notifications are sent only for events in your languages (for example about new strings to translate), while some trigger at component level (for example merge errors). These two groups of notifications are visually separated in the settings.

You can toggle notifications for watched projects and administered projects and it can be further tweaked (or muted) per project and component. Visit the component page and select appropriate choice from the Watching menu.

Nota

You will not receive notifications for your own actions.

Cuenta¶

The Account tab lets you set up basic account details, connect various services you can use to sign in into Weblate, completely remove your account, or download your user data (see Weblate user data export).

Nota

The list of services depends on your Weblate configuration, but can be made to include popular sites such as GitLab, GitHub, Google, Facebook, or Bitbucket or other OAuth 2.0 providers.

Registro de auditoría¶

Audit log keeps track of the actions performed with your account. It logs IP address and browser for every important action with your account. The critical actions also trigger a notification to a primary e-mail address.

Ver también

Running behind reverse proxy

Traducir con Weblate¶

Thank you for interest in translating using Weblate. Projects can either be set up for direct translation, or by way of accepting suggestions made by users without accounts.

Overall, there are two modes of translation:

El proyecto acepta traducciones directas
El proyecto acepta solo sugerencias, las cuales se validan automáticamente tras recibir una cantidad de votos determinada

Please see Flujos de trabajo de traducción for more information on translation workflow.

Opciones de visibilidad de los proyectos de traducción:

Visible públicamente y cualquiera puede contribuir
Visible solo a un grupo determinado de traductores

Ver también

Control de acceso, Flujos de trabajo de traducción

Proyectos de traducción¶

Translation projects hold related components, related to the same software, book, or project.

Enlaces de traducción¶

Having navigated to a component, a set of links lead to actual translation. The translation is further divided into individual checks, like Untranslated or Needing review. If the whole project is translated, without error, All translations is still available. Alternatively you can use the search field to find a specific string or term.

Sugerencias¶

Nota

Actual permissions might vary depending on your Weblate configuration.

Anonymous users can only (if permitted) forward suggestions. Doing so is still available to signed in users, in cases where uncertainty about the translation arises, which will prompt another translator to review it.

The suggestions are scanned on a daily basis to remove duplicate ones or suggestions that match the current translation.

Comentarios¶

The comments can be posted in two scopes - source string or translation. Choose the one which matches the topic you want to discuss. The source string comments are good for providing feedback on the original string, for example that it should be rephrased or it is confusing.

You can use Markdown syntax in the comments and mention other users using @mention.

Variantes¶

Variants are used to group variants of the string in different lengths. The frontend can use different strings depending on the screen or window size.

Ver también

String variants

Etiquetas¶

Labels are used to categorize strings within a project. These can be used to further customize the localization workflow, for example to define categories of strings.

Ver también

Etiquetas de cadena

Traducción¶

On the translation page, the source string and an edit area for translating are shown. Should the translation be plural, multiple source strings and edit areas are shown, each described and labeled in plural form.

All special whitespace characters are underlined in red and indicated with grey symbols. More than one subsequent space is also underlined in red to alert the translator to a potential formatting issue.

Various bits of extra information can be shown on this page, most of which coming from the project source code (like context, comments or where the message is being used). When you choose secondary languages in your preferences, translation to these languages will be shown (see Idiomas secundarios) above the source string.

Debajo de la traducción se mostrarán cualesquier sugerencias que otros hicieren, las cuales puede aceptar, aceptar con modificaciones o eliminar.

Plurales¶

Las palabras que cambian de forma para indicar su designación de número se denominan plurales. Cada lengua tiene su propia definición de plurales. El español, por ejemplo, admite un plural. En la definición singular de, por ejemplo, «automóvil», se hace referencia implícita a un único automóvil; en la definición plural, «automóviles», se hace referencia a dos o más automóviles, o bien, al concepto de automóviles sustantivado. En lenguas como el checo y el árabe existen más plurales; además, las reglas de pluralización que emplean también difieren.

Weblate has full support for each of these forms, in each respective language by translating every plural separately. The number of fields and how it is used in the translated application depends on the configured plural formula. Weblate shows the basic information, but you can find a more detailed description in the Language Plural Rules by the Unicode Consortium.

Ver también

Fórmula de plurales

Atajos de teclado¶

Distinto en la versión 2.18: Se han renovado los atajos de teclado en la versión 2.18 para hacer menos probable que entren en conflicto con los atajos predeterminados del navegador o del sistema.

Los atajos de teclado siguientes pueden utilizarse durante la traducción:

Alt+Home: Navegar a la primera traducción de la búsqueda actual.
Alt+End: Navegar a la última traducción de la búsqueda actual.
Alt+PageUp: Navegar a la traducción anterior de la búsqueda actual.
Alt+PageDown: Navegar a la traducción siguiente de la búsqueda actual.
Alt+Enter, Ctrl+Enter, or Cmd+Enter: Guardar la traducción actual.
Ctrl+Shift+Enter or Cmd+Shift+Enter: Unmarks translation as fuzzy and submits it.
Ctrl+E or Cmd+E: Focus translation editor.
Ctrl+U or Cmd+U: Focus comment editor.
Ctrl+M or Cmd+M: Shows machine translation tab.
Ctrl+<NUMBER> or Cmd+<NUMBER>: Copies placeable of given number from source string.
Ctrl+M <NUMBER> or Cmd+M <NUMBER>: Copy the machine translation of given number to current translation.
Ctrl+I <NUMBER> or Cmd+I <NUMBER>: Ignorar un elemento en la lista de comprobaciones fallidas.
Ctrl+J or Cmd+J: Shows the Nearby strings tab.
Ctrl+S or Cmd+S: Shows search tab.
Ctrl+O or Cmd+O: Copies source string.
Ctrl+Y or Cmd+Y: Toggles the Needs editing flag.

Visual keyboard¶

A small visual keyboard is shown just above the translation field. This can be useful for typing characters not usually found or otherwise hard to type.

The shown symbols factor into three categories:

User configured characters defined in the Perfil de usuario
Per language characters provided by Weblate (e.g. quotes or RTL specific characters)
Chars configured using SPECIAL_CHARS

Translation context¶

This contextual description provides related information about the current string.

String attributes: Things like message ID, context (msgctxt) or location in source code.
Capturas de pantalla: Screenshots can be uploaded to Weblate to better inform translators of where and how the string is used, see Contexto visual para cadenas.
Cadenas cercanas: Displays neighbouring messages from the translation file. These are usually also used in a similar context and prove useful in keeping the translation consistent.
Otras ocurrencias: In case a message appears in multiple places (e.g. multiple components), this tab shows all of them if they are found to be inconsistent (see Incoherente). You can choose which one to use.
Memoria de traducción: Look at similar strings translated in past, see Memory Management.
Glosario: Displays terms from the project glossary used in the current message.
Cambios recientes: List of people whom have changed this message recently using Weblate.
Proyecto: Project information like instructions for translators, or information about its version control system repository.

If the translation format supports it, you can also follow supplied links to respective source code containing each source string.

Translation history¶

Every change is by default (unless turned off in component settings) saved in the database, and can be reverted. Optionally one can still also revert anything in the underlying version control system.

Translated string length¶

Weblate puede limitar la longitud de la traducción de varias formas para garantizar que la cadena traducida no sea demasiado extensa:

The default limitation for translation is ten times longer than source string. This can be turned of by LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH. In case you are hitting this, it might be also caused by monolingual translation being configured as bilingual, making Weblate see translation key as source string instead of the actual source string. See Formatos bilingües y monolingües for more info.
Maximal length in characters defined by translation file or flag, see Longitud máxima de la traducción.
Maximal rendered size in pixels defined by flags, see Tamaño máximo de la traducción.

Glosario¶

Each project can have an assigned glossary for any language as a shorthand for storing terminology. Consistency is more easily maintained this way. Terms from the currently translated string can be displayed in the bottom tabs.

Gestionar glosarios¶

On the Glossaries tab of each project page, you can edit existing glossaries.

An empty glossary for a given project is automatically created when project is created. Glossaries are shared among all components of the same project and you can also choose to share them with another projects. You can do this only for projects you can administer.

On this list, you can choose which glossary to manage (all languages used in the current project are shown). Following one of the language links will lead you to a page which can be used to edit, import or export the selected glossary, or view the edit history:

Traducción automática¶

Based on configuration and your translated language, Weblate provides you suggestions from several machine translation tools. All machine translations are available in a single tab of each translation page.

Ver también

You can find the list of supported tools in Traducción automática.

Traducción automática¶

You can use automatic translation to bootstrap translation based on external sources. This tool is called Automatic translation accessible in the Tools menu, once you have selected a component and a language:

Two modes of operation are possible:

Using other Weblate components as a source for translations.
Using selected machine translation services with translations above a certain quality threshold.

You can also choose which strings are to be auto-translated.

Advertencia

Be mindful that this will overwrite existing translations if employed with wide filters such as All strings.

Useful in several situations like consolidating translation between different components (for example website and application) or when bootstrapping translation for a new component using existing translations (translation memory).

Ver también

Mantener iguales las traducciones entre los componentes

Rate limiting¶

To avoid abuse of the interface, there is rate limiting applied to several operations like searching, sending contact form or translating. In case you are hit by this, you are blocked for a certain period until you can perform the operation again.

The default limits are described in the administrative manual in Rate limiting, but can be tweaked by configuration.

Edición en masa¶

Bulk edit allows you to perform operation on number of strings. You define search strings and operation to perform and all matching strings are updated. Following operations are supported:

Changing string state (for example to approve all strings waiting for review)
Adjust translation flags (see Customizing behavior)
Adjust string labels (see Etiquetas de cadena)

Consejo

This tool is called Bulk edit accessible in the Tools menu for each project, component or translation.

Ver también

Bulk edit addon

Descargar y cargar traducciones¶

You can export files from a translation, make changes, and import them again. This allows working offline, and then merging changes back into the existing translation. This works even if it has been changed in the meantime.

Nota

The available options might be limited by Control de acceso.

Descargar traducciones¶

From the project or component dashboard, translatable files can be downloaded using the Download original translation file in the Files menu, producing a copy of the original file as it is stored in the upstream Version Control System.

You can also download the translation converted into one of widely used localization formats. The converted files will be enriched with data provided in Weblate such as additional context, comments or flags.

Several file formats are available, including a compiled file to use in your choice of application (for example .mo files for GNU Gettext) using the Files menu.

Cargar traducciones¶

When you have made your changes, use Upload translation in the Files menu.

Formatos de archivo admitidos¶

Any file in a supported file format can be uploaded, but it is still recommended to use the same file format as the one used for translation, otherwise some features might not be translated properly.

Ver también

Formatos de archivo admitidos

The uploaded file is merged to update the translation, overwriting existing entries by default (this can be turned off or on in the upload dialog).

Métodos de importación¶

Estas son las elecciones presentadas al cargar archivos de traducción:

Añadir como traducción (translate): Las traducciones importadas se añaden como traducciones adicionales. Este constituye el caso de uso más común y es el comportamiento predeterminado.
Añadir como sugerencia (suggest): Las traducciones importadas se añaden como sugerencias. Recomendado si quiere que otros revisen lo que se ha cargado.
Añadir como traducción que requiere edición (fuzzy): Imported translations are added as translations needing edit. This can be useful when you want translations to be used, but also reviewed.
Reemplazar archivo de traducción existente (replace): Existing file is replaced with new content. This can lead to loss of existing translations, use with caution.
Actualizar cadenas de origen (source): Updates source strings in bilingual translation file. This is similar to what Actualizar archivos PO para que coincidan con POT (msgmerge) does.

Ver también

POST /api/translations/(string:project)/(string:component)/(string:language)/file/

Conflicts handling¶

Defines how to deal with uploaded strings which are already translated.

Strings needing edit¶

There is also an option for how to handle strings needing edit in the imported file. Such strings can be handle in one of the three following ways: «Do not import», «Import as string needing edit», or «Import as translated».

Overriding authorship¶

With admin permissions, you can also specify authorship of uploaded file. This can be useful in case you’ve received the file in another way and want to merge it into existing translations while properly crediting the actual author.

Comprobaciones y correcciones¶

The quality checks help catch common translator errors, ensuring the translation is in good shape. The checks can be ignored in case of false positives.

Once submitting a translation with a failing check, this is immediately shown to the user:

Automatic fixups¶

In addition to Quality checks, Weblate can also fix some common errors in translated strings automatically. Use it with caution to not have it add errors.

Ver también

AUTOFIX_LIST

Quality checks¶

Weblate employs a wide range of quality checks on strings. The following section describes them all in further detail. There are also language specific checks. Please file a bug if anything is reported in error.

Ver también

CHECK_LIST, Customizing behavior

Translation checks¶

Executed upon every translation change, helping translators maintain good quality translations.

Marcación BBcode¶

BBcode in translation does not match source

BBCode represents simple markup, like for example highlighting important parts of a message in bold font, or italics.

This check ensures they are also found in translation.

Nota

The method for detecting BBcode is currently quite simple so this check might produce false positives.

Palabras consecutivas duplicadas¶

Text contains the same word twice in a row:

Nuevo en la versión 4.1.

Checks that no consecutive duplicate words occur in a translation. This usually indicates a mistake in the translation.

Consejo

This check includes language specific rules to avoid false positives. In case it triggers falsely in your case, let us know. See Informar de problemas en Weblate.

Espacio doble¶

Translation contains double space

Checks that double space is present in translation to avoid false positives on other space-related checks.

Check is false when double space is found in source meaning double space is intentional.

Formatted strings¶

Checks that formatting in strings are replicated between both source and translation. Omitting format strings in translation usually causes severe problems, so the formatting in strings should usually match the source.

Weblate supports checking format strings in several languages. The check is not enabled automatically, only if a string is flagged appropriately (e.g. c-format for C format). Gettext adds this automatically, but you will probably have to add it manually for other file formats or if your PO files are not generated by xgettext.

This can be done per unit (see Información adicional sobre las cadenas de origen) or in Configuración de componentes. Having it defined per component is simpler, but can lead to false positives in case the string is not interpreted as a formatting string, but format string syntax happens to be used.

Consejo

In case specific format check is not available in Weblate, you can use generic Sustitutorios.

Besides checking, this will also highlight the formatting strings to easily insert them into translated strings:

Cadena de interpolación de AngularJS¶

AngularJS interpolation strings do not match source

Named format string	`Your balance is {{amount}} {{ currency }}`
Flag to enable	angularjs-format

Ver también

AngularJS: API: $interpolate

Formato C¶

C format string does not match source

Simple format string	`There are %d apples`
Position format string	`Your balance is %1$d %2$s`
Flag to enable	c-format

Ver también

C format strings, C printf format

Formato C#¶

C# format string does not match source

Position format string	`There are {0} apples`
Flag to enable	c-sharp-format

Ver también

C# String Format

Literales de plantilla ECMAScript¶

ECMAScript template literals do not match source

Interpolación	`There are ${number} apples`
Flag to enable	es-format

Ver también

Template literals

Interpolación con i18next¶

The i18next interpolation does not match source

Nuevo en la versión 4.0.

Interpolación	`There are {{number}} apples`
Nesting	`There are $t(number) apples`
Flag to enable	i18next-interpolation

Ver también

i18next interpolation

Formato Java¶

Java format string does not match source

Simple format string	`There are %d apples`
Position format string	`Your balance is %1$d %2$s`
Flag to enable	java-format

Ver también

Java Format Strings

Formato de mensaje Java¶

Java MessageFormat string does not match source

Position format string	`There are {0} apples`
Flag to enable	java-messageformat enables the check unconditionally
	auto-java-messageformat enables check only if there is a format string in the source

Ver también

Java MessageFormat

Formato JavaScript¶

JavaScript format string does not match source

Simple format string	`There are %d apples`
Flag to enable	javascript-format

Ver también

JavaScript formatting strings

Sustitutorios con signo de porcentaje¶

The percent placeholders do not match source

Nuevo en la versión 4.0.

Simple format string	`There are %number% apples`
Flag to enable	percent-placeholders

Formato Perl¶

Perl format string does not match source

Simple format string	`There are %d apples`
Position format string	`Your balance is %1$d %2$s`
Flag to enable	perl-format

Ver también

Perl sprintf, Perl Format Strings

Formato PHP¶

PHP format string does not match source

Simple format string	`There are %d apples`
Position format string	`Your balance is %1$d %2$s`
Flag to enable	php-format

Ver también

PHP sprintf documentation, PHP Format Strings

Formato de llaves de Python¶

Python brace format string does not match source

Simple format string	`There are {} apples`
Named format string	`Your balance is {amount} {currency}`
Flag to enable	python-brace-format

Ver también

Python brace format, Python Format Strings

Formato Python¶

Python format string does not match source

Simple format string	`There are %d apples`
Named format string	`Your balance is %(amount) %(currency)`
Flag to enable	python-format

Ver también

Python string formatting, Python Format Strings

Formato Qt¶

Qt format string does not match source

Position format string	`There are %1 apples`
Flag to enable	qt-format

Ver también

Qt QString::arg()

Formato de plurales de Qt¶

Qt plural format string does not match source

Plural format string	`There are %Ln apple(s)`
Flag to enable	qt-plural-format

Ver también

Qt i18n guide

Formato Ruby¶

Ruby format string does not match source

Simple format string	`There are %d apples`
Position format string	`Your balance is %1$f %2$s`
Named format string	`Your balance is %+.2<amount>f %<currency>s`
Named template string	`Your balance is %{amount} %{currency}`
Flag to enable	ruby-format

Ver también

Ruby Kernel#sprintf

Ha sido traducido¶

This string has been translated in the past

Means a string has been translated already. This can happen when the translations have been reverted in VCS or lost otherwise.

Incoherente¶

Esta cadena tiene más de una traducción en este proyecto o no se ha traducido en algunos componentes.

Weblate comprueba las traducciones de la misma cadena en todas sus ocurrencias dentro de un proyecto para ayudarle a mantener la coherencia.

The check fails on differing translations of one string within a project. This can also lead to inconsistencies in displayed checks. You can find other translations of this string on the Other occurrences tab.

Nota

This check also fires in case the string is translated in one component and not in another. It can be used as a quick way to manually handle strings which are not translated in some components just by clicking on the Use this translation button displayed on each line in the Other occurences tab.

You can use Traducción automática addon to automate translating of newly added strings which are already translated in another component.

Ver también

Mantener iguales las traducciones entre los componentes

Kashida utilizado¶

The decorative kashida letters should not be used

Nuevo en la versión 3.5.

The decorative Kashida letters should not be used in translation. These are also known as Tatweel.

Ver también

Kashida on Wikipedia

Enlaces de Markdown¶

Markdown links do not match source

Nuevo en la versión 3.5.

Markdown links do not match source.

Ver también

Enlaces de Markdown

Referencias de Markdown¶

Markdown link references do not match source

Nuevo en la versión 3.5.

Markdown link references do not match source.

Ver también

Enlaces de Markdown

Sintaxis de Markdown¶

Markdown syntax does not match source

Nuevo en la versión 3.5.

La sintaxis de Markdown no coincide con la de origen

Ver también

Markdown span elements

Longitud máxima de la traducción¶

Translation should not exceed given length

Checks that translations are of acceptable length to fit available space. This only checks for the length of translation characters.

Unlike the other checks, the flag should be set as a key:value pair like max-length:100.

Consejo

This checks looks at number of chars, what might not be the best metric when using proportional fonts to render the text. The Tamaño máximo de la traducción check does check actual rendering of the text.

The replacements: flag might be also useful to expand placeables before checking the string.

Tamaño máximo de la traducción¶

Translation rendered text should not exceed given size

Nuevo en la versión 3.7.

Translation rendered text should not exceed given size. It renders the text with line wrapping and checks if it fits into given boundaries.

This check needs one or two parameters - maximal width and maximal number of lines. In case the number of lines is not provided, one line text is considered.

You can also configure used font by font-* directives (see Customizing behavior), for example following translation flags say that the text rendered with ubuntu font size 22 should fit into two lines and 500 pixels:

max-size:500:2, font-family:ubuntu, font-size:22

Consejo

You might want to set font-* directives in Configuración de componentes to have the same font configured for all strings within a component. You can override those values per string in case you need to customize it per string.

The replacements: flag might be also useful to expand placeables before checking the string.

Ver también

Managing fonts, Customizing behavior, Longitud máxima de la traducción

n desiguales¶

Number of n in translation does not match source

Usually escaped newlines are important for formatting program output. Check fails if the number of \\n literals in translation do not match the source.

Dos puntos desiguales¶

Source and translation do not both end with a colon

Checks that colons are replicated between both source and translation. The presence of colons is also checked for various languages where they do not belong (Chinese or Japanese).

Ver también

Colon on Wikipedia

Puntos suspensivos desiguales¶

Source and translation do not both end with an ellipsis

Comprueba que tanto la cadena de origen como la traducción terminen con puntos suspensivos. Observe que se comprueba solo el carácter real de puntos suspensivos (…), no una secuencia de tres puntos (...).

El carácter real de puntos suspensivos a menudo tiene un mejor espaciado al imprimirlo y suena mejor cuando el texto se procesa en un conversor de texto a voz.

Ver también

Ellipsis on Wikipedia

Signo de exclamación desigual¶

Source and translation do not both end with an exclamation mark

Checks that exclamations are replicated between both source and translation. The presence of exclamation marks is also checked for various languages where they do not belong (Chinese, Japanese, Korean, Armenian, Limbu, Myanmar or Nko).

Ver también

Exclamation mark on Wikipedia

Punto final desigual¶

Source and translation do not both end with a full stop

Checks that full stops are replicated between both source and translation. The presence of full stops is checked for various languages where they do not belong (Chinese, Japanese, Devanagari or Urdu).

Ver también

Full stop on Wikipedia

Signo de interrogación desigual¶

Source and translation do not both end with a question mark

Comprueba que tanto la cadena de origen como la traducción tengan signos de interrogación. La presencia de estos signos también se comprueba en varios idiomas que no los utilizan (armenio, árabe, chino, coreano, japonés, etíope, vai y copto).

Ver también

Question mark on Wikipedia

Punto y coma desigual¶

Source and translation do not both end with a semicolon

Comprueba que los punto y coma al final de las oraciones de la cadena de origen y de la traducción sean una réplica mutua. Esto puede resultar útil para garantizar un buen formato de cadenas tales como las de los archivos .desktop.

Ver también

Semicolon on Wikipedia

Saltos de renglón desiguales¶

Number of new lines in translation does not match source

Por lo general, los saltos de renglón son importantes para dar formato a la salida de un programa. La comprobación emite un error si la cantidad de literales \n en la traducción difiere de la cantidad en la cadena de origen.

Faltan plurales¶

Some plural forms are not translated

Checks that all plural forms of a source string have been translated. Specifics on how each plural form is used can be found in the string definition.

Failing to fill in plural forms will in some cases lead to displaying nothing when the plural form is in use.

Sustitutorios¶

Translation is missing some placeholders:

Nuevo en la versión 3.9.

Translation is missing some placeholders. These are either extracted from the translation file or defined manually using placeholders flag, more can be separated with colon, strings with space can be quoted:

placeholders:$URL$:$TARGET$:"some long text"

Ver también

Customizing behavior

Espaciado de puntuación¶

Missing non breakable space before double punctuation sign

Nuevo en la versión 3.9.

Comprueba que haya un espacio indivisible delante de un signo de puntuación de componente doble (a saber: signo de exclamación, signo de interrogación, punto y coma y dos puntos). Esta regla se utiliza solamente en algunos idiomas, como el francés y el bretón, en los que la presencia de este espacio es una norma de microtipografía.

Ver también

French and English spacing on Wikipedia

Expresión regular¶

Translation does not match regular expression:

Nuevo en la versión 3.9.

Translation does not match regular expression. The expression is either extracted from the translation file or defined manually using regex flag:

regex:^foo|bar$

Mismos plurales¶

Some plural forms are translated in the same way

Esta comprobación emite un error si se han duplicado algunas formas de plural. En la mayoría de los idiomas deben ser diferentes.

Salto de renglón al inicio¶

Source and translation do not both start with a newline

Newlines usually appear in source strings for good reason, omissions or additions can lead to formatting problems when the translated text is put to use.

Ver también

Salto de renglón al final

Espacios iniciales¶

Source and translation do not both start with same number of spaces

Normalmente, si hay un espacio al inicio de una cadena es para crear sangrías en la interfaz; por esta razón es importante preservarlos.

Salto de renglón al final¶

Source and translation do not both end with a newline

Newlines usually appear in source strings for good reason, omissions or additions can lead to formatting problems when the translated text is put to use.

Ver también

Salto de renglón al inicio

Espacio al final¶

Source and translation do not both end with a space

Checks that trailing spaces are replicated between both source and translation.

Trailing space is usually utilized to space out neighbouring elements, so removing it might break layout.

Traducción no modificada¶

Source and translation are identical

Happens if the source and corresponding translation strings is identical, down to at least one of the plural forms. Some strings commonly found across all languages are ignored, and various markup is stripped. This reduces the number of false positives.

This check can help find strings mistakenly untranslated.

The default behavior of this check is to exclude words from the built-in blacklist from the checking. These are words which are frequently not being translated. This is useful to avoid false positives on short strings, which consist only of single word which is same in several languages. This blacklist can be disabled by adding strict-same flag to string or component.

Ver también

Configuración de componentes, Customizing behavior

HTML inseguro¶

The translation uses unsafe HTML markup

Nuevo en la versión 3.9.

The translation uses unsafe HTML markup. This check has to be enabled using safe-html flag (see Customizing behavior). There is also accompanied autofixer which can automatically sanitize the markup.

Ver también

The HTML check is performed by the Bleach library developed by Mozilla.

URL¶

The translation does not contain an URL

Nuevo en la versión 3.5.

The translation does not contain an URL. This is triggered only in case the unit is marked as containing URL. In that case the translation has to be a valid URL.

Marcado XML¶

XML tags in translation do not match source

This usually means the resulting output will look different. In most cases this is not a desired result from changing the translation, but occasionally it is.

Checks that XML tags are replicated between both source and translation.

Sintaxis XML¶

The translation is not valid XML

Nuevo en la versión 2.8.

The XML markup is not valid.

Espacio de anchura cero¶

Translation contains extra zero-width space character

Zero-width space (<U+200B>) characters are used to break messages within words (word wrapping).

As they are usually inserted by mistake, this check is triggered once they are present in translation. Some programs might have problems when this character is used.

Ver también

Zero width space on Wikipedia

Source checks¶

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

Puntos suspensivos¶

The string uses three dots (…) instead of an ellipsis character (…)

This fails when the string uses three dots (...) when it should use an ellipsis character (…).

Using the Unicode character is in most cases the better approach and looks better rendered, and may sound better with text-to-speech.

Ver también

Ellipsis on Wikipedia

Largamente no traducida¶

The string has not been translated for a long time

Nuevo en la versión 4.1.

When the string has not been translated for a long time, it is can indicate problem in a source string making it hard to translate.

Varias comprobaciones fallidas¶

The translations in several languages have failing checks

Numerous translations of this string have failing quality checks. This is usually an indication that something could be done to improve the source string.

This check failing can quite often be caused by a missing full stop at the end of a sentence, or similar minor issues which translators tend to fix in translation, while it would be better to fix it in the source string.

Varias variables sin nombre¶

There are multiple unnamed variables in the string, making it impossible for translators to reorder them

Nuevo en la versión 4.1.

There are multiple unnamed variables in the string, making it impossible for translators to reorder them.

Consider using named variables instead to allow translators to reorder them.

No pluralizada¶

The string is used as plural, but not using plural forms

The string is used as a plural, but does not use plural forms. In case your translation system supports this, you should use the 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

Búsquedas¶

Nuevo en la versión 3.9.

Advanced queries using boolean operations, parentheses, or field specific lookup can be used to find the strings you want.

When no field is defined, the lookup happens on Source, Target and Context fields.

Simple search¶

Any phrase typed into the search box is split into words. Strings containing any of them are shown. To look for an exact phrase, put «the searchphrase» into quotes (both single (“) and double («) quotes will work): "this is a quoted string" or 'another quoted string'.

Fields¶

source:TEXT: Source string case insensitive search.
target:TEXT: Target string case insensitive search.
context:TEXT: Context string case insensitive search.
key:TEXT: Key string case insensitive search.
note:TEXT: Comment string case insensitive search.
location:TEXT: Location string case insensitive search.
priority:NUMBER: String priority.
added:DATETIME: Timestamp for when the string was added to Weblate.
state:TEXT: State search (approved, translated, needs-editing, empty, read-only), supports Field operators.
pending:BOOLEAN: String pending for flushing to VCS.
has:TEXT: Search for string having attributes - plural, context, suggestion, comment, check, dismissed-check, translation, variant, screenshot (works only on source strings).
is:TEXT: Search for string states (pending, translated, untranslated).
language:TEXT: String target language.
component:TEXT: Component slug, see «Slug» del componente.
project:TEXT: Project slug, see «Slug» del proyecto.
changed_by:TEXT: String was changed by author with given username.
changed:DATETIME: String was changed on date, supports Field operators.
check:TEXT: String has failing check.
dismissed_check:TEXT: String has dismissed check.
comment:TEXT: Search in user comments.
comment_author:TEXT: Filter by comment author.
suggestion:TEXT: Search in suggestions.
suggestion_author:TEXT: Filter by suggestion author.

Boolean operators¶

You can combine lookups using AND, OR, NOT and parentheses to form complex queries. For example: state:translated AND (source:hello OR source:bar)

Field operators¶

You can specify operators, ranges or partial lookups for date or numeric searches:

state:>=translated: State is translated or better (approved).
changed:2019: Changed in year 2019.
changed:[2019-03-01 to 2019-04-01]: Changed between two given dates.

Operadores exactos¶

You can do an exact match query on different string fields using = operator. For example, to search for all source strings exactly matching hello world, use: source:="hello world". For searching single word expressions, you can skip quotes. For example, to search for all source strings matching hello, you can use: source:=hello.

Expresiones regulares¶

Anywhere text is accepted you can also specify a regular expression as r"regexp". For instance, to search for all source strings which contain any digit between 2 and 5, use: source:r"[2-5]"

Consultas predefinidas¶

You can select out of predefined queries on the search page, this allows you to quickly access the most frequent searches:

Ordenar los resultados¶

There are many options to order the strings according to your needs:

Guía para el programador de aplicaciones¶

Using Weblate is a process that brings your users closer to you, by bringing you closer to your translators. It up to you to decide how many of its features you want to make use of.

Starting with internationalization¶

Have a project and want to translate it into several languages? This guide will help you do so. Several typical situations are showcased, but most of the examples are generic and can be applied to other scenarios as well.

Before translating any software, you should realize that languages around the world are really different and you should not make any assumption based on your experience. For most of languages it will look weird if you try to concatenate a sentence out of translated segments. You also should properly handle plural forms because many languages have complex rules for that and the internationalization framework you end up using should support this.

Last but not least, sometimes it might be necessary to add some context to the translated string. Imagine a translator would get string Sun to translate. Without context most people would translate that as our closest star, but it might be actually used as an abbreviation for Sunday.

Choosing internationalization framework¶

Choose whatever is standard on your platform, try to avoid reinventing the wheel by creating your own framework to handle localizations. Weblate supports most of the widely used frameworks, see Formatos de archivo admitidos for more information (especially Translation types capabilities).

Our personal recommendation for some platforms is in the following table. This is based on our experience, but that can not cover all use cases, so always consider your environment when doing the choice.

Platform	Recommended format
Android	Recursos de cadenas de Android
iOS	Cadenas de iOS de Apple
Qt	.ts de Qt Linguist
Python	GNU gettext
PHP	GNU gettext 1
C/C++	GNU gettext
C#	.XML resource files
Perl	GNU gettext
Ruby	Ruby YAML files
Web extensions	JSON para WebExtension
Java	XLIFF 2
JavaScript	Archivos JSON de i18next 3

1: The native Gettext support in PHP is buggy and often missing on Windows builds, it is recommended to use third party library motranslator instead.
2: You can also use Java properties if plurals are not needed.
3: You can also use plain Archivos JSON if plurals are not needed.

The more detailed workflow for some formats is described in following chapters:

Integrating with Weblate¶

Getting translations updates from Weblate¶

To fetch updated strings from Weblate you can simply fetch the underlying repository (either from filesystem or it can be made available through Git exporter). Prior to this, you might want to commit any pending changes (see Consignas diferidas). This can be achieved in the user interface (in the Repository maintenance) or from command line using Cliente de Weblate.

This can be automated if you grant Weblate push access to your repository and configure Push URL in the Configuración de componentes.

Ver también

Regionalización continua

Pushing string changes to Weblate¶

To push newly updated strings to Weblate, just let it pull from the upstream repository. This can be achieved in the user interface (in the Repository maintenance) or from command line using Cliente de Weblate.

This can be automated by installing a webhook on your repository to trigger Weblate whenever there is a new commit, see Updating repositories for more details.

Ver también

Regionalización continua

Translating software using GNU Gettext¶

GNU Gettext is one of the most widely used tool for internationalization of free software. It provides a simple yet flexible way to localize the software. It has great support for plurals, it can add further context to the translated string and there are quite a lot of tools built around it. Of course it has great support in Weblate (see GNU gettext file format description).

Nota

If you are about to use it in proprietary software, please consult licensing first, it might not be suitable for you.

GNU Gettext can be used from a variety of languages (C, Python, PHP, Ruby, JavaScript and many more) and usually the UI frameworks already come with some support for it. The standard usage is through the gettext() function call, which is often aliased to _() to make the code simpler and easier to read.

Additionally it provides pgettext() call to provide additional context to translators and ngettext() which can handle plural types as defined for target language.

As a widely spread tool, it has many wrappers which make its usage really simple, instead of manual invoking of Gettext described below, you might want to try one of them, for example intltool.

Sample program¶

The simple program in C using Gettext might look like following:

#include <libintl.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>

int main(void)
{
    int count = 1;
    setlocale(LC_ALL, "");
    bindtextdomain("hello", "/usr/share/locale");
    textdomain("hello");
    printf(
        ngettext(
            "Orangutan has %d banana.\n",
            "Orangutan has %d bananas.\n",
            count
        ),
        count
    );
    printf("%s\n", gettext("Thank you for using Weblate."));
    exit(0);
}

Extracting translatable strings¶

Once you have code using the gettext calls, you can use xgettext to extract messages from it and store them into a .pot:

$ xgettext main.c -o po/hello.pot

Nota

There are alternative programs to extract strings from the code, for example pybabel.

This creates a template file, which you can use for starting new translations (using msginit) or updating existing ones after code change (you would use msgmerge for that). The resulting file is simply a structured text file:

# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-10-23 11:02+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"

#: main.c:14
#, c-format
msgid "Orangutan has %d banana.\n"
msgid_plural "Orangutan has %d bananas.\n"
msgstr[0] ""
msgstr[1] ""

#: main.c:20
msgid "Thank you for using Weblate."
msgstr ""

Each msgid line defines a string to translate, the special empty string in the beginning is the file header containing metadata about the translation.

Starting new translation¶

With the template in place, we can start our first translation:

$ msginit -i po/hello.pot -l cs --no-translator -o po/cs.po
Created cs.po.

The just created cs.po already has some information filled in. Most importantly it got the proper plural forms definition for chosen language and you can see number of plurals have changed according to that:

# Czech translations for PACKAGE package.
# Copyright (C) 2015 THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# Automatically generated, 2015.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-10-23 11:02+0200\n"
"PO-Revision-Date: 2015-10-23 11:02+0200\n"
"Last-Translator: Automatically generated\n"
"Language-Team: none\n"
"Language: cs\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=ASCII\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"

#: main.c:14
#, c-format
msgid "Orangutan has %d banana.\n"
msgid_plural "Orangutan has %d bananas.\n"
msgstr[0] ""
msgstr[1] ""
msgstr[2] ""

#: main.c:20
msgid "Thank you for using Weblate."
msgstr ""

This file is compiled into an optimized binary form, the .mo file used by the GNU Gettext functions at runtime.

Updating strings¶

Once you add more strings or change some strings in your program, you execute again xgettext which regenerates the template file:

$ xgettext main.c -o po/hello.pot

Then you can update individual translation files to match newly created templates (this includes reordering the strings to match new template):

$ msgmerge --previous --update po/cs.po po/hello.pot

Importing to Weblate¶

To import such translation into Weblate, all you need to define are the following fields when creating component (see Configuración de componentes for detailed description of the fields):

Field	Value
Repositorio de código fuente	URL of the VCS repository with your project
File mask	`po/*.po`
Plantilla para traducciones nuevas	`po/hello.pot`
Formato de archivo	Choose Gettext PO file
Idioma nuevo	Choose Create new language file

And that’s it, you’re now ready to start translating your software!

Ver también

You can find a Gettext example with many languages in the Weblate Hello project on GitHub: <https://github.com/WeblateOrg/hello>.

Translating documentation using Sphinx¶

Sphinx is a tool for creating beautiful documentation. It uses simple reStructuredText syntax and can generate output in many formats. If you’re looking for an example, this documentation is also built using it. The very useful companion for using Sphinx is the Read the Docs service, which will build and publish your documentation for free.

I will not focus on writing documentation itself, if you need guidance with that, just follow instructions on the Sphinx website. Once you have documentation ready, translating it is quite easy as Sphinx comes with support for this and it is quite nicely covered in their Internationalization. It’s matter of few configuration directives and invoking of the sphinx-intl tool.

If you are using Read the Docs service, you can start building translated documentation on the Read the Docs. Their Localization of Documentation covers pretty much everything you need - creating another project, set its language and link it from main project as a translation.

Now all you need is translating the documentation content. Sphinx generates PO file for each directory or top level file, what can lead to quite a lot of files to translate (depending on gettext_compact settings). You can import the index.po into Weblate as an initial component and then configure Descubrimiento de componentes addon to automatically discover all others.

Configuración de componentes¶
Nombre de componente	`Documentation`
File mask	`docs/locales/*/LC_MESSAGES/index.po`
Plantilla para traducciones nuevas	`docs/locales/index.pot`
Formato de archivo	gettext PO file
Indicadores de traducción	`rst-text`

Component discovery configuration¶
Expresión regular utilizada para relacionar con los archivos de traducción	`docs/locales/(?P<language>[^/.])/LC_MESSAGES/(?P<component>[^/])\.po`
Personalizar el nombre del componente	`Documentation: {{ component\|title }}`
Definir el archivo de base para traducciones nuevas	`docs/locales/{{ component }}.pot`

Consejo

Would you prefer Sphinx to generate just single PO file? There is a hacky way to achieve this (used by Weblate documentation) by overriding Sphinx way to get a Gettext domain of a document. Place following snippet to your Sphinx configuration in conf.py:

import sphinx.transforms.i18n
import sphinx.util.i18n

# Hacky way to have all localized content in single domain
sphinx.transforms.i18n.docname_to_domain = (
    sphinx.util.i18n.docname_to_domain
) = lambda docname, compact: "docs"

This might be directly supported by Sphinx in future releases, see <https://github.com/sphinx-doc/sphinx/issues/784>.

Ver también

The Odorik python module documentation is built using Sphinx, Read the Docs and translated using Weblate.

Translating HTML and JavaScript using Weblate CDN¶

Starting with Weblate 4.2 it is posible to export localization to a CDN using CDN de regionalización de JavaScript addon.

Nota

This feature is configured on Hosted Weblate. It requires additional configuration on your installation, see LOCALIZE_CDN_URL and LOCALIZE_CDN_PATH.

Upon installation into your component it will push committed translations (see Consignas diferidas) to the CDN and these can be used in your web pages to localize them.

Creating component¶

First, you need to create a monolingual component which will hold your strings, see Añadir proyectos y componentes de traducción for generic instructions on that.

In case you have existing repository to start with (for example the one containing HTML files), create an empty JSON file in the repository for the source language (see Idioma del código fuente), for example locales/en.json. The content should be {} to indicate an empty object. Once you have that, the repository can be imported into Weblate and you can start with an addon configuration.

Consejo

In case you have existing translations, you can place them into the language JSON files and those will be used in Weblate.

For those who do not want to use existing repository (or do not have one), choose Start from scratch when creating component and choose JSON file as a file format (it is okay to choose any monolingual format at this point).

Configuring Weblate CDN addon¶

The CDN de regionalización de JavaScript addon provides few configuration options.

Umbral de traducción: Translations translated above this threshold will be included in the CDN.
Selector de CSS: Configures which strings from the HTML documents are translatable, see String extraction for Weblate CDN and HTML localization using Weblate CDN.
Nombre de la «cookie» de idioma: Name of cookie which contains user selected language. Used in the JavaScript snippet for HTML localization using Weblate CDN.
Extraer cadenas desde archivos HTML: List of files in the repository or URLs where Weblate will look for translatable strings and offer them for a translation, see String extraction for Weblate CDN.

String extraction for Weblate CDN¶

The translation strings have to be present in Weblate. You can either manage these manually, use API to create them or list files or URLs using Extract strings from HTML files and Weblate will extract them automatically. The files have to present in the repository or contain remote URLs which will be download and parsed regularly by Weblate.

The default configuration for CSS selector extracts elements with CSS class l10n, for example it would extract two strings from following snippets:

<section class="content">
    <div class="row">
        <div class="wrap">
            <h1 class="section-title min-m l10n">Maintenance in progress</h1>
            <div class="page-desc">
                <p class="l10n">We're sorry, but this site is currently down for maintenance.</p>
            </div>
        </div>
    </div>
</section>

In case you don’t want to modify existing code, you can also use * as a selector to process all elements.

Nota

Right now, only text of the elements is extracted. This addon doesn’t support localization of element attributes or elements with childs.

HTML localization using Weblate CDN¶

To localize a HTML document, you need to load the weblate.js script:

<script src="https://weblate-cdn.com/a5ba5dc29f39498aa734528a54b50d0a/weblate.js" async></script>

Upon loading, this will automatically find all matching translatable elements (based on CSS selector configuration) and replace their text with a translation.

The user language is detected from the configured cookie and falls back to user preferred languages configured in the browser.

The Language cookie name can be useful for integration with other applications (for example choose django_language when using Django).

Regionalización de JavaScript¶

The individual translations are exposed as bilingual JSON files under the CDN. To fetch one you can use following code:

fetch(("https://weblate-cdn.com/a5ba5dc29f39498aa734528a54b50d0a/cs.json")
  .then(response => response.json())
  .then(data => console.log(data));

The actual localization logic needs to be implemented in this case.

Translation component alerts¶

Shows errors in the Weblate configuration or the translation project for any given translation component. Guidance on how to address found issues is also offered.

Currently the following is covered:

Duplicated source strings in translation files
Duplicated languages within translations
Merge or update failures in the source repository
Unused new base in component settings
Parse errors in the translation files
Duplicate filemask used for linked components
Broken URLs

Alerts are listed on each respective component page as Alerts. If it is missing, the component clears all current checks. Alerts can not be ignored, but will disappear once the underlying problem has been fixed.

A component with both duplicated strings and languages looks like this:

Ver también

Using custom certificate authority

Building translators community¶

Lista de control de regionalización comunitaria¶

Nuevo en la versión 3.9.

La Lista de control de regionalización comunitaria, la cual puede encontrar en el Menú de cada componente, le brinda recomendaciones para facilitar el proceso de regionalización a los traductores comunitarios.

Managing translations¶

Adding new translations¶

New strings can be made available for translation when they appear in the base file, called Template for new translations (see Configuración de componentes). If your file format doesn’t require such a file, as is the case with most monolingual translation flows, you can start with blank files).

New languages can be added right away when requested by a user in Weblate, or a notification will be sent to project admins for approval and manual addition. This can be done using Start new translation in Configuración de componentes.

Nota

Project admins can always start translation within Weblate directly.

Language files added manually to the VCS are added to the component when Weblate updates the repository. About repository update settings, see Updating repositories).

String variants¶

Variants are useful to group several strings together so that translators can see all variants of the string at one place. You can define regular expression to group the strings in the Configuración de componentes:

The expression is matched against Key to generate root key of the variant. All matching strings are then part of single variants group, including the translation exactly matching the root key, even if that is not matched by the regular expression.

The following table lists some usage examples:

Caso de uso	Variante de expresión regular	Matched translation keys
Identificación de sufijos	`(Short\|Min)$`	`monthShort`, `monthMin`, `month`
Inline identification	`#[SML]`	`dial#S.key`, `dial#M.key`, `dial.key`

The variant is later grouped when translating:

Etiquetas de cadena¶

Split component translation strings into categories by text and colour in the project configuration.

Consejo

Labels can be assigned to units in Información adicional sobre las cadenas de origen by bulk editing, or using the Edición en masa addon.

Reviewing strings¶

Activity reports¶

Activity reports check changes of translations, for projects, components or individual users.

The activity reports for a project or component is accessible from its dashboard, on the Insights tab, selecting Activity.

More reports are accessible on the Insights tab, selecting Translation reports.

The activity of the currently signed in user can be seen by clicking on Profile from the user menu on the top right.

Source strings checks¶

There are many Quality checks, some of them focus on improving the quality of source strings. Many failing checks suggest a hint to make source strings easier to translate. All types of failing source checks are displayed on the Source tab of every component.

Translation string checks¶

Erroneous failing translation string checks indicate the problem is with the source string. Translators sometimes fix mistakes in the translation instead of reporting it - a typical example is a missing full stop at the end of a sentence.

Reviewing all failing checks can provide valuable feedback to improve its source strings. To make source strings review easier, Weblate automatically creates a translation for the source language and shows you source level checks there:

One of the most interesting checks here is the Varias comprobaciones fallidas - it is triggered whenever there is failure on multiple translations of a given string. Usually this is something to look for, as this is a string which translators have problems translating properly.

The detailed listing is a per language overview:

String comments¶

Translators can comment on both translation and source strings. Each Configuración de componentes can be configured to receive such comments to an e-mail address, and using the developers mailing list is usually the best approach. This way you can keep an eye on when problems arise in translation, take care of them, and fix them quickly.

Promoting the translation¶

Weblate provides you widgets to share on your website or other sources to promote the translation project. It also has a nice welcome page for new contributors to give them basic information about the translation. Additionally you can share information about translation using Facebook or Twitter. All these possibilities can be found on the Share tab:

All these badges are provided with the link to simple page which explains users how to translate using Weblate:

Translation progress reporting¶

Reporting features give insight into how a translation progresses over a given period. A summary of contributions to any given component over time is provided. The reporting tool is found in the Insights menu of any translation component, project or on the dashboard:

Several reporting tools are available on this page and all can produce output in HTML, reStructuredText or JSON. The first two formats are suitable for embedding statistics into existing documentation, while JSON is useful for further processing of the data.

Créditos de traductores¶

Generates a document usable for crediting translators - sorted by language and lists all contributors to a given language:

* Czech

    * Michal Čihař <michal@cihar.com> (10)
    * John Doe <john@example.com> (5)

* Dutch

    * Jane Doe <jane@example.com> (42)

It will render as:

Checo

Michal Čihař <michal@cihar.com> (10)

John Doe <john@example.com> (5)

Neerlandés

Jae Doe <jane@example.com> (42)

Consejo

The number in parenthesis indicates number of contributions in given period.

Estadísticas de contribuidores¶

Generates the number of translated words and strings by translator name:

======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================
Name                                     Email                                    Count total              Source words total       Source chars total       Target words total       Target chars total       Count new                Source words new         Source chars new         Target words new         Target chars new         Count approved           Source words approved    Source chars approved    Target words approved    Target chars approved    Count edited             Source words edited      Source chars edited      Target words edited      Target chars edited
======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================
Michal Čihař                             michal@cihar.com                                                1                        3                       24                        3                       21                        1                        3                       24                        3                       21                        0                        0                        0                        0                        0                        0                        0                        0                        0                        0
Allan Nordhøy                            allan@example.com                                               2                        5                       25                        4                       28                        2                        3                       24                        3                       21                        0                        0                        0                        0                        0                        0                        0                        0                        0                        0
======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================

And it will get rendered as:

Nombre	Correo electrónico	Count total	Source words total	Source chars total	Target words total	Target chars total	Count new	Source words new	Source chars new	Target words new	Target chars new	Count approved	Source words approved	Source chars approved	Target words approved	Target chars approved	Count edited	Source words edited	Source chars edited	Target words edited	Target chars edited
Michal Čihař	michal@cihar.com	1	3	24	3	21	1	3	24	3	21	0	0	0	0	0	0	0	0	0	0
Allan Nordhøy	allan@example.com	2	5	25	4	28	2	3	24	3	21	0	0	0	0	0	0	0	0	0	0

It can be useful if you pay your translators based on amount of work, it gives you various stats on translators work.

All stats are available in three variants:

Total: Overall number of edited strings.
New: Newly translated strings which didn’t have translation before.
Approved: Count for string approvals in review workflow (see Revisores dedicados).
Edited: Edited strings which had translation before.

The following metrics are available for each:

Count: Number of strings.
Edits: Number of edits in the string, measured in Damerau–Levenshtein distance.
Source words: Number of words in the source string.
Source characters: Number of characters in the source string.
Target words: Number of words in the translated string.
Target characters: Number of characters in the translated string.

Flujos de trabajo de traducción¶

Se admiten varios flujos de trabajo de traducción.

La siguiente no es una lista completa de maneras de configurar Weblate. Puede basar otros flujos de trabajo en los ejemplos más usuales que se enumeran aquí.

Acceso de traducción¶

The Control de acceso is not much discussed in the workflows as each access control option can be applied to any workflow. Please consult that documentation for information on how to manage access to translations.

In the following chapters, any user means a user who has access to the translation. It can be any authenticated user if the project is public, or a user that has a Translate permission for the project.

Translation states¶

Cada cadena traducida se clasifica en uno de los estados siguientes:

No traducidas: Translation is empty, it might or not be stored in the file, depending on the file format.
Necesita edición: Translation needs editing, this is usually the result of a source string change. The translation is stored in the file, depending on the file format it might be marked as needing edit (for example as it gets a fuzzy flag).
Revisión pendiente: La traducción se ha efectuado pero no se ha revisado. Está almacenada en el archivo y es válida.
Aprobadas: Translation has been approved in the review. It can no longer be changed by translators, but only by reviewers. Translators can only add suggestions to it.
Sugerencias: Las sugerencias se almacenan solo en Weblate, no en el archivo de traducción.

Traducción directa¶

This is most usual setup for smaller teams, anybody can directly translate. This is also the default setup in Weblate.

Any user can edit translations.
Suggestions are optional ways to suggest changes, when translators are not sure about the change.

Configuración	Value	Nota
Activar revisiones	desactivada	Configured at project level.
Activar sugerencias	activada	It is useful for users to be able to suggest when they are not sure.
Votar sugerencias	desactivada
Autoaceptar sugerencias	0
Grupo de traductores	Users	Or Translate with Control de acceso.
Grupo de revisores	Sin datos	Not used.

Revisión por pares¶

With this workflow, anybody can add suggestions, and need approval from additional member(s) before it is accepted as a translation.

Any user can add suggestions.
Any user can vote for suggestions.
Suggestions become translations when given a predetermined number of votes.

Configuración	Value	Nota
Activar revisiones	desactivada	Configured at project level.
Activar sugerencias	activada
Votar sugerencias	desactivada
Autoaceptar sugerencias	1	You can set higher value to require more peer reviews.
Grupo de traductores	Users	Or Translate with Control de acceso.
Grupo de revisores	Sin datos	Not used, all translators review.

Revisores dedicados¶

Nuevo en la versión 2.18: The proper review workflow is supported since Weblate 2.18.

Al activar los revisores dedicados dividirá sus usuarios en dos grupos: uno será capaz de enviar traducciones, y el otro podrá revisarlas para garantizar que sean coherentes y su calidad sea buena.

Cualquier usuario puede editar traducciones no aprobadas.
Los revisores pueden aprobar o desaprobar las cadenas.
Los revisores pueden editar todas las traducciones (incluidas las aprobadas).
Es posible asimismo emplear las sugerencias para proponer modificaciones a las cadenas aprobadas.

Configuración	Value	Nota
Activar revisiones	activada	Configured at project level.
Activar sugerencias	desactivada	It is useful for users to be able to suggest when they are not sure.
Votar sugerencias	desactivada
Autoaceptar sugerencias	0
Grupo de traductores	Users	Or Translate with Control de acceso.
Grupo de revisores	Reviewers	Or Review with Control de acceso.

Turning on reviews¶

Reviews can be turned on in the project configuration, from the Workflow subpage of project settings (to be found in the Manage → Settings menu):

Nota

Depending on Weblate configuration, the setting might not be available to you. For example on Hosted Weblate this is not available for projects hosted for free.

Quality gateway for the source strings¶

In many cases the original source language strings are coming from developers, because they write the code and provide initial strings. However developers are often not a native speakers in the source language and do not provide desired quality of the source strings. The intermediate translation can help you in addressing this - there is additional quality gateway for the strings between developers and translators and users.

By setting Archivo de idioma intermediario, this file will be used as source for the strings, but it will be edited to source language to polish it. Once the string is ready in the source language, it will be also available for translators to translate into additional languages.

Ver también

Archivo de idioma intermediario, Archivo de base monolingüe, Formatos bilingües y monolingües

Source strings reviews¶

With Activar revisiones de origen enabled, the review process can be applied on the source strings. Once enabled, users can report issues in the source strings. The actual process depends on whether you use bilingual or monolingual formats.

For monolingual formats, the source string review behaves similarly as with Revisores dedicados - once issue is reported on the source string, it is marked as Needs editing.

The bilingual formats do not allow direct editing of the source strings (these are typically extracted directly from the source code). In this case Source needs review label is attached to strings reported by translators. You should review such strings and either edit them in the source or remove the label.

Ver también

Formatos bilingües y monolingües, Revisores dedicados, Etiquetas de cadena

Preguntas frecuentes¶

Configuración¶

¿Cómo se crea un flujo de trabajo automatizado?¶

Weblate can handle all the translation things semi-automatically for you. If you give it push access to your repository, the translations can happen without interaction, unless some merge conflict occurs.

Set up your Git repository to tell Weblate when there is any change, see Actuadores de notificaciones for info on how to do it.
Set a push URL at your Configuración de componentes in Weblate, this allows Weblate to push changes to your repository.
Turn on push-on-commit on your Configuración de proyectos in Weblate, this will make Weblate push changes to your repository whenever they happen at Weblate.

Ver también

Regionalización continua, Avoiding merge conflicts

How to access repositories over SSH?¶

Please see Accessing repositories for info on setting up SSH keys.

How to fix merge conflicts in translations?¶

Merge conflicts happen from time to time when the translation file is changed in both Weblate and the upstream repository concurrently. You can usually avoid this by merging Weblate translations prior to making changes in the translation files (e.g. before running msgmerge). Just tell Weblate to commit all pending translations (you can do it in Repository maintenance in the Manage menu) and merge the repository (if automatic push is not on).

If you’ve already ran into a merge conflict, the easiest way is to solve all conflicts locally at your workstation - is to simply add Weblate as a remote repository, merge it into upstream and fix any conflicts. Once you push changes back, Weblate will be able to use the merged version without any other special actions.

Nota

Depending on your setup, access to the Weblate repository might require authentication. When using the built in Git exporter in Weblate, you authenticate with your username and the API key.

# Commit all pending changes in Weblate, you can do this in the UI as well:
wlc commit
# Lock the translation in Weblate, again this can be done in the UI as well:
wlc lock
# Add Weblate as remote:
git remote add weblate https://hosted.weblate.org/git/project/component/
# You might need to include credentials in some cases:
git remote add weblate https://username:APIKEY@hosted.weblate.org/git/project/component/

# Update weblate remote:
git remote update weblate

# Merge Weblate changes:
git merge weblate/master

# Resolve conflicts:
edit …
git add …
…
git commit

# Push changes to upstream repository, Weblate will fetch merge from there:
git push

# Open Weblate for translation:
wlc unlock

If you’re using multiple branches in Weblate, you can do the same to all of them:

# Add and update Weblate remotes
git remote add weblate-one https://hosted.weblate.org/git/project/one/
git remote add weblate-second https://hosted.weblate.org/git/project/second/
git remote update weblate-one weblate-second

# Merge QA_4_7 branch:
git checkout QA_4_7
git merge weblate-one/QA_4_7
... # Resolve conflicts
git commit

# Merge master branch:
git checkout master
git merge weblates-second/master
... # Resolve conflicts
git commit

# Push changes to the upstream repository, Weblate will fetch the merge from there:
git push

In case of gettext PO files, there is a way to merge conflicts in a semi-automatic way:

Fetch and keep a local clone of the Weblate Git repository. Also get a second fresh local clone of the upstream Git repository (i. e. you need two copies of the upstream Git repository: An intact and a working copy):

# Add remote:
git remote add weblate /path/to/weblate/snapshot/

# Update Weblate remote:
git remote update weblate

# Merge Weblate changes:
git merge weblate/master

# Resolve conflicts in the PO files:
for PO in `find . -name '*.po'` ; do
    msgcat --use-first /path/to/weblate/snapshot/$PO\
               /path/to/upstream/snapshot/$PO -o $PO.merge
    msgmerge --previous --lang=${PO%.po} $PO.merge domain.pot -o $PO
    rm $PO.merge
    git add $PO
done
git commit

# Push changes to the upstream repository, Weblate will fetch merge from there:
git push

Ver también

How to export the Git repository that Weblate uses?, Regionalización continua, Avoiding merge conflicts

How do I translate several branches at once?¶

Weblate supports pushing translation changes within one Configuración de proyectos. For every Configuración de componentes which has it turned on (the default behavior), the change made is automatically propagated to others. This way translations are kept synchronized even if the branches themselves have already diverged quite a lot, and it is not possible to simply merge translation changes between them.

Once you merge changes from Weblate, you might have to merge these branches (depending on your development workflow) discarding differences:

git merge -s ours origin/maintenance

Ver también

Mantener iguales las traducciones entre los componentes

How to translate multi-platform projects?¶

Weblate supports a wide range of file formats (see Formatos de archivo admitidos) and the easiest approach is to use the native format for each platform.

Once you have added all platform translation files as components in one project (see Añadir proyectos y componentes de traducción), you can utilize the translation propagation feature (turned on by default, and can be turned off in the Configuración de componentes) to translate strings for all platforms at once.

Ver también

Mantener iguales las traducciones entre los componentes

How to export the Git repository that Weblate uses?¶

There is nothing special about the repository, it lives under the DATA_DIR directory and is named vcs/<project>/<component>/. If you have SSH access to this machine, you can use the repository directly.

For anonymous access, you might want to run a Git server and let it serve the repository to the outside world.

Alternatively, you can use Git exporter inside Weblate to automate this.

What are the options for pushing changes back upstream?¶

This heavily depends on your setup, Weblate is quite flexible in this area. Here are examples of some workflows used with Weblate:

Weblate automatically pushes and merges changes (see ¿Cómo se crea un flujo de trabajo automatizado?).
You manually tell Weblate to push (it needs push access to the upstream repository).
Somebody manually merges changes from the Weblate git repository into the upstream repository.
Somebody rewrites history produced by Weblate (e.g. by eliminating merge commits), merges changes, and tells Weblate to reset the content in the upstream repository.

Of course you are free to mix all of these as you wish.

How can I limit Weblate access to only translations, without exposing source code to it?¶

You can use git submodule for separating translations from source code while still having them under version control.

Create a repository with your translation files.

Add this as a submodule to your code:

git submodule add git@example.com:project-translations.git path/to/translations

Link Weblate to this repository, it no longer needs access to the repository containing your source code.
You can update the main repository with translations from Weblate by:
```
git submodule update --remote path/to/translations
```

Please consult the git submodule documentation for more details.

How can I check whether my Weblate is set up properly?¶

Weblate includes a set of configuration checks which you can see in the admin interface, just follow the Performance report link in the admin interface, or open the /manage/performance/ URL directly.

Why are all commits committed by Weblate <noreply@weblate.org>?¶

This is the default committer name, configured when you create a translation component. You can change it in the administration at any time.

The author of every commit (if the underlying VCS supports it) is still recorded correctly as the user that made the translation.

Ver también

Configuración de componentes

Usage¶

How do I review the translations of others?¶

You can subscribe to any changes made in Notificaciones and then check others contributions as they come in by e-mail.
There is a review tool available at the bottom of the translation view, where you can choose to browse translations made by others since a given date.

How do I provide feedback on a source string?¶

On context tabs below translation, you can use the Source tab to provide feedback on a source string, or discuss it with other translators.

How can I use existing translations while translating?¶

Use the import functionality to load compendium as translations, suggestions or translations needing review. This is the best approach for a one-time translation using a compendium or a similar translation database.
You can set up tmserver with all databases you have and let Weblate use it. This is good when you want to use it several times during translation.
Another option is to translate all related projects in a single Weblate instance, which will make it automatically pick up translations from other projects as well.

Ver también

Traducción automática, Traducción automática

Does Weblate update translation files besides translations?¶

Weblate tries to limit changes in translation files to a minimum. For some file formats it might unfortunately lead to reformatting the file. If you want to keep the file formatted your way, please use a pre-commit hook for that.

For monolingual files (see Formatos de archivo admitidos) Weblate might add new translation strings not present in the template, and not in actual translations. It does not however perform any automatic cleanup of stale strings as that might have unexpected outcomes. If you want to do this, please install a pre-commit hook which will handle the cleanup according to your requirements.

Weblate also will not try to update bilingual files in any way, so if you need po files being updated from pot, you need to do it yourself.

Ver también

Procesar el repositorio con secuencias

Where do language definitions come from and how can I add my own?¶

The basic set of language definitions is included within Weblate and Translate-toolkit. This covers more than 150 languages and includes info about plural forms or text direction.

You are free to define your own languages in the administrative interface, you just need to provide info about it.

Can Weblate highlight changes in a fuzzy string?¶

Weblate supports this, however it needs the data to show the difference.

For Gettext PO files, you have to pass the parameter --previous to msgmerge when updating PO files, for example:

msgmerge --previous -U po/cs.po po/phpmyadmin.pot

For monolingual translations, Weblate can find the previous string by ID, so it shows the differences automatically.

Why does Weblate still show old translation strings when I’ve updated the template?¶

Weblate does not try to manipulate the translation files in any way other than allowing translators to translate. So it also does not update the translatable files when the template or source code have been changed. You simply have to do this manually and push changes to the repository, Weblate will then pick up the changes automatically.

Nota

It is usually a good idea to merge changes done in Weblate before updating translation files, as otherwise you will usually end up with some conflicts to merge.

For example with gettext PO files, you can update the translation files using the msgmerge tool:

msgmerge -U locale/cs/LC_MESSAGES/django.mo locale/django.pot

In case you want to do the update automatically, you can install addon Actualizar archivos PO para que coincidan con POT (msgmerge).

Troubleshooting¶

Requests sometimes fail with «too many open files» error¶

This happens sometimes when your Git repository grows too much and you have many of them. Compressing the Git repositories will improve this situation.

The easiest way to do this is to run:

# Go to DATA_DIR directory
cd data/vcs
# Compress all Git repositories
for d in */* ; do
    pushd $d
    git gc
    popd
done

Ver también

DATA_DIR

When accessing the site I get a «Bad Request (400)» error¶

This is most likely caused by an improperly configured ALLOWED_HOSTS. It needs to contain all hostnames you want to access on your Weblate. For example:

ALLOWED_HOSTS = ['weblate.example.com', 'weblate', 'localhost']

Ver también

Allowed hosts setup

What does mean «There are more files for the single language (en)»?¶

This typically happens when you have translation file for source language. Weblate keeps track of source strings and reserves source language for this. The additional file for same language is not processed.

In case the translation to the source language is desired, please change the Idioma del código fuente in the project settings.
En caso de que no se necesite el archivo de traducción correspondiente al idioma de origen, elimínelo del repositorio.
En caso de que se necesite el archivo de traducción del idioma de origen pero Weblate debería ignorarlo, ajuste el Filtro de idioma para excluirlo.

Funciones¶

¿Weblate admite sistemas de control de versiones aparte de Git y Mercurial?¶

Weblate currently does not have native support for anything other than Git (with extended support for GitHub, Gerrit and Subversion) and ref:vcs-mercurial, but it is possible to write backends for other VCSes.

You can also use Auxiliares remotos de Git in Git to access other VCSes.

Weblate also supports VCS less operation, see Archivos locales.

Nota

For native support of other VCSes, Weblate requires using distributed VCS, and could probably be adjusted to work with anything other than Git and Mercurial, but somebody has to implement this support.

Ver también

Integración de control de versiones

¿Cómo Weblate da crédito a los traductores?¶

Every change made in Weblate is committed into VCS under the translators name. This way every single change has proper authorship, and you can track it down using the standard VCS tools you use for code.

Additionally, when the translation file format supports it, the file headers are updated to include the translator’s name.

Ver también

list_translators, Translation progress reporting

¿Por qué Weblate fuerza la visualización de todos los archivos PO en un único árbol?¶

Weblate was designed in a way that every PO file is represented as a single component. This is beneficial for translators, so they know what they are actually translating. If you feel your project should be translated as one, consider merging these po files. It will make life easier even for translators not using Weblate.

Nota

In case there is great demand for this feature, it might be implemented in future versions.

¿Por qué Weblate utiliza códigos de idioma tales como sr_Latn o zh_Hant?¶

These are language codes defined by RFC 4646 to better indicate that they are really different languages instead previously wrongly used modifiers (for @latin variants) or country codes (for Chinese).

Weblate still understands legacy language codes and will map them to current one - for example sr@latin will be handled as sr_Latn or zh@CN as sr_Hans.

Formatos de archivo admitidos¶

Weblate supports most translation format understood by translate-toolkit, however each format being slightly different, some issues with formats that are not well tested can arise.

Ver también

Translation Related File Formats

Nota

When choosing a file format for your application, it’s better to stick some well established format in the toolkit/platform you use. This way your translators can additionally use whatever tools they are used to, and will more likely contribute to your project.

Formatos bilingües y monolingües¶

Both monolingual and bilingual formats are supported. Bilingual formats store two languages in single file—source and translation (typical examples are GNU gettext, XLIFF or Cadenas de iOS de Apple). On the other side, monolingual formats identify the string by ID, and each language file contains only the mapping of those to any given language (typically Recursos de cadenas de Android). Some file formats are used in both variants, see the detailed description below.

For correct use of monolingual files, Weblate requires access to a file containing complete list of strings to translate with their source—this file is called Archivo de base monolingüe within Weblate, though the naming might vary in your paradigm.

Additionally this workflow can be extended by utilizing Archivo de idioma intermediario to include strings provided by developers, but not to be used as is in the final strings.

Detección automática¶

Weblate can automatically detect several widespread file formats, but this detection can harm your performance and will limit features specific to given file format (for example automatic addition of new translations).

Translation types capabilities¶

Capabilities of all supported formats:

Format	Linguality 1	Plurals 2	Comments 3	Context 4	Location 5	Flags 8	Additional states 6
GNU gettext	bilingual	yes	yes	yes	yes	yes 9	needs editing
Monolingual gettext	mono	yes	yes	yes	yes	yes 9	needs editing
XLIFF	both	yes	yes	yes	yes	yes 10	needs editing, approved
Java properties	both	no	yes	no	no	no
GWT properties	mono	yes	yes	no	no	no
Traducciones para Joomla	mono	no	yes	no	yes	no
.ts de Qt Linguist	both	yes	yes	no	yes	yes 10	needs editing
Recursos de cadenas de Android	mono	yes	yes 7	no	no	yes 10
Cadenas de iOS de Apple	bilingual	no	yes	no	no	no
Cadenas de PHP	mono	no 11	yes	no	no	no
Archivos JSON	mono	no	no	no	no	no
Archivos JSON de i18next	mono	yes	no	no	no	no
Archivos JSON de go-i18n	mono	yes	no	no	no	no
Archivo ARB	mono	yes	yes	no	no	no
JSON para WebExtension	mono	yes	yes	no	no	no
.XML resource files	mono	no	yes	no	no	yes 10
CSV files	mono	no	yes	yes	yes	no	needs editing
YAML files	mono	no	yes	no	no	no
Ruby YAML files	mono	yes	yes	no	no	no
DTD files	mono	no	no	no	no	no
Flat XML	mono	no	no	no	no	yes 10
Archivos RC de Windows	mono	no	yes	no	no	no
Open XML de Excel	mono	no	yes	yes	yes	no	needs editing
Archivos de metadatos de tiendas de aplicaciones	mono	no	no	no	no	no
Archivos de subtítulos	mono	no	no	no	yes	no
Archivos HTML	mono	no	no	no	no	no
Formato OpenDocument	mono	no	no	no	no	no
Formato IDML	mono	no	no	no	no	no
INI translations	mono	no	no	no	no	no
Traducciones de INI de Inno Setup	mono	no	no	no	no	no

1: See Formatos bilingües y monolingües
2: Plurals are necessary to properly localize strings with variable count.
3: Comments can be used to pass additional info about the string to translate.
4: Context is used to differentiate identical strings used in different scopes (for example Sun can be used as an abbreviated name of the day «Sunday» or as the name of our closest star).
5: Location of a string in source code might help proficient translators figure out how the string is used.
6: Additional states supported by the file format in addition to «Not translated» and «Translated».
7: XML comment placed before the <string> element, parsed as a developer comment.
8: See Customizing behavior
9(1,2): The gettext type comments are used as flags.
10(1,2,3,4,5): The flags are extracted from the non-standard attribute weblate-flags for all XML based formats. Additionally max-length:N is supported through the maxwidth attribute as defined in the XLIFF standard, see Specifying translation flags.
11: The plurals are supported only for Laravel which uses in string syntax to define them, see Localization in Laravel.

GNU gettext¶

Most widely used format for translating libre software. This was first format supported by Weblate and still has the best support.

Contextual info stored in the file is supported by adjusting its headers or linking to corresponding source files.

The bilingual gettext PO file typically looks like this:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "Monday"
msgstr "Pondělí"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "Tuesday"
msgstr "Úterý"

#: weblate/accounts/avatar.py:163
msgctxt "No known user"
msgid "None"
msgstr "Žádný"

Typical Weblate Configuración de componentes
Máscara de archivos	`po/*.po`
Archivo de base monolingüe	Empty
Plantilla para traducciones nuevas	`po/messages.pot`
Formato de archivo	Gettext PO file

Ver también

Translating software using GNU Gettext, Translating documentation using Sphinx, Gettext on Wikipedia, PO Files, Actualizar variable ALL_LINGUAS en el archivo «configure», Personalizar la salida de gettext, Actualizar archivo LINGUAS, Generar archivos MO, Actualizar archivos PO para que coincidan con POT (msgmerge)

Monolingual gettext¶

Some projects decide to use gettext as monolingual formats—they code just the IDs in their source code and the string then needs to be translated to all languages, including English. This is supported, though you have to choose this file format explicitly when importing components into Weblate.

The monolingual gettext PO file typically looks like this:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-monday"
msgstr "Pondělí"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-tuesday"
msgstr "Úterý"

#: weblate/accounts/avatar.py:163
msgid "none-user"
msgstr "Žádný"

While the base language file will be:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-monday"
msgstr "Monday"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-tuesday"
msgstr "Tuesday"

#: weblate/accounts/avatar.py:163
msgid "none-user"
msgstr "None"

Typical Weblate Configuración de componentes
Máscara de archivos	`po/*.po`
Archivo de base monolingüe	`po/en.po`
Plantilla para traducciones nuevas	`po/messages.pot`
Formato de archivo	Gettext PO file (monolingual)

XLIFF¶

XML-based format created to standardize translation files, but in the end it is one of many standards, in this area.

XML Localization Interchange File Format (XLIFF) is usually used as bilingual, but Weblate supports it as monolingual as well.

Ver también

XML Localization Interchange File Format (XLIFF) specification

Translation states¶

Distinto en la versión 3.3: Weblate ignored the state attribute prior to the 3.3 release.

The state attribute in the file is partially processed and mapped to the «Needs edit» state in Weblate (the following states are used to flag the string as needing edit if there is a target present: new, needs-translation, needs-adaptation, needs-l10n). Should the state attribute be missing, a string is considered translated as soon as a <target> element exists.

If the translation string has approved="yes", it will also be imported into Weblate as «Approved», anything else will be imported as «Waiting for review» (which matches the XLIFF specification).

While saving, Weblate doesn’t add those attributes unless necessary:

The state attribute is only added in case string is marked as needing edit.
The approved attribute is only added in case string has been reviewed.
In other cases the attributes are not added, but they are updated in case they are present.

That means that when using the XLIFF format, it is strongly recommended to turn on the Weblate review process, in order to see and change the approved state of strings.

See Revisores dedicados.

Similarly upon importing such files (in the upload form), you should choose Import as translated under Processing of strings needing edit.

Whitespace and newlines in XLIFF¶

Generally types or amounts of whitespace is not differentiated between in XML formats. If you want to keep it, you have to add the xml:space="preserve" flag to the string.

For example:

    <trans-unit id="10" approved="yes">
        <source xml:space="preserve">hello</source>
        <target xml:space="preserve">Hello, world!
</target>
    </trans-unit>

Specifying translation flags¶

You can specify additional translation flags (see Customizing behavior) by using the weblate-flags attribute. Weblate also understands maxwidth and font attributes from the XLIFF specification:

<trans-unit id="10" maxwidth="100" size-unit="pixel" font="ubuntu;22;bold">
   <source>Hello %s</source>
</trans-unit>
<trans-unit id="20" maxwidth="100" size-unit="char" weblate-flags="c-format">
   <source>Hello %s</source>
</trans-unit>

The font attribute is parsed for font family, size and weight, the above example shows all of that, though only font family is required. Any whitespace in the font family is converted to underscore, so Source Sans Pro becomes Source_Sans_Pro, please keep that in mind when naming the font group (see Managing fonts).

Typical Weblate Configuración de componentes for bilingual XLIFF
Máscara de archivos	`localizations/*.xliff`
Archivo de base monolingüe	Empty
Plantilla para traducciones nuevas	`localizations/en-US.xliff`
Formato de archivo	XLIFF Translation File

Typical Weblate Configuración de componentes for monolingual XLIFF
File mask	`localizations/*.xliff`
Archivo de base monolingüe	`localizations/en-US.xliff`
Plantilla para traducciones nuevas	`localizations/en-US.xliff`
Formato de archivo	XLIFF Translation File

Ver también

XLIFF on Wikipedia, XLIFF, font attribute in XLIFF 1.2, maxwidth attribute in XLIFF 1.2

Java properties¶

Native Java format for translations.

Java properties are usually used as monolingual translations.

Weblate supports ISO-8859-1, UTF-8 and UTF-16 variants of this format. All of them support storing all Unicode characters, it is just differently encoded. In the ISO-8859-1, the Unicode escape sequences are used (for example zkou\u0161ka), all others encode characters directly either in UTF-8 or UTF-16.

Nota

Loading escape sequences works in UTF-8 mode as well, so please be careful choosing the correct encoding set to match your application needs.

Typical Weblate Configuración de componentes
Máscara de archivos	`src/app/Bundle_*.properties`
Archivo de base monolingüe	`src/app/Bundle.properties`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Java Properties (ISO-8859-1)

Ver también

Java properties on Wikipedia, Mozilla and Java properties files, Formatos del archivo de propiedades Java, Limpieza de archivos de traducción

GWT properties¶

Native GWT format for translations.

GWT properties are usually used as monolingual translations.

Typical Weblate Configuración de componentes
Máscara de archivos	`src/app/Bundle_*.properties`
Archivo de base monolingüe	`src/app/Bundle.properties`
Plantilla para traducciones nuevas	Empty
Formato de archivo	GWT Properties

Ver también

GWT localization guide Mozilla and Java properties files, Formatos del archivo de propiedades Java, Limpieza de archivos de traducción

INI translations¶

Nuevo en la versión 4.1.

INI file format for translations.

INI translations are usually used as monolingual translations.

Typical Weblate Configuración de componentes
Máscara de archivos	`language/*.ini`
Archivo de base monolingüe	`language/en.ini`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo INI

Ver también

INI Files, Traducciones para Joomla, Traducciones de INI de Inno Setup

Traducciones de INI de Inno Setup¶

Nuevo en la versión 4.1.

Inno Setup INI file format for translations.

Normalmente, las traducciones de archivos INI de Inno Setup se configuran como monolingües.

Nota

La única diferencia importante con INI translations es que se admiten los sustitutorios %n y %t para insertar saltos de renglón y tabuladores, respectivamente.

Typical Weblate Configuración de componentes
Máscara de archivos	`language/*.islu`
Archivo de base monolingüe	`language/en.islu`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo INI de Inno Setup

Nota

Por ahora, solo se admiten los archivos en codificación Unicode (.islu), no los ANSI (.isl).

Ver también

INI Files, Traducciones para Joomla, INI translations

Traducciones para Joomla¶

Nuevo en la versión 2.12.

Formato nativo de Joomla para traducciones.

Joomla translations are usually used as monolingual translations.

Typical Weblate Configuración de componentes
Máscara de archivos	`language/*/com_foobar.ini`
Archivo de base monolingüe	`language/en-GB/com_foobar.ini`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo de idioma de Joomla

Ver también

Specification of Joomla language files, Mozilla and Java properties files, INI translations, Traducciones de INI de Inno Setup

.ts de Qt Linguist¶

Formato de traducción utilizado en aplicaciones programadas con Qt.

Qt Linguist files are used as both bilingual and monolingual translations.

Typical Weblate Configuración de componentes when using as bilingual
Máscara de archivos	`i18n/app.*.ts`
Archivo de base monolingüe	Empty
Plantilla para traducciones nuevas	`i18n/app.de.ts`
Formato de archivo	Archivo de traducción de Qt Linguist

Typical Weblate Configuración de componentes when using as monolingual
Máscara de archivos	`i18n/app.*.ts`
Archivo de base monolingüe	`i18n/app.en.ts`
Plantilla para traducciones nuevas	`i18n/app.en.ts`
Formato de archivo	Archivo de traducción de Qt Linguist

Ver también

Qt Linguist manual, Qt .ts, Formatos bilingües y monolingües

Recursos de cadenas de Android¶

Formato de archivo específico de Android para traducir aplicaciones.

Android string resources are monolingual, the Monolingual base language file file is stored in a different location from the others res/values/strings.xml.

Typical Weblate Configuración de componentes
Máscara de archivos	`res/values-*/strings.xml`
Archivo de base monolingüe	`res/values/strings.xml`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Recurso de cadenas de Android

Ver también

Android string resources documentation, Android string resources

Nota

Android string-array structures are not currently supported. To work around this, you can break your string arrays apart:

<string-array name="several_strings">
    <item>First string</item>
    <item>Second string</item>
</string-array>

become:

<string-array name="several_strings">
    <item>@string/several_strings_0</item>
    <item>@string/several_strings_1</item>
</string-array>
<string name="several_strings_0">First string</string>
<string name="several_strings_1">Second string</string>

The string-array that points to the string elements should be stored in a different file, and not be made available for translation.

This script may help pre-process your existing strings.xml files and translations: https://gist.github.com/paour/11291062

Cadenas de iOS de Apple¶

Apple specific file format for translating applications, used for both iOS and iPhone/iPad application translations.

Apple iOS strings are usually used as bilingual translations.

Typical Weblate Configuración de componentes
Máscara de archivos	`Resources/*.lproj/Localizable.strings`
Archivo de base monolingüe	`Resources/en.lproj/Localizable.strings`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Cadenas de iOS (UTF-8)

Ver también

Apple «strings files» documentation, Mac OSX strings

Cadenas de PHP¶

PHP translations are usually monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Archivo de ejemplo:

<?php
$LANG['foo'] = 'bar';
$LANG['foo1'] = 'foo bar';
$LANG['foo2'] = 'foo bar baz';
$LANG['foo3'] = 'foo bar baz bag';

Typical Weblate Configuración de componentes
Máscara de archivos	`lang/*/texts.php`
Archivo de base monolingüe	`lang/en/texts.php`
Plantilla para traducciones nuevas	`lang/en/texts.php`
Formato de archivo	Cadenas de PHP

Cadenas PHP de Laravel¶

Distinto en la versión 4.1.

The Laravel PHP localization files are supported as well with plurals:

<?php
return [
    'apples' => 'There is one apple|There are many apples',
];

Ver también

PHP, Localization in Laravel

Archivos JSON¶

Nuevo en la versión 2.0.

Distinto en la versión 2.16: Since Weblate 2.16 and with translate-toolkit at-least 2.2.4, nested structure JSON files are supported as well.

El formato JSON se utiliza más a menudo para traducir aplicaciones creadas en JavaScript.

Weblate currently supports several variants of JSON translations:

Archivos con simples correspondencias clave-valor.
Archivos con claves anidadas.
Archivos JSON de i18next
Archivos JSON de go-i18n
JSON para WebExtension
Archivo ARB

JSON translations are usually monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Archivo de ejemplo:

{
  "Hello, world!\n": "Ahoj světe!\n",
  "Orangutan has %d banana.\n": "",
  "Try Weblate at https://demo.weblate.org/!\n": "",
  "Thank you for using Weblate.": ""
}

Nested files are supported as well (see above for requirements), such a file can look like:

{
  "weblate": {
    "hello": "Ahoj světe!\n",
    "orangutan": "",
    "try": "",
    "thanks": ""
  }
}

Advertencia

Weblate currently handles nested JSON by flattening the keys. This leads to serializing issues when special chars such as . or [] are used in the actual keys, because Weblate thinks it is indication of nesting.

See <https://github.com/WeblateOrg/weblate/issues/2149>

Typical Weblate Configuración de componentes
Máscara de archivos	`langs/translation-*.json`
Archivo de base monolingüe	`langs/translation-en.json`
Plantilla para traducciones nuevas	Empty
Formato de archivo	JSON nested structure file

Ver también

JSON, Personalizar la salida de JSON, Limpieza de archivos de traducción,

Archivos JSON de i18next¶

Distinto en la versión 2.17: Since Weblate 2.17 and with translate-toolkit at-least 2.2.5, i18next JSON files with plurals are supported as well.

i18next is an internationalization framework written in and for JavaScript. Weblate supports its localization files with features such as plurals.

i18next translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Nota

Weblate supports the i18next JSON v3 format. The v2 and v1 variants are mostly compatible, with exception of how plurals are handled.

Archivo de ejemplo:

{
  "hello": "Hello",
  "apple": "I have an apple",
  "apple_plural": "I have {{count}} apples",
  "apple_negative": "I have no apples"
}

Typical Weblate Configuración de componentes
Máscara de archivos	`langs/*.json`
Archivo de base monolingüe	`langs/en.json`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo JSON de i18next

Ver también

JSON, i18next JSON Format, Personalizar la salida de JSON, Limpieza de archivos de traducción

Archivos JSON de go-i18n¶

Nuevo en la versión 4.1.

go-i18n translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Nota

Weblate supports the go-i18n JSON v2 format, it does not support flat JSON files supported in v1.

Typical Weblate Configuración de componentes
Máscara de archivos	`langs/*.json`
Archivo de base monolingüe	`langs/en.json`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo JSON de go-i18n

Ver también

JSON, go-i18n, Personalizar la salida de JSON, Limpieza de archivos de traducción,

Archivo ARB¶

Nuevo en la versión 4.1.

ARB translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Typical Weblate Configuración de componentes
Máscara de archivos	`lib/l10n/intl_*.arb`
Archivo de base monolingüe	`lib/l10n/intl_en.arb`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo ARB

Ver también

JSON, Application Resource Bundle Specification, Internationalizing Flutter apps, Personalizar la salida de JSON, Limpieza de archivos de traducción

JSON para WebExtension¶

Nuevo en la versión 2.16: This is supported since Weblate 2.16 and with translate-toolkit at-least 2.2.4.

File format used when translating extensions for Mozilla Firefox or Google Chromium.

Nota

While this format is called JSON, its specification allows to include comments, which are not part of JSON specification. Weblate currently does not support file with comments.

Archivo de ejemplo:

{
  "hello": {
    "message": "Ahoj světe!\n",
    "description": "Description",
    "placeholders": {
      "url": {
        "content": "$1",
        "example": "https://developer.mozilla.org"
      }
    }
  },
  "orangutan": {
    "message": "",
    "description": "Description"
  },
  "try": {
    "message": "",
    "description": "Description"
  },
  "thanks": {
    "message": "",
    "description": "Description"
  }
}

Typical Weblate Configuración de componentes
Máscara de archivos	`_locales/*/messages.json`
Archivo de base monolingüe	`_locales/en/messages.json`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Archivo JSON para WebExtension

Ver también

JSON, Google chrome.i18n, Mozilla Extensions Internationalization

.XML resource files¶

Nuevo en la versión 2.3.

A .XML resource (.resx) file employs a monolingual XML file format used in Microsoft .NET applications. It is interchangeable with .resw, when using identical syntax to .resx.

Typical Weblate Configuración de componentes
Máscara de archivos	`Resources/Language.*.resx`
Archivo de base monolingüe	`Resources/Language.resx`
Plantilla para traducciones nuevas	Empty
Formato de archivo	.NET resource file

Ver también

.NET Resource files (.resx), Limpieza de archivos de traducción,

CSV files¶

Nuevo en la versión 2.4.

CSV files can contain a simple list of source and translation. Weblate supports the following files:

Files with header defining fields (source, translation, location, …). This is the recommended approach, as it is the least error prone.
Files with two fields—source and translation (in this order), choose Simple CSV file as file format
Files with fields as defined by translate-toolkit: location, source, target, ID, fuzzy, context, translator_comments, developer_comments

Advertencia

The CSV format currently automatically detects the dialect of the CSV file. In some cases the automatic detection might fail and you will get mixed results. This is especially true for CSV files with newlines in the values. As a workaround it is recommended to omit quoting characters.

Archivo de ejemplo:

Thank you for using Weblate.,Děkujeme za použití Weblate.

Typical Weblate Configuración de componentes
Máscara de archivos	`locale/*.csv`
Archivo de base monolingüe	Empty
Plantilla para traducciones nuevas	`locale/en.csv`
Formato de archivo	CSV file

Ver también

CSV

YAML files¶

Nuevo en la versión 2.9.

The plain YAML files with string keys and values. Weblate also extract strings from lists or dictionaries.

Example of a YAML file:

weblate:
  hello: ""
  orangutan": ""
  try": ""
  thanks": ""

Typical Weblate Configuración de componentes
Máscara de archivos	`translations/messages.*.yml`
Archivo de base monolingüe	`translations/messages.en.yml`
Plantilla para traducciones nuevas	Empty
Formato de archivo	YAML file

Ver también

YAML, Ruby YAML files

Ruby YAML files¶

Nuevo en la versión 2.9.

Ruby i18n YAML files with language as root node.

Example Ruby i18n YAML file:

cs:
  weblate:
    hello: ""
    orangutan: ""
    try: ""
    thanks: ""

Typical Weblate Configuración de componentes
Máscara de archivos	`translations/messages.*.yml`
Archivo de base monolingüe	`translations/messages.en.yml`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Ruby YAML file

Ver también

YAML, YAML files

DTD files¶

Nuevo en la versión 2.18.

Example DTD file:

<!ENTITY hello "">
<!ENTITY orangutan "">
<!ENTITY try "">
<!ENTITY thanks "">

Typical Weblate Configuración de componentes
Máscara de archivos	`locale/*.dtd`
Archivo de base monolingüe	`locale/en.dtd`
Plantilla para traducciones nuevas	Empty
Formato de archivo	DTD file

Ver también

Mozilla DTD format

Flat XML files¶

Nuevo en la versión 3.9.

Example of a flat XML file:

<?xml version='1.0' encoding='UTF-8'?>
<root>
  <str key="hello_world">Hello World!</str>
  <str key="resource_key">Translated value.</str>
</root>

Typical Weblate Configuración de componentes
Máscara de archivos	`locale/*.xml`
Archivo de base monolingüe	`locale/en.xml`
Plantilla para traducciones nuevas	Empty
Formato de archivo	Flat XML file

Ver también

Flat XML

Archivos RC de Windows¶

Distinto en la versión 4.1: Se ha reescrito el código de compatibilidad con los archivos RC de Windows.

Nota

Support for this format is currently in beta, feedback from testing is welcome.

Archivo RC de Windows de ejemplo:

LANGUAGE LANG_CZECH, SUBLANG_DEFAULT

STRINGTABLE
BEGIN
    IDS_MSG1                "Hello, world!\n"
    IDS_MSG2                "Orangutan has %d banana.\n"
    IDS_MSG3                "Try Weblate at http://demo.weblate.org/!\n"
    IDS_MSG4                "Thank you for using Weblate."
END

Typical Weblate Configuración de componentes
Máscara de archivos	`lang/*.rc`
Archivo de base monolingüe	`lang/en-US.rc`
Plantilla para traducciones nuevas	`lang/en-US.rc`
Formato de archivo	Archivo RC

Ver también

Windows RC files

Archivos de metadatos de tiendas de aplicaciones¶

Nuevo en la versión 3.5.

Es posible traducir los metadatos utilizados en las catalogaciones de las aplicaciones en varias tiendas. Actualmente, las herramientas siguientes son compatibles:

Los metadatos se componen de varios archivos de texto, los cuales Weblate presentará como cadenas por traducir separadas.

Typical Weblate Configuración de componentes
Máscara de archivos	`fastlane/android/metadata/*`
Archivo de base monolingüe	`fastlane/android/metadata/en-US`
Plantilla para traducciones nuevas	`fastlane/android/metadata/en-US`
Formato de archivo	App store metadata files

Archivos de subtítulos¶

Nuevo en la versión 3.7.

Con Weblate puede traducir varios archivos de subtítulos:

Archivo de subtítulos de SubRip (*.srt)
Archivo de subtítulos de MicroDVD (*.sub)
Advanced Substation Alpha subtitles file (*.ass)
Substation Alpha subtitle file (*.ssa)

Typical Weblate Configuración de componentes
Máscara de archivos	`path/*.srt`
Archivo de base monolingüe	`path/en.srt`
Plantilla para traducciones nuevas	`path/en.srt`
Formato de archivo	Archivo de subtítulos de SubRip

Ver también

Subtitles

Open XML de Excel¶

Nuevo en la versión 3.2.

Excel Open XML (.xlsx) files can be imported and exported.

When uploading XLSX files for translation, be aware that only the active worksheet is considered, and there must be at least a column called source (which contains the source string) and a column called target (which contains the translation). Additionally there should be the column called context (which contains the context path of the translation string). If you use the XLSX download for exporting the translations into an Excel workbook, you already get a file with the correct file format.

Archivos HTML¶

Nuevo en la versión 4.1.

Nota

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the HTML files and offered for the translation.

Ver también

HTML

Formato OpenDocument¶

Nuevo en la versión 4.1.

Nota

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the OpenDocument files and offered for the translation.

Ver también

OpenDocument Format

Formato IDML¶

Nuevo en la versión 4.1.

Nota

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the Adobe InDesign Markup Language files and offered for the translation.

Otros¶

Most formats supported by translate-toolkit which support serializing can be easily supported, but they did not (yet) receive any testing. In most cases some thin layer is needed in Weblate to hide differences in behavior of different translate-toolkit storages.

Ver también

Translation Related File Formats

Adding new translations¶

Distinto en la versión 2.18: In versions prior to 2.18 the behaviour of adding new translations was file format specific.

Weblate puede iniciar automáticamente traducciones nuevas en todos los formatos de archivo.

Some formats expect to start with an empty file and only translated strings to be included (for example Recursos de cadenas de Android), while others expect to have all keys present (for example GNU gettext). In some situations this really doesn’t depend on the format, but rather on the framework you use to handle the translation (for example with Archivos JSON).

When you specify Plantilla para traducciones nuevas in Configuración de componentes, Weblate will use this file to start new translations. Any exiting translations will be removed from the file when doing so.

When Template for new translations is empty and the file format supports it, an empty file is created where new strings will be added once they are translated.

La opción Estilo de código de idioma le permite personalizados los códigos de idioma que se utilizarán en los nombres de archivo generados:

Basado en el formato de archivo predefinido: Depende del formato de archivo; en la mayoría se utiliza POSIX.
Estilo POSIX con guion bajo como separador: Typically used by gettext and related tools, produces language codes like pt_BR.
Estilo POSIX con guion bajo como separador; incluye el código de país: POSIX style language code including the country code even when not necessary (for example “cs_CZ”).
Estilo BCP con guion como separador: Typically used on web platforms, produces language codes like pt-BR.
Estilo BCP con guion como separador; incluye el código de país: BCP style language code including the country code even when not necessary (for example “cs-CZ”).
Estilo Android: Only used in Android apps, produces language codes like pt-rBR.
Estilo Java: Used by Java—mostly BCP with legacy codes for Chinese.

Nota

Weblate recognizes any of these when parsing translation files, the above settings only influences how new files are created.

Cadenas de solo lectura¶

Nuevo en la versión 3.10.

Read-only strings from translation files will be included, but can not be edited in Weblate. This feature is natively supported by few formats (XLIFF and Recursos de cadenas de Android), but can be emulated in others by adding a read-only flag, see Customizing behavior.

Integración de control de versiones¶

Weblate currently supports Git (with extended support for GitHub, Gerrit and Subversion) and Mercurial as version control backends.

Accessing repositories¶

The VCS repository you want to use has to be accessible to Weblate. With a publicly available repository you just need to enter the correct URL (for example https://github.com/WeblateOrg/weblate.git), but for private repositories or for push URLs the setup is more complex and requires authentication.

Accessing repositories from Hosted Weblate¶

For Hosted Weblate there is a dedicated push user registered on GitHub, Bitbucket, Codeberg and GitLab (with username weblate named Weblate push user). You need to add this user as a collaborator and give it appropriate permission to your repository (read only is okay for cloning, write is required for pushing). Depending on service and your organization settings, this happens immediately or requires confirmation from Weblate side.

The invitations on GitHub are accepted automatically within five minutes, on other services manual processing might be needed, so please be patient.

Once the weblate user is added, you can configure Repositorio de código fuente and URL de envío al repositorio using SSH protocol (for example git@github.com:WeblateOrg/weblate.git).

Repositorios SSH¶

The most frequently used method to access private repositories is based on SSH. Authorize the public Weblate SSH key (see Clave SSH de Weblate) to access the upstream repository this way.

Advertencia

On GitHub, each key can be added to only one repository, see Repositorios en GitHub and Accessing repositories from Hosted Weblate.

Weblate also stores the host key fingerprint upon first connection, and fails to connect to the host should it be changed later (see Verifying SSH host keys).

En caso de que necesite efectuar ajustes, hágalos desde la interfaz administrativa de Weblate:

Clave SSH de Weblate¶

The Weblate public key is visible to all users browsing the About page.

Admins can generate or display the public key currently used by Weblate in the (from SSH keys) on the admin interface landing page.

Nota

Por ahora, la clave privada SSH correspondiente no puede tener contraseña, así que cerciórese de protegerla adecuadamente.

Consejo

Make a backup of the generated private Weblate SSH key.

Verifying SSH host keys¶

Weblate automatically remembers the SSH host keys on first access and remembers them for further use.

In case you want to verify them before connecting to the repository, verify the SSH host keys of the servers you are going to access in Add host key, from the same section of the admin interface. Enter the hostname you are going to access (e.g. gitlab.com), and press Submit. Verify its fingerprint matches the server you added. They are shown in the confirmation message:

Repositorios en GitHub¶

Access via SSH is possible (see Repositorios SSH), but in case you need to access more than one repository, you will hit a GitHub limitation on allowed SSH key usage (since one key can be used only for one repository).

In case the Rama a la que enviar is not set, the project is forked and changes pushed through a fork. In case it is set, changes are pushed to the upstream repository and chosen branch.

For smaller deployments, use HTTPS authentication with a personal access token and your GitHub account, see Creating an access token for command-line use.

For bigger setups, it is usually better to create a dedicated user for Weblate, assign it the public SSH key generated in Weblate (see Clave SSH de Weblate) and grant it access to all the repositories you want to translate. This approach is also used for Hosted Weblate, there is dedicated weblate user for that.

Ver también

Accessing repositories from Hosted Weblate

URL internos de Weblate¶

To share one repository between different components you can use a special URL like weblate://project/component. This way, the component will share the VCS repository configuration with the referenced component (project/component in the example).

Weblate automatically adjusts repository URL when creating component when it finds component with matching repository setup. You can override this in last step of component configuration.

Reasons to use this:

Ahorra espacio en disco en el servidor, ya que el repositorio se almacena solo una vez.
Acelera las actualizaciones, ya que se actualiza solo un repositorio.
There is just single exported repository with Weblate translations (see Git exporter).
Some addons can operate on more components sharing single repository, for example Concentrar consignas de Git.

Repositorios HTTPS¶

Para acceder a repositorios HTTPS protegidos, incluya el nombre de usuario y la contraseña en el URL. No se preocupe, Weblate quitará estos datos al mostrar el URL a los usuarios (incluso si se les permite ver el URL del repositorio).

For example the GitHub URL with authentication added might look like: https://user:your_access_token@github.com/WeblateOrg/weblate.git.

Nota

If you username or password contains special characters, those have to be URL encoded, for example https://user%40example.com:%24password%23@bitbucket.org/….

Using proxy¶

If you need to access HTTP/HTTPS VCS repositories using a proxy server, configure the VCS to use it.

This can be done using the http_proxy, https_proxy, and all_proxy environment variables, (as described in the cURL documentation) or by enforcing it in the VCS configuration, for example:

git config --global http.proxy http://user:password@proxy.example.com:80

Nota

The proxy configuration needs to be done under user running Weblate (see also Permisos del sistema de archivos) and with HOME=$DATA_DIR/home (see DATA_DIR), otherwise Git executed by Weblate will not use it.

Ver también

The cURL manpage, Git config documentation

Git¶

Ver también

See Accessing repositories for info on how to access different kinds of repositories.

Git con envío forzado¶

This behaves exactly like Git itself, the only difference being that it always force pushes. This is intended only in the case of using a separate repository for translations.

Advertencia

Use with caution, as this easily leads to lost commits in your upstream repository.

Customizing Git configuration¶

Weblate invokes all VCS commands with HOME=$DATA_DIR/home (see DATA_DIR), therefore editing the user configuration needs to be done in DATA_DIR/home/.git.

Auxiliares remotos de Git¶

You can also use Git remote helpers for additionally supporting other version control systems, but be prepared to debug problems this may lead to.

At this time, helpers for Bazaar and Mercurial are available within separate repositories on GitHub: git-remote-hg and git-remote-bzr. Download them manually and put somewhere in your search path (for example ~/bin). Make sure you have the corresponding version control systems installed.

Once you have these installed, such remotes can be used to specify a repository in Weblate.

To clone the gnuhello project from Launchpad using Bazaar:

bzr::lp:gnuhello

For the hello repository from selenic.com using Mercurial:

hg::http://selenic.com/repo/hello

Advertencia

The inconvenience of using Git remote helpers is for example with Mercurial, the remote helper sometimes creates a new tip when pushing changes back.

GitHub¶

Nuevo en la versión 2.3.

This adds a thin layer atop Git using the hub tool to allow pushing translation changes as pull requests, instead of pushing directly to the repository.

Git pushes changes directly to a repository, while GitHub creates pull requests. The latter is not needed for merely accessing Git repositories.

Ver también

Enviar cambios efectuados en Weblate

Enviar cambios a GitHub como solicitudes de incorporación¶

Si no se desea enviar las traducciones directamente a un repositorio en GitHub, estas pueden enviarse como una o múltiples solicitudes de incorporación.

Ver también

GITHUB_USERNAME, Setting up hub for configuration instructions

Setting up hub¶

Enviar cambios a GitHub como solicitudes de incorporación requires a configured hub installation on your server. Follow the installation instructions at https://hub.github.com/ use hub to finish the configuration, for example:

# Use DATA_DIR as configured in Weblate settings.py, it is /app/data in the Docker
HOME=${DATA_DIR}/home hub clone octocat/Spoon-Knife

The hub will ask you for your GitHub credentials, retrieve a token and store it in ~/.config/hub. This file has to be readable by the user running Weblate.

Nota

Use the username you configured hub with, as GITHUB_USERNAME (WEBLATE_GITHUB_USERNAME for the Docker image).

GitLab¶

Nuevo en la versión 3.9.

This just adds a thin layer atop Git using the lab tool to allow pushing translation changes as merge requests instead of pushing directly to the repository.

There is no need to use this access Git repositories, ordinary Git works the same, the only difference is how pushing to a repository is handled. With Git changes are pushed directly to the repository, while GitLab creates merge request.

Ver también

Enviar cambios efectuados en Weblate

Enviar cambios a GitLab como solicitudes de fusión¶

Si no se desea enviar las traducciones directamente a un repositorio en GitLab, estas pueden enviarse como una o múltiples solicitudes de fusión.

Configure the lab command line tool and set GITLAB_USERNAME for this to work.

Ver también

GITLAB_USERNAME, Setting up Lab for configuration instructions

Setting up Lab¶

Enviar cambios a GitLab como solicitudes de fusión requires a configured lab installation on your server. Follow the installation instructions at lab and run it without any arguments to finish the configuration, for example:

# Use DATA_DIR as configured in Weblate settings.py, it is /app/data in the Docker
$ HOME=${DATA_DIR}/home lab
Enter GitLab host (default: https://gitlab.com):
Create a token here: https://gitlab.com/profile/personal_access_tokens
Enter default GitLab token (scope: api):
(Config is saved to ~/.config/lab.hcl)

The lab will ask you for your GitLab access token, retrieve it and store it in ~/.config/lab.hcl. The file has to be readable by the user running Weblate.

Nota

Use the username you configured lab with, as GITLAB_USERNAME (WEBLATE_GITLAB_USERNAME for the Docker image).

Gerrit¶

Nuevo en la versión 2.2.

Adds a thin layer atop Git using the git-review tool to allow pushing translation changes as Gerrit review requests, instead of pushing a directory to the repository.

La documentación de Gerrit tiene los detalles sobre la configuración necesaria para la puesta en marcha de dichos repositorios.

Mercurial¶

Nuevo en la versión 2.1.

Mercurial es otro sistema de control de versiones que puede utilizar directamente en Weblate.

Nota

Debería funcionar con cualquier versión de Mercurial, pero a veces hay cambios incompatibles en la interfaz de línea de órdenes que quebrantan la integración con Weblate.

Ver también

See Accessing repositories for info on how to access different kinds of repositories.

Subversion¶

Nuevo en la versión 2.8.

Weblate uses git-svn to interact with subversion repositories. It is a Perl script that lets subversion be used by a Git client, enabling users to maintain a full clone of the internal repository and commit locally.

Nota

Weblate tries to detect Subversion repository layout automatically - it supports both direct URLs for branch or repositories with standard layout (branches/, tags/ and trunk/). More info about this is to be foud in the git-svn documentation. If your repository does not have a standard layout and you encounter errors, try including the branch name in the repository URL and leaving branch empty.

Distinto en la versión 2.19: Before this, there was only support for standard layout repositories.

Datos de acceso de Subversion¶

Weblate expects you to have accepted the certificate up-front and if needed, your credentials. It will look to insert them into the DATA_DIR directory. Accept the certificate by using svn once with the $HOME environment variable set to the DATA_DIR:

# Use DATA_DIR as configured in Weblate settings.py, it is /app/data in the Docker
HOME=${DATA_DIR}/home svn co https://svn.example.com/example

Ver también

DATA_DIR

Archivos locales¶

Nuevo en la versión 3.8.

Weblate can also operate without a remote VCS. The initial translations are imported by uploading them. Later you can replace individual files by file upload, or add translation strings directly from Weblate (currently available only for monolingual translations).

In the background Weblate creates a Git repository for you and all changes are tracked in. In case you later decide to use a VCS to store the translations, you already have a repository within Weblate can base your integration on.

Weblate’s REST API¶

Nuevo en la versión 2.6: The REST API is available since Weblate 2.6.

The API is accessible on the /api/ URL and it is based on Django REST framework. You can use it directly or by Cliente de Weblate.

Authentication and generic parameters¶

The public project API is available without authentication, though unauthenticated requests are heavily throttled (by default to 100 requests per day), so it is recommended to use authentication. The authentication uses a token, which you can get in your profile. Use it in the Authorization header:

ANY /¶

Generic request behaviour for the API, the headers, status codes and parameters here apply to all endpoints as well.

Query Parameters

format – Response format (overrides Accept). Possible values depends on REST framework setup, by default json and api are supported. The latter provides web browser interface for API.

Request Headers

Accept – the response content type depends on Accept header
Authorization – optional token to authenticate

Response Headers

Content-Type – this depends on Accept header of request
Allow – list of allowed HTTP methods on object

Response JSON Object

detail (string) – verbose description of failure (for HTTP status codes other than 200 OK)
count (int) – total item count for object lists
next (string) – next page URL for object lists
previous (string) – previous page URL for object lists
results (array) – results for object lists
url (string) – URL to access this resource using API
web_url (string) – URL to access this resource using web browser

Status Codes

200 OK – when request was correctly handled
400 Bad Request – when form parameters are missing
403 Forbidden – when access is denied
429 Too Many Requests – when throttling is in place

Authentication examples¶

Example request:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Example response:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

CURL example:

curl \
    -H "Authorization: Token TOKEN" \
    https://example.com/api/

Passing Parameters Examples¶

For the POST method the parameters can be specified either as form submission (application/x-www-form-urlencoded) or as JSON (application/json).

Form request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN

operation=pull

JSON request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

CURL JSON example:

curl \
    --data-binary '{"operation":"pull"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Rate limiting¶

The API requests are rate limited; the default configuration limits it to 100 requests per day for anonymous users and 5000 requests per hour for authenticated users.

Rate limiting can be adjusted in the settings.py; see Throttling in Django REST framework documentation for more details how to configure it.

The status of rate limiting is reported in following headers:

`X-RateLimit-Limit`	Rate limiting limit of requests to perform
`X-RateLimit-Remaining`	Remaining limit of requests
`X-RateLimit-Reset`	Number of seconds until ratelimit window resets

Distinto en la versión 4.1: Added ratelimiting status headers.

API Entry Point¶

GET /api/¶

The API root entry point.

Example request:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Example response:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

Usuarios¶

Nuevo en la versión 4.0.

GET /api/users/¶: Devuelve un listado de usuarios si tiene permisos para ver y gestionar usuarios. En caso contrario, podrá ver solo sus propios datos.

Ver también

Users object attributes are documented at GET /api/users/(str:username)/.

POST /api/users/¶

Creates a new user.

Parameters

username (string) – Nombre de usuario
full_name (string) – User full name
email (string) – User email
is_superuser (boolean) – Is user superuser? (optional)
is_active (boolean) – Is user active? (optional)

GET /api/users/(str: username)/¶

Returns information about users.

Parameters

username (string) – User’s username

Response JSON Object

username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created
groups (array) – link to associated groups; see GET /api/groups/(int:id)/

Example JSON data:

{
    "email": "user@example.com",
    "full_name": "Example User",
    "username": "exampleusername",
    "groups": [
        "http://example.com/api/groups/2/",
        "http://example.com/api/groups/3/"
    ],
    "is_superuser": true,
    "is_active": true,
    "date_joined": "2020-03-29T18:42:42.617681Z",
    "url": "http://example.com/api/users/exampleusername/"
}

PUT /api/users/(str: username)/¶

Changes the user parameters.

Parameters

username (string) – User’s username

Response JSON Object

username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created

PATCH /api/users/(str: username)/¶

Changes the user parameters.

Parameters

username (string) – User’s username

Response JSON Object

username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created

DELETE /api/users/(str: username)/¶

Deletes all user information and marks the user inactive.

Parameters

username (string) – User’s username

POST /api/users/(str: username)/groups/¶

Associate groups with a user.

Parameters

username (string) – User’s username

Form Parameters

string group_id – The unique group ID

GET /api/users/(str: username)/notifications/¶

List subscriptions of a user.

Parameters

username (string) – User’s username

POST /api/users/(str: username)/notifications/¶

Associate subscriptions with a user.

Parameters

username (string) – User’s username

Request JSON Object

notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications

GET /api/users/(str: username)/notifications/(int: subscription_id)/¶

Get a subscription associated with a user.

Parameters

username (string) – User’s username
subscription_id (int) – ID of notification registered

PUT /api/users/(str: username)/notifications/(int: subscription_id)/¶

Edit a subscription associated with a user.

Parameters

username (string) – User’s username
subscription_id (int) – ID of notification registered

Request JSON Object

notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications

PATCH /api/users/(str: username)/notifications/(int: subscription_id)/¶

Edit a subscription associated with a user.

Parameters

username (string) – User’s username
subscription_id (int) – ID of notification registered

Request JSON Object

notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications

DELETE /api/users/(str: username)/notifications/(int: subscription_id)/¶

Delete a subscription associated with a user.

Parameters

username (string) – User’s username
subscription_id – Name of notification registered
subscription_id – int

Grupos¶

Nuevo en la versión 4.0.

GET /api/groups/¶: Devuelve una lista de grupos si tiene permisos para ver y gestionar grupos. En caso contrario, verá solo los grupos a los que pertenece el usuario.

Ver también

Group object attributes are documented at GET /api/groups/(int:id)/.

POST /api/groups/¶

Creates a new group.

Parameters

name (string) – Nombre de grupo
project_selection (int) – Group of project selection from given options
language_selection (int) – Group of languages selected from given options

GET /api/groups/(int: id)/¶

Returns information about group.

Parameters

id (int) – Identificador del grupo

Response JSON Object

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas
roles (array) – link to associated roles; see GET /api/roles/(int:id)/
projects (array) – link to associated projects; see GET /api/projects/(string:project)/
components (array) – link to associated components; see GET /api/components/(string:project)/(string:component)/
componentlist (array) – link to associated componentlist; see GET /api/component-lists/(str:slug)/

Example JSON data:

{
    "name": "Guests",
    "project_selection": 3,
    "language_selection": 1,
    "url": "http://example.com/api/groups/1/",
    "roles": [
        "http://example.com/api/roles/1/",
        "http://example.com/api/roles/2/"
    ],
    "languages": [
        "http://example.com/api/languages/en/",
        "http://example.com/api/languages/cs/",
    ],
    "projects": [
        "http://example.com/api/projects/demo1/",
        "http://example.com/api/projects/demo/"
    ],
    "componentlist": "http://example.com/api/component-lists/new/",
    "components": [
        "http://example.com/api/components/demo/weblate/"
    ]
}

PUT /api/groups/(int: id)/¶

Cambia los parámetros del grupo.

Parameters

id (int) – Identificador del grupo

Response JSON Object

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas

PATCH /api/groups/(int: id)/¶

Cambia los parámetros del grupo.

Parameters

id (int) – Identificador del grupo

Response JSON Object

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas

DELETE /api/groups/(int: id)/¶

Elimina el grupo.

Parameters

id (int) – Identificador del grupo

POST /api/groups/(int: id)/roles/¶

Associate roles with a group.

Parameters

id (int) – Identificador del grupo

Form Parameters

string role_id – The unique role ID

POST /api/groups/(int: id)/components/¶

Associate components with a group.

Parameters

id (int) – Identificador del grupo

Form Parameters

string component_id – The unique component ID

DELETE /api/groups/(int: id)/components/(int: component_id)¶

Delete component from a group.

Parameters

id (int) – Identificador del grupo
component_id (int) – The unique component ID

POST /api/groups/(int: id)/projects/¶

Associate projects with a group.

Parameters

id (int) – Identificador del grupo

Form Parameters

string project_id – The unique project ID

DELETE /api/groups/(int: id)/projects/(int: project_id)¶

Delete project from a group.

Parameters

id (int) – Identificador del grupo
project_id (int) – The unique project ID

POST /api/groups/(int: id)/languages/¶

Associate languages with a group.

Parameters

id (int) – Identificador del grupo

Form Parameters

string language_code – The unique language code

DELETE /api/groups/(int: id)/languages/(string: language_code)¶

Delete language from a group.

Parameters

id (int) – Identificador del grupo
language_code (string) – The unique language code

POST /api/groups/(int: id)/componentlists/¶

Associate componentlists with a group.

Parameters

id (int) – Identificador del grupo

Form Parameters

string component_list_id – The unique componentlist ID

DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)¶

Delete componentlist from a group.

Parameters

id (int) – Identificador del grupo
component_list_id (int) – The unique componentlist ID

Roles¶

GET /api/roles/¶: Returns a list of all roles associated with user. If user is superuser, then list of all existing roles is returned.

Ver también

Roles object attributes are documented at GET /api/roles/(int:id)/.

POST /api/roles/¶

Creates a new role.

Parameters

name (string) – Role name
permissions (array) – List of codenames of permissions

GET /api/roles/(int: id)/¶

Returns information about a role.

Parameters

id (int) – Role ID

Response JSON Object

name (string) – Role name
permissions (array) – list of codenames of permissions

Example JSON data:

{
    "name": "Access repository",
    "permissions": [
        "vcs.access",
        "vcs.view"
    ],
    "url": "http://example.com/api/roles/1/",
}

PUT /api/roles/(int: id)/¶

Changes the role parameters.

Parameters

id (int) – Role’s ID

Response JSON Object

name (string) – Role name
permissions (array) – list of codenames of permissions

PATCH /api/roles/(int: id)/¶

Changes the role parameters.

Parameters

id (int) – Role’s ID

Response JSON Object

name (string) – Role name
permissions (array) – list of codenames of permissions

DELETE /api/roles/(int: id)/¶

Deletes the role.

Parameters

id (int) – Role’s ID

Idiomas¶

GET /api/languages/¶: Devuelve un listado de todos los idiomas.

Ver también

Language object attributes are documented at GET /api/languages/(string:language)/.

POST /api/languages/¶

Crea un idioma nuevo.

Parameters

code (string) – Nombre del idioma
name (string) – Nombre del idioma
direction (string) – Dirección del idioma
plural (object) – Fórmulay número de plurales del idioma

GET /api/languages/(string: language)/¶

Devuelve información relativa a un idioma.

Parameters

language (string) – Código de idioma

Response JSON Object

code (string) – Código de idioma
direction (string) – Dirección del texto
plural (object) – Objeto de información de plurales de un idioma
aliases (array) – Array of aliases for language

Example JSON data:

{
    "code": "en",
    "direction": "ltr",
    "name": "English",
    "plural": {
        "id": 75,
        "source": 0,
        "number": 2,
        "formula": "n != 1",
        "type": 1
    },
    "aliases": [
        "english",
        "en_en",
        "base",
        "source",
        "eng"
    ],
    "url": "http://example.com/api/languages/en/",
    "web_url": "http://example.com/languages/en/",
    "statistics_url": "http://example.com/api/languages/en/statistics/"
}

PUT /api/languages/(string: language)/¶

Permite cambiar los parámetros del idioma.

Parameters

language (string) – Código del idioma

Request JSON Object

name (string) – Nombre del idioma
direction (string) – Dirección del idioma
plural (object) – Language plural details

PATCH /api/languages/(string: language)/¶

Permite cambiar los parámetros del idioma.

Parameters

language (string) – Código del idioma

Request JSON Object

name (string) – Nombre del idioma
direction (string) – Dirección del idioma
plural (object) – Language plural details

DELETE /api/languages/(string: language)/¶

Elimina el idioma.

Parameters

language (string) – Código del idioma

GET /api/languages/(string: language)/statistics/¶

Devuelve estadísticas sobre un idioma.

Parameters

language (string) – Código de idioma

Response JSON Object

total (int) – número total de cadenas
total_words (int) – número total de palabras
last_change (timestamp) – últimos cambios en el idioma
recent_changes (int) – número total de cambios
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
translated_words (int) – número de palabras traducidas
translated_words_percent (int) – porcentaje de palabras traducidas
translated_chars (int) – número de caracteres traducidos
translated_chars_percent (int) – porcentaje de caracteres traducidos
total_chars (int) – número de caracteres totales
fuzzy (int) – número de cadenas por revisar
fuzzy_percent (int) – porcentaje de cadenas por revisar
failing (int) – número de cadenas fallidas
failing – porcentaje de cadenas fallidas

Proyectos¶

GET /api/projects/¶: Devuelve un listado de todos los proyectos.

Ver también

Project object attributes are documented at GET /api/projects/(string:project)/.

POST /api/projects/¶

Nuevo en la versión 3.9.

Crea un proyecto nuevo.

Parameters

name (string) – Nombre del proyecto
slug (string) – «Slug» del proyecto
web (string) – Sitio web del proyecto
source_language (string) – Project source language code (optional)

GET /api/projects/(string: project)/¶

Devuelve información relativa a un proyecto.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

name (string) – nombre del proyecto
slug (string) – project slug
source_language (object) – source language object; see GET /api/languages/(string:language)/
web (string) – sitio web del proyecto
components_list_url (string) – URL to components list; see GET /api/projects/(string:project)/components/
repository_url (string) – URL to repository status; see GET /api/projects/(string:project)/repository/
changes_list_url (string) – URL to changes list; see GET /api/projects/(string:project)/changes/

Example JSON data:

{
    "name": "Hello",
    "slug": "hello",
    "source_language": {
        "code": "en",
        "direction": "ltr",
        "name": "English",
        "url": "http://example.com/api/languages/en/",
        "web_url": "http://example.com/languages/en/"
    },
    "url": "http://example.com/api/projects/hello/",
    "web": "https://weblate.org/",
    "web_url": "http://example.com/projects/hello/"
}

DELETE /api/projects/(string: project)/¶

Nuevo en la versión 3.9.

Elimina un proyecto.

Parameters

project (string) – URL semántico del proyecto

GET /api/projects/(string: project)/changes/¶

Returns a list of project changes. This is essentially a project scoped GET /api/changes/ accepting same params.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

results (array) – array of component objects; see GET /api/changes/(int:id)/

GET /api/projects/(string: project)/repository/¶

Returns information about VCS repository status. This endpoint contains only an overall summary for all repositories for the project. To get more detailed status use GET /api/components/(string:project)/(string:component)/repository/.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

needs_commit (boolean) – whether there are any pending changes to commit
needs_merge (boolean) – whether there are any upstream changes to merge
needs_push (boolean) – whether there are any local changes to push

Example JSON data:

{
    "needs_commit": true,
    "needs_merge": false,
    "needs_push": true
}

POST /api/projects/(string: project)/repository/¶

Performs given operation on the VCS repository.

Parameters

project (string) – URL semántico del proyecto

Request JSON Object

operation (string) – Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

result (boolean) – resultado de la operación

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/repository/

JSON request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/projects/(string: project)/components/¶

Devuelve un listado de componentes de traducción en el proyecto indicado.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

results (array) – array of component objects; see GET /api/components/(string:project)/(string:component)/

POST /api/projects/(string: project)/components/¶

Nuevo en la versión 3.9.

Crea componentes de traducción en el proyecto indicado.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

result (object) – Created component object; see GET /api/components/(string:project)/(string:component)/

CURL example:

curl \
    --data-binary '{
        "branch": "master",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "slug": "weblate",
        "repo": "file:///home/nijel/work/weblate-hello",
        "template": "",
        "new_base": "",
        "vcs": "git"
    }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON request example:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "vcs": "git"
}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

GET /api/projects/(string: project)/languages/¶

Returns paginated statistics for all languages within a project.

Nuevo en la versión 3.8.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

results (array) – array of translation statistics objects
language (string) – nombre del idioma
code (string) – código del idioma
total (int) – número total de cadenas
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
total_words (int) – número total de palabras
translated_words (int) – número de palabras traducidas
words_percent (float) – porcentaje de palabras traducidas

GET /api/projects/(string: project)/statistics/¶

Devuelve estadísticas sobre un proyecto.

Nuevo en la versión 3.8.

Parameters

project (string) – URL semántico del proyecto

Response JSON Object

total (int) – número total de cadenas
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
total_words (int) – número total de palabras
translated_words (int) – número de palabras traducidas
words_percent (float) – porcentaje de palabras traducidas

Componentes¶

GET /api/components/¶: Devuelve un listado de componentes de traducción.

Ver también

Component object attributes are documented at GET /api/components/(string:project)/(string:component)/.

GET /api/components/(string: project)/(string: component)/¶

Devuelve información relativa al componente de traducción.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

project (object) – the translation project; see GET /api/projects/(string:project)/
name (string) – Nombre de componente
slug (string) – «Slug» del componente
vcs (string) – Sistema de control de versiones
repo (string) – Repositorio de código fuente
git_export (string) – URL de repositorio exportado
branch (string) – Rama del repositorio
push_branch (string) – Rama a la que enviar
filemask (string) – File mask
template (string) – Archivo de base monolingüe
edit_template (string) – Editar archivo de base
intermediate (string) – Archivo de idioma intermediario
new_base (string) – Plantilla para traducciones nuevas
file_format (string) – Formato de archivo
license (string) – Licencia de la traducción
agreement (string) – Acuerdo de contribuidor
new_lang (string) – Adición de traducciones nuevas
language_code_style (string) – Estilo de código de idioma
push (string) – URL de envío al repositorio
check_flags (string) – Indicadores de traducción
priority (string) – Prioridad
enforced_checks (string) – Comprobaciones forzosas
restricted (string) – Acceso restringido
repoweb (string) – Explorador del repositorio
report_source_bugs (string) – Source string bug report address
merge_style (string) – Estilo de fusión
commit_message (string) – Commit, add, delete, merge and addon messages
add_message (string) – Commit, add, delete, merge and addon messages
delete_message (string) – Commit, add, delete, merge and addon messages
merge_message (string) – Commit, add, delete, merge and addon messages
addon_message (string) – Commit, add, delete, merge and addon messages
allow_translation_propagation (string) – Permitir propagación de traducciones
enable_suggestions (string) – Activar sugerencias
suggestion_voting (string) – Votar sugerencias
suggestion_autoaccept (string) – Autoaceptar sugerencias
push_on_commit (string) – Enviar al consignar
commit_pending_age (string) – Antigüedad de cambios por consignar
auto_lock_error (string) – Bloquear al producirse un error
language_regex (string) – Filtro de idioma
variant_regex (string) – Expresión regular de variantes
repository_url (string) – URL to repository status; see GET /api/components/(string:project)/(string:component)/repository/
translations_url (string) – URL to translations list; see GET /api/components/(string:project)/(string:component)/translations/
lock_url (string) – URL to lock status; see GET /api/components/(string:project)/(string:component)/lock/
changes_list_url (string) – URL to changes list; see GET /api/components/(string:project)/(string:component)/changes/

Example JSON data:

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PATCH /api/components/(string: project)/(string: component)/¶

Edit a component by a patch request.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Request JSON Object

name (string) – nombre del componente
slug (string) – slug of component
repo (string) – VCS repository URL

CURL example:

curl \
    --data-binary '{"name": "new name"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    PATCH http://example.com/api/projects/hello/components/

JSON request example:

PATCH /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "name": "new name"
}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "new name",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PUT /api/components/(string: project)/(string: component)/¶

Edit a component by a put request.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Request JSON Object

branch (string) – Rama del repositorio de control de versiones
file_format (string) – formato de archivo de las traducciones
filemask (string) – mask of translation files in the repository
name (string) – nombre del componente
slug (string) – slug of component
repo (string) – VCS repository URL
template (string) – base file for monolingual translations
new_base (string) – base file for adding new translations
vcs (string) – sistema de control de versiones

DELETE /api/components/(string: project)/(string: component)/¶

Nuevo en la versión 3.9.

Elimina un componente.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

GET /api/components/(string: project)/(string: component)/changes/¶

Returns a list of component changes. This is essentially a component scoped GET /api/changes/ accepting same params.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

results (array) – array of component objects; see GET /api/changes/(int:id)/

GET /api/components/(string: project)/(string: component)/screenshots/¶

Devuelve un listado de las capturas de pantalla del componente.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

results (array) – array of component screenshots; see GET /api/screenshots/(int:id)/

GET /api/components/(string: project)/(string: component)/lock/¶

Devuelve el estado de bloqueo del componente.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

locked (boolean) – whether component is locked for updates

Example JSON data:

{
    "locked": false
}

POST /api/components/(string: project)/(string: component)/lock/¶

Establece el estado de bloqueo del componente.

Response is same as GET /api/components/(string:project)/(string:component)/lock/.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Request JSON Object

lock – Boolean whether to lock or not.

CURL example:

curl \
    -d lock=true \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON request example:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"lock": true}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"locked":true}

GET /api/components/(string: project)/(string: component)/repository/¶

Returns information about VCS repository status.

The response is same as for GET /api/projects/(string:project)/repository/.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

needs_commit (boolean) – whether there are any pending changes to commit
needs_merge (boolean) – whether there are any upstream changes to merge
needs_push (boolean) – whether there are any local changes to push
remote_commit (string) – Remote commit information
status (string) – VCS repository status as reported by VCS
merge_failure – Text describing merge failure or null if there is none

POST /api/components/(string: project)/(string: component)/repository/¶

Performs the given operation on a VCS repository.

See POST /api/projects/(string:project)/repository/ for documentation.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Request JSON Object

operation (string) – Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

result (boolean) – resultado de la operación

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON request example:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/components/(string: project)/(string: component)/monolingual_base/¶

Descarga el archivo de base para traducciones monolingües.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

GET /api/components/(string: project)/(string: component)/new_template/¶

Descarga el archivo de plantilla para traducciones nuevas.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

GET /api/components/(string: project)/(string: component)/translations/¶

Devuelve un listado de objetos de traducción en el componente indicado.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

results (array) – array of translation objects; see GET /api/translations/(string:project)/(string:component)/(string:language)/

POST /api/components/(string: project)/(string: component)/translations/¶

Creates new translation in the given component.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Request JSON Object

language_code (string) – translation language code; see GET /api/languages/(string:language)/

Response JSON Object

result (object) – new translation object created

CURL example:

curl \
    -d language_code=cs \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON request example:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"language_code": "cs"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "failing_checks": 0,
    "failing_checks_percent": 0,
    "failing_checks_words": 0,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "is_source": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "id": 125,
    "last_author": null,
    "last_change": null,
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 0,
    "translated_percent": 0.0,
    "translated_words": 0,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

GET /api/components/(string: project)/(string: component)/statistics/¶

Devuelve estadísticas paginadas para todas las traducciones del componente.

Nuevo en la versión 2.7.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente

Response JSON Object

results (array) – array of translation statistics objects; see GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/

Traducciones¶

GET /api/translations/¶: Devuelve un listado de traducciones.

Ver también

Translation object attributes are documented at GET /api/translations/(string:project)/(string:component)/(string:language)/.

GET /api/translations/(string: project)/(string: component)/(string: language)/¶

Devuelve información relativa a una traducción.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Response JSON Object

component (object) – component object; see GET /api/components/(string:project)/(string:component)/
failing_checks (int) – número de cadenas que fallan una comprobación
failing_checks_percent (float) – porcentaje de cadenas que fallan una comprobación
failing_checks_words (int) – número de palabras con comprobaciones fallidas
filename (string) – nombre de archivo de la traducción
fuzzy (int) – número de cadenas marcadas para revisión
fuzzy_percent (float) – porcentaje de cadenas marcadas para revisión
fuzzy_words (int) – número de palabras marcadas para revisión
have_comment (int) – número de cadenas con un comentario
have_suggestion (int) – número de cadenas con una sugerencia
is_template (boolean) – indica si la traducción tiene una base monolingüe
language (object) – source language object; see GET /api/languages/(string:language)/
language_code (string) – el código de idioma utilizado en el repositorio; puede ser distinto del código de idioma del objeto de idioma
last_author (string) – nombre del último autor
last_change (timestamp) – cronomarcador del último cambio
revision (string) – revision hash for the file
share_url (string) – URL para compartir que va a la página de participación
total (int) – número total de cadenas
total_words (int) – número total de palabras
translate_url (string) – URL para traducir
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
translated_words (int) – número de palabras traducidas
repository_url (string) – URL to repository status; see GET /api/translations/(string:project)/(string:component)/(string:language)/repository/
file_url (string) – URL to file object; see GET /api/translations/(string:project)/(string:component)/(string:language)/file/
changes_list_url (string) – URL to changes list; see GET /api/translations/(string:project)/(string:component)/(string:language)/changes/
units_list_url (string) – URL to strings list; see GET /api/translations/(string:project)/(string:component)/(string:language)/units/

Example JSON data:

{
    "component": {
        "branch": "master",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "new_base": "",
        "project": {
            "name": "Hello",
            "slug": "hello",
            "source_language": {
                "code": "en",
                "direction": "ltr",
                "name": "English",
                "url": "http://example.com/api/languages/en/",
                "web_url": "http://example.com/languages/en/"
            },
            "url": "http://example.com/api/projects/hello/",
            "web": "https://weblate.org/",
            "web_url": "http://example.com/projects/hello/"
        },
        "repo": "file:///home/nijel/work/weblate-hello",
        "slug": "weblate",
        "template": "",
        "url": "http://example.com/api/components/hello/weblate/",
        "vcs": "git",
        "web_url": "http://example.com/projects/hello/weblate/"
    },
    "failing_checks": 3,
    "failing_checks_percent": 75.0,
    "failing_checks_words": 11,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "last_author": "Weblate Admin",
    "last_change": "2016-03-07T10:20:05.499",
    "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792",
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 4,
    "translated_percent": 100.0,
    "translated_words": 15,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

DELETE /api/translations/(string: project)/(string: component)/(string: language)/¶

Nuevo en la versión 3.9.

Elimina una traducción.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

GET /api/translations/(string: project)/(string: component)/(string: language)/changes/¶

Returns a list of translation changes. This is essentially a translations-scoped GET /api/changes/ accepting the same parameters.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Response JSON Object

results (array) – array of component objects; see GET /api/changes/(int:id)/

GET /api/translations/(string: project)/(string: component)/(string: language)/units/¶

Devuelve un listado de unidades de traducción.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Response JSON Object

results (array) – array of component objects; see GET /api/units/(int:id)/

POST /api/translations/(string: project)/(string: component)/(string: language)/units/¶

Add new monolingual unit.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Request JSON Object

key (string) – Name of translation unit
value (string) – The translation unit value

POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/¶

Trigger automatic translation.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Request JSON Object

mode (string) – Modo de traducción automatizada
filter_type (string) – Automatic translation filter type
auto_source (string) – Fuente de la traducción automática
component (string) – Permita que el proyecto contribuya a la memoria de traducción compartida para obtener acceso a componentes adicionales.
engines (string) – Motores de traducción automática
threshold (string) – Umbral de puntuación

GET /api/translations/(string: project)/(string: component)/(string: language)/file/¶

Download current translation file as stored in VCS (without format parameter) or as converted to a standard format (currently supported: Gettext PO, MO, XLIFF and TBX).

Nota

This API endpoint uses different logic for output than rest of API as it operates on whole file rather than on data. Set of accepted format parameter differs and without such parameter you get translation file as stored in VCS.

Query Parameters

format – File format to use; if not specified no format conversion happens; supported file formats: po, mo, xliff, xliff11, tbx, csv, xlsx, json, aresource, strings

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

POST /api/translations/(string: project)/(string: component)/(string: language)/file/¶

Upload new file with translations.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Form Parameters

string conflicts – How to deal with conflicts (ignore, replace-translated or replace-approved)
file file – Archivo cargado
string email – Correo electrónico del autor
string author – Nombre del autor
string method – Upload method (translate, approve, suggest, fuzzy, replace, source), see Métodos de importación
string fuzzy – Fuzzy strings processing (empty, process, approve)

CURL example:

curl -X POST \
    -F file=@strings.xml \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/translations/hello/android/cs/file/

GET /api/translations/(string: project)/(string: component)/(string: language)/repository/¶

Returns information about VCS repository status.

The response is same as for GET /api/components/(string:project)/(string:component)/repository/.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

POST /api/translations/(string: project)/(string: component)/(string: language)/repository/¶

Performs given operation on the VCS repository.

See POST /api/projects/(string:project)/repository/ for documentation.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Request JSON Object

operation (string) – Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

result (boolean) – resultado de la operación

GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/¶

Devuelve estadísticas detalladas sobre la traducción.

Nuevo en la versión 2.7.

Parameters

project (string) – URL semántico del proyecto
component (string) – URL semántico del componente
language (string) – Código de idioma de la traducción

Response JSON Object

code (string) – código del idioma
failing (int) – número de comprobaciones fallidas
failing_percent (float) – porcentaje de comprobaciones fallidas
fuzzy (int) – número de cadenas que necesitan revisión
fuzzy_percent (float) – porcentaje de cadenas que necesitan revisión
total_words (int) – número total de palabras
translated_words (int) – número de palabras traducidas
last_author (string) – nombre del último autor
last_change (timestamp) – fecha del último cambio
name (string) – nombre del idioma
total (int) – número total de cadenas
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
url (string) – URL to access the translation (engagement URL)
url_translate (string) – URL to access the translation (real translation URL)

Unidades¶

Nuevo en la versión 2.10.

GET /api/units/¶: Devuelve un listado de unidades de traducción.

Ver también

Unit object attributes are documented at GET /api/units/(int:id)/.

GET /api/units/(int: id)/¶

Returns information about translation unit.

Parameters

id (int) – Identificador de unidad

Response JSON Object

translation (string) – URL de un objeto de traducción relacionado
source (string) – cadena de origen
previous_source (string) – previous source string used for fuzzy matching
target (string) – cadena de destino
id_hash (string) – identificador único de la unidad
content_hash (string) – identificador único de la cadena de origen
location (string) – ubicación de la unidad en el código fuente
context (string) – contexto de la unidad de traducción
note (string) – nota de la unidad de traducción
flags (string) – indicadores de la unidad de traducción
fuzzy (boolean) – whether the unit is fuzzy or marked for review
translated (boolean) – indica si la unidad está traducida
approved (boolean) – indica si la traducción está aprobada
position (int) – posición de la unidad en el archivo de traducción
has_suggestion (boolean) – indica si la unidad tiene sugerencias
has_comment (boolean) – indica si la unidad tiene comentarios
has_failing_check (boolean) – indica si la unidad tiene comprobaciones fallidas
num_words (int) – número de palabras de origen
priority (int) – prioridad de traducción; 100 es la predeterminada
id (int) – identificador de unidad
web_url (string) – URL para editar la unidad
souce_info (string) – Source string information link; see GET /api/units/(int:id)/

Cambios¶

Nuevo en la versión 2.10.

GET /api/changes/¶

Distinto en la versión 4.1: Filtering of changes was introduced in the 4.1 release.

Devuelve un listado de cambios a la traducción.

Ver también

Change object attributes are documented at GET /api/changes/(int:id)/.

Query Parameters

user (string) – Username of user to filters
action (int) – Action to filter, can be used several times
timestamp_after (timestamp) – ISO 8601 formatted timestamp to list changes after
timestamp_before (timestamp) – ISO 8601 formatted timestamp to list changes before

GET /api/changes/(int: id)/¶

Devuelve información relativa a un cambio de traducción.

Parameters

id (int) – Identificador de cambio

Response JSON Object

unit (string) – URL of a related unit object
translation (string) – URL de un objeto de traducción relacionado
component (string) – URL of a related component object
glossary_term (string) – URL of a related glossary term object
user (string) – URL of a related user object
author (string) – URL of a related author object
timestamp (timestamp) – cronomarcador de suceso
action (int) – identificación numérica de acción
action_name (string) – descripción de texto de acción
target (string) – event changed text or detail
id (int) – change identifier

Capturas de pantalla¶

Nuevo en la versión 2.14.

GET /api/screenshots/¶: Devuelve un listado de información de cadenas de capturas de pantalla.

Ver también

Screenshot object attributes are documented at GET /api/screenshots/(int:id)/.

GET /api/screenshots/(int: id)/¶

Devuelve información relativa a los datos de una captura de pantalla.

Parameters

id (int) – Identificador de captura de pantalla

Response JSON Object

name (string) – nombre de una captura de pantalla
component (string) – URL of a related component object
file_url (string) – URL to download a file; see GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see GET /api/units/(int:id)/

GET /api/screenshots/(int: id)/file/¶

Download the screenshot image.

Parameters

id (int) – Identificador de captura de pantalla

POST /api/screenshots/(int: id)/file/¶

Replace screenshot image.

Parameters

id (int) – Identificador de captura de pantalla

Form Parameters

file image – Archivo cargado

CURL example:

curl -X POST \
    -F image=@image.png \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/screenshots/1/file/

POST /api/screenshots/(int: id)/units/¶

Associate source string with screenshot.

Parameters

id (int) – Identificador de captura de pantalla

Form Parameters

string unit_id – Identificador de unidad

Response JSON Object

name (string) – nombre de una captura de pantalla
component (string) – URL of a related component object
file_url (string) – URL to download a file; see GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/units/(int: unit_id)¶

Remove source string association with screenshot.

Parameters

id (int) – Identificador de captura de pantalla
unit_id – Source string unit ID

POST /api/screenshots/¶

Crea una captura de pantalla nueva.

Form Parameters

file image – Archivo cargado
string name – Nombre de captura de pantalla
string project_slug – Project Slug
string component_slug – Component Slug

Response JSON Object

name (string) – nombre de una captura de pantalla
component (string) – URL of a related component object
file_url (string) – URL to download a file; see GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see GET /api/units/(int:id)/

PATCH /api/screenshots/(int: id)/¶

Edit partial information about screenshot.

Parameters

id (int) – Identificador de captura de pantalla

Response JSON Object

name (string) – nombre de una captura de pantalla
component (string) – URL of a related component object
file_url (string) – URL to download a file; see GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see GET /api/units/(int:id)/

PUT /api/screenshots/(int: id)/¶

Edit full information about screenshot.

Parameters

id (int) – Identificador de captura de pantalla

Response JSON Object

name (string) – nombre de una captura de pantalla
component (string) – URL of a related component object
file_url (string) – URL to download a file; see GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/¶

Delete screenshot.

Parameters

id (int) – Identificador de captura de pantalla

Listas de componentes¶

Nuevo en la versión 4.0.

GET /api/component-lists/¶: Devuelve un listado de listas de componentes.

Ver también

Component list object attributes are documented at GET /api/component-lists/(str:slug)/.

GET /api/component-lists/(str: slug)/¶

Devuelve información relativa a la lista de componentes.

Parameters

slug (string) – Component list slug

Response JSON Object

name (string) – name of a component list
slug (string) – slug of a component list
show_dashboard (boolean) – whether to show it on a dashboard
components (array) – link to associated components; see GET /api/components/(string:project)/(string:component)/
auto_assign (array) – automatic assignment rules

PUT /api/component-lists/(str: slug)/¶

Changes the component list parameters.

Parameters

slug (string) – Component list slug

Request JSON Object

name (string) – name of a component list
slug (string) – slug of a component list
show_dashboard (boolean) – whether to show it on a dashboard

PATCH /api/component-lists/(str: slug)/¶

Changes the component list parameters.

Parameters

slug (string) – Component list slug

Request JSON Object

name (string) – name of a component list
slug (string) – slug of a component list
show_dashboard (boolean) – whether to show it on a dashboard

DELETE /api/component-lists/(str: slug)/¶

Deletes the component list.

Parameters

slug (string) – Component list slug

POST /api/component-lists/(str: slug)/components/¶

Associate component with a component list.

Parameters

slug (string) – Component list slug

Form Parameters

string component_id – Identificador de componente

DELETE /api/component-lists/(str: slug)/components/(str: component_slug)¶

Disassociate a component from the component list.

Parameters

slug (string) – Component list slug
component_slug (string) – «Slug» del componente

Actuadores de notificaciones¶

Notification hooks allow external applications to notify Weblate that the VCS repository has been updated.

You can use repository endpoints for projects, components and translations to update individual repositories; see POST /api/projects/(string:project)/repository/ for documentation.

GET /hooks/update/(string: project)/(string: component)/¶: Obsoleto desde la versión 2.6: Please use POST /api/components/(string:project)/(string:component)/repository/ instead which works properly with authentication for ACL limited projects.

Triggers update of a component (pulling from VCS and scanning for translation changes).

GET /hooks/update/(string: project)/¶: Obsoleto desde la versión 2.6: Please use POST /api/projects/(string:project)/repository/ instead which works properly with authentication for ACL limited projects.

Triggers update of all components in a project (pulling from VCS and scanning for translation changes).

POST /hooks/github/¶

Special hook for handling GitHub notifications and automatically updating matching components.

Nota

GitHub includes direct support for notifying Weblate: enable Weblate service hook in repository settings and set the URL to the URL of your Weblate installation.

Ver también

Recibir cambios automáticamente de GitHub: For instruction on setting up GitHub integration
https://docs.github.com/en/github/extending-github/about-webhooks: Generic information about GitHub Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitlab/¶

Special hook for handling GitLab notifications and automatically updating matching components.

Ver también

Automatically receiving changes from GitLab: For instruction on setting up GitLab integration
https://docs.gitlab.com/ce/user/project/integrations/webhooks.html: Generic information about GitLab Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/bitbucket/¶

Special hook for handling Bitbucket notifications and automatically updating matching components.

Ver también

Recibir cambios automáticamente de Bitbucket: For instruction on setting up Bitbucket integration
https://confluence.atlassian.com/bitbucket/manage-webhooks-735643732.html: Generic information about Bitbucket Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/pagure/¶

Nuevo en la versión 3.3.

Special hook for handling Pagure notifications and automatically updating matching components.

Ver también

Recibir cambios automáticamente de Pagure: For instruction on setting up Pagure integration
https://docs.pagure.org/pagure/usage/using_webhooks.html: Generic information about Pagure Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/azure/¶

Nuevo en la versión 3.8.

Special hook for handling Azure Repos notifications and automatically updating matching components.

Ver también

Recibir cambios automáticamente de Azure Repos: For instruction on setting up Azure integration
https://docs.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks: Generic information about Azure Repos Web Hooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitea/¶

Nuevo en la versión 3.9.

Special hook for handling Gitea Webhook notifications and automatically updating matching components.

Ver también

Recibir cambios automáticamente de Gitea: For instruction on setting up Gitea integration
https://docs.gitea.io/en-us/webhooks/: Generic information about Gitea Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitee/¶

Nuevo en la versión 3.9.

Special hook for handling Gitee Webhook notifications and automatically updating matching components.

Ver también

Recibir cambios automáticamente de Gitee: For instruction on setting up Gitee integration
https://gitee.com/help/categories/40: Generic information about Gitee Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

Exportaciones¶

Weblate brinda diversas exportaciones para permitirle un tratamiento posterior de sus datos.

GET /exports/stats/(string: project)/(string: component)/¶

Query Parameters

format (string) – Output format: either json or csv

Obsoleto desde la versión 2.6: Please use GET /api/components/(string:project)/(string:component)/statistics/ and GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/ instead; it allows access to ACL controlled projects as well.

Retrieves statistics for given component in given format.

Ejemplo de solicitud:

GET /exports/stats/weblate/master/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Ejemplo de respuesta:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
    {
        "code": "cs",
        "failing": 0,
        "failing_percent": 0.0,
        "fuzzy": 0,
        "fuzzy_percent": 0.0,
        "last_author": "Michal \u010ciha\u0159",
        "last_change": "2012-03-28T15:07:38+00:00",
        "name": "Czech",
        "total": 436,
        "total_words": 15271,
        "translated": 436,
        "translated_percent": 100.0,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/cs/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/cs/"
    },
    {
        "code": "nl",
        "failing": 21,
        "failing_percent": 4.8,
        "fuzzy": 11,
        "fuzzy_percent": 2.5,
        "last_author": null,
        "last_change": null,
        "name": "Dutch",
        "total": 436,
        "total_words": 15271,
        "translated": 319,
        "translated_percent": 73.2,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/nl/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/nl/"
    },
    {
        "code": "el",
        "failing": 11,
        "failing_percent": 2.5,
        "fuzzy": 21,
        "fuzzy_percent": 4.8,
        "last_author": null,
        "last_change": null,
        "name": "Greek",
        "total": 436,
        "total_words": 15271,
        "translated": 312,
        "translated_percent": 71.6,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/el/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/el/"
    },
]

Sindicación RSS¶

Las modificaciones a las traducciones se exportan en suministros RSS.

GET /exports/rss/(string: project)/(string: component)/(string: language)/¶: Retrieves RSS feed with recent changes for a translation.

GET /exports/rss/(string: project)/(string: component)/¶: Retrieves RSS feed with recent changes for a component.

GET /exports/rss/(string: project)/¶: Retrieves RSS feed with recent changes for a project.

GET /exports/rss/language/(string: language)/¶: Retrieves RSS feed with recent changes for a language.

GET /exports/rss/¶: Retrieves RSS feed with recent changes for Weblate instance.

Ver también

RSS on wikipedia

Cliente de Weblate¶

Nuevo en la versión 2.7: There has been full wlc utility support ever since Weblate 2.7. If you are using an older version some incompatibilities with the API might occur.

Instalación¶

The Weblate Client is shipped separately and includes the Python module. To use the commands below, you need to install wlc:

pip3 install wlc

Primeros pasos¶

The wlc configuration is stored in ~/.config/weblate, please create it to match your environment:

[weblate]
url = https://hosted.weblate.org/api/

[keys]
https://hosted.weblate.org/api/ = APIKEY

You can then invoke commands on the default server:

wlc ls
wlc commit sandbox/hello-world

Ver también

Archivos de configuración

Synopsis¶

wlc [parameter] <command> [options]

Las órdenes indican cuál operación ha de realizarse.

Descripción¶

Weblate Client is a Python library and command-line utility to manage Weblate remotely using API. The command-line utility can be invoked as wlc and is built-in on wlc.

Opciones para todo el sitio¶

El programa acepta las opciones siguientes que afectan a una instalación completa, las cuales deben introducirse antes de cualquier suborden.

--format {csv,json,text,html}¶: Especifique el formato de la salida.

--url URL¶: Specify the API URL. Overrides any value found in the configuration file, see Archivos de configuración. The URL should end with /api/, for example https://hosted.weblate.org/api/.

--key KEY¶: Specify the API user key to use. Overrides any value found in the configuration file, see Archivos de configuración. You can find your key in your profile on Weblate.

--config PATH¶: Overrides the configuration file path, see Archivos de configuración.

--config-section SECTION¶: Overrides configuration file section in use, see Archivos de configuración.

Subórdenes¶

Las siguientes subórdenes están disponibles:

version¶: Muestra la versión actual.

list-languages¶: Enumera los idiomas utilizados en Weblate.

list-projects¶: Enumera los proyectos en Weblate.

list-components¶: Enumera los componentes en Weblate.

list-translations¶: Enumera las traducciones en Weblate.

show¶: Muestra un objeto de Weblate (traducción, componente o proyecto).

ls¶: Enumera objetos de Weblate (traducción, componente o proyecto).

commit¶: Consigna los cambios efectuados en un objeto de Weblate (traducción, componente o proyecto).

pull¶: Incorpora los cambios en el repositorio remoto en un objeto de Weblate (traducción, componente o proyecto).

push¶: Envía los cambios en el objeto de Weblate (traducción, componente o proyecto) al repositorio remoto.

reset¶: Nuevo en la versión 0.7: Admitido desde wlc 0.7.

Restablece los cambios en un objeto de Weblate (traducción, componente o proyecto) para que coincida con el repositorio remoto.

cleanup¶: Nuevo en la versión 0.9: Admitido desde wlc 0.9.

Removes any untracked changes in a Weblate object to match the remote repository (translation, component or project).

repo¶: Displays repository status for a given Weblate object (translation, component or project).

statistics¶: Displays detailed statistics for a given Weblate object (translation, component or project).

lock-status¶: Nuevo en la versión 0.5: Admitido desde wlc 0.5.

Muestra el estado de bloqueo.

lock¶: Nuevo en la versión 0.5: Admitido desde wlc 0.5.

Bloquea el componente para evitar más traducciones en Weblate.

unlock¶: Nuevo en la versión 0.5: Admitido desde wlc 0.5.

Desbloquea la traducción del componente de Weblate.

changes¶: Nuevo en la versión 0.7: Admitido desde wlc 0.7 y Weblate 2.10.

Muestra los cambios correspondientes al objeto indicado.

download¶

Nuevo en la versión 0.7: Admitido desde wlc 0.7.

Descarga un archivo de traducción.

--convert¶: Convierte el formato de archivo. Si no se especifica ningún formato, no se produce ninguna conversión en el servidor y el archivo se descarga tal cual es en el repositorio.

--output¶: Permite especificar el archivo en el que se guardará la salida; si no se define, se mostrará en la salida estándar.

upload¶

Nuevo en la versión 0.9: Admitido desde wlc 0.9.

Carga un archivo de traducción.

--overwrite¶: Sobrescribir traducciones existentes al cargar.

--input¶: Archivo del cual se lee contenido; si no se define, se lee de la entrada estándar.

Archivos de configuración¶

.weblate: Archivo de configuración por proyecto
~/.config/weblate: Archivo de configuración de usuario
/etc/xdg/weblate: Archivo de configuración para todo el sistema

El programa sigue la especificación XDG, de modo que puede ajustar la colocación de los archivos de configuración mediante las variables de entorno XDG_CONFIG_HOME o XDG_CONFIG_DIRS.

Following settings can be configured in the [weblate] section (you can customize this by --config-section):

key: Clave de API para obtener acceso a Weblate.

url: URL del servidor de la API; el valor predeterminado es http://127.0.0.1:8000/api/.

translation: Path to the default translation - component or project.

El archivo de configuración es un INI; por ejemplo:

[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/master

Además, las claves de la API se pueden almacenar en la sección [keys]:

[keys]
https://hosted.weblate.org/api/ = APIKEY

This allows you to store keys in your personal settings, while using the .weblate configuration in the VCS repository so that wlc knows which server it should talk to.

Ejemplos¶

Mostrar la versión actual del programa:

$ wlc version
version: 0.1

Enumerar todos los proyectos:

$ wlc list-projects
name: Hello
slug: hello
source_language: en
url: http://example.com/api/projects/hello/
web: https://weblate.org/
web_url: http://example.com/projects/hello/

También puede designar el proyecto en el que debe funcionar wlc:

$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/master

$ wlc show
branch: master
file_format: po
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/master/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: master
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: master
template:
url: https://hosted.weblate.org/api/components/weblate/master/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/master/

Con esta configuración es sencillo consignar los cambios pendientes del proyecto actual:

$ wlc commit

API de Python de Weblate¶

Instalación¶

The Python API is shipped separately, you need to install the Cliente de Weblate: (wlc) to have it.

pip install wlc

`wlc`¶

`WeblateException`¶

exception wlc.WeblateException¶: Base class for all exceptions.

`Weblate`¶

class wlc.Weblate(key='', url=None, config=None)¶

Parámetros

key (str) – User key
url (str) – API server URL, if not specified default is used
config (wlc.config.WeblateConfig) – Configuration object, overrides any other parameters.

Access class to the API, define API key and optionally API URL.

get(path)¶

Parámetros: path (str) – Request path
Tipo del valor devuelto: object

Performs a single API GET call.

post(path, **kwargs)¶

Parámetros: path (str) – Request path
Tipo del valor devuelto: object

Performs a single API GET call.

`wlc.config`¶

`WeblateConfig`¶

class wlc.config.WeblateConfig(section='wlc')¶

Parámetros: section (str) – Configuration section to use

Configuration file parser following XDG specification.

load(path=None)¶

Parámetros: path (str) – Path from which to load configuration.

Loads configuration from a file, if none is specified, it loads from the wlc configuration file (~/.config/wlc) placed in your XDG configuration path (/etc/xdg/wlc).

`wlc.main`¶

wlc.main.main(settings=None, stdout=None, args=None)¶

Parámetros

settings (list) – Settings to override as list of tuples
stdout (object) – stdout file object for printing output, uses sys.stdout as default
args (list) – Command-line arguments to process, uses sys.args as default

Main entry point for command-line interface.

@wlc.main.register_command(command)¶: Decorator to register Command class in main parser used by main().

`Command`¶

class wlc.main.Command(args, config, stdout=None)¶: Clase principal para invocar órdenes.

Instrucciones de configuración¶

Instalar Weblate¶

Instalar con Docker¶

With dockerized Weblate deployment you can get your personal Weblate instance up and running in seconds. All of Weblate’s dependencies are already included. PostgreSQL is set up as the default database.

Requisitos de hardware¶

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

2 GB de RAM
2 núcleos de CPU
1 GB de espacio de almacenamiento

Cuanta más memoria tenga, mejor, ya que se utiliza para el prealmacenaje en todos los niveles (sistema de archivos, base de datos y Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

Nota

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Instalación¶

The following examples assume you have a working Docker environment, with docker-compose installed. Please check the Docker documentation for instructions.

Clone el repositorio weblate-docker:

git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker
cd weblate-docker

Create a docker-compose.override.yml file with your settings. See Docker environment variables for full list of environment variables.

version: '3'
services:
  weblate:
    ports:
      - 80:8080
    environment:
      WEBLATE_EMAIL_HOST: smtp.example.com
      WEBLATE_EMAIL_HOST_USER: user
      WEBLATE_EMAIL_HOST_PASSWORD: pass
      WEBLATE_SERVER_EMAIL: weblate@example.com
      WEBLATE_DEFAULT_FROM_EMAIL: weblate@example.com
      WEBLATE_SITE_DOMAIN: weblate.example.com
      WEBLATE_ADMIN_PASSWORD: password for the admin user
      WEBLATE_ADMIN_EMAIL: weblate.admin@example.com

Nota

If WEBLATE_ADMIN_PASSWORD is not set, the admin user is created with a random password shown on first startup.

The provided example makes Weblate listen on port 80, edit the port mapping in the docker-compose-override.yml file to change it.

Inicie los contenedores de Weblate:
```
docker-compose up
```

Enjoy your Weblate deployment, it’s accessible on port 80 of the weblate container.

Distinto en la versión 2.15-2: The setup has changed recently, priorly there was separate web server container, since 2.15-2 the web server is embedded in the Weblate container.

Distinto en la versión 3.7.1-6: In July 2019 (starting with the 3.7.1-6 tag), the containers are not running as a root user. This has changed the exposed port from 80 to 8080.

Ver también

Invocar órdenes de gestión

Contenedor Docker con compatibilidad con HTTPS¶

Please see Instalación for generic deployment instructions, this section only mentions differences compared to it.

Utilizar certificados SSL propios¶

Nuevo en la versión 3.8-3.

In case you have own SSL certificate you want to use, simply place the files into the Weblate data volume (see Volúmenes de contenedores Docker):

ssl/fullchain.pem, que contiene el certificado SSL y cualquier certificado CA que se necesite
ssl/privkey.pem, que contiene la clave privada

Both of these files must be owned by the same user as the one starting the docker container and have file mask set to 600 (readable and writable only by the owning user).

Additionally, Weblate container will now accept SSL connections on port 4443, you will want to include the port forwarding for HTTPS in docker compose override:

version: '3'
services:
  weblate:
    ports:
      - 80:8080
      - 443:4443

If you already host other sites on the same server, it is likely ports 80 and 443 are used by a reverse proxy, such as NGINX. To pass the HTTPS connection from NGINX to the docker container, you can use the following configuration:

server {
    listen 443;
    listen [::]:443;

    server_name <SITE_URL>;
    ssl_certificate /etc/letsencrypt/live/<SITE>/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/<SITE>/privkey.pem;

    location / {
            proxy_set_header HOST $host;
            proxy_set_header X-Forwarded-Proto https;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Host $server_name;
            proxy_pass https://127.0.0.1:<EXPOSED_DOCKER_PORT>;
    }
}

Replace <SITE_URL>, <SITE> and <EXPOSED_DOCKER_PORT> with actual values from your environment.

Certificados SSL automáticos con Let’s Encrypt¶

In case you want to use Let’s Encrypt automatically generated SSL certificates on public installation, you need to add a reverse HTTPS proxy an additional Docker container, https-portal will be used for that. This is made use of in the docker-compose-https.yml file. Then create a docker-compose-https.override.yml file with your settings:

version: '3'
services:
  weblate:
    environment:
      WEBLATE_EMAIL_HOST: smtp.example.com
      WEBLATE_EMAIL_HOST_USER: user
      WEBLATE_EMAIL_HOST_PASSWORD: pass
      WEBLATE_SITE_DOMAIN: weblate.example.com
      WEBLATE_ADMIN_PASSWORD: password for admin user
  https-portal:
    environment:
      DOMAINS: 'weblate.example.com -> http://weblate:8080'

Whenever invoking docker-compose you need to pass both files to it, and then do:

docker-compose -f docker-compose-https.yml -f docker-compose-https.override.yml build
docker-compose -f docker-compose-https.yml -f docker-compose-https.override.yml up

Actualizar el contenedor de Docker¶

Usually it is good idea to only update the Weblate container and keep the PostgreSQL container at the version you have, as upgrading PostgreSQL is quite painful and in most cases does not bring many benefits.

You can do this by sticking with the existing docker-compose and just pull the latest images and then restart:

docker-compose stop
docker-compose pull
docker-compose up

The Weblate database should be automatically migrated on first startup, and there should be no need for additional manual actions.

Nota

Upgrades across 3.0 are not supported by Weblate. If you are on 2.x series and want to upgrade to 3.x, first upgrade to the latest 3.0.1-x (at time of writing this it is the 3.0.1-7) image, which will do the migration and then continue upgrading to newer versions.

You might also want to update the docker-compose repository, though it’s not needed in most case. Please beware of PostgreSQL version changes in this case as it’s not straightforward to upgrade the database, see GitHub issue for more info.

Admin login¶

After container setup, you can sign in as admin user with password provided in WEBLATE_ADMIN_PASSWORD, or a random password generated on first start if that was not set.

To reset admin password, restart the container with WEBLATE_ADMIN_PASSWORD set to new password.

Ver también

WEBLATE_ADMIN_PASSWORD, WEBLATE_ADMIN_NAME, WEBLATE_ADMIN_EMAIL

Docker environment variables¶

Many of Weblate’s Configuración can be set in the Docker container using environment variables:

Generic settings¶

WEBLATE_DEBUG¶

Configures Django debug mode using DEBUG.

Example:

environment:
  WEBLATE_DEBUG: 1

Ver también

Desactivar el modo de depuración.

WEBLATE_LOGLEVEL¶: Configures the logging verbosity.

WEBLATE_SITE_TITLE¶: Changes the site-title shown in the header of all pages.

WEBLATE_SITE_DOMAIN¶: Configura el dominio del sitio.

Consejo

Si no se define, se utiliza el primer elemento de WEBLATE_ALLOWED_HOSTS.

Ver también

Set correct site domain, SITE_DOMAIN

WEBLATE_ADMIN_NAME¶

WEBLATE_ADMIN_EMAIL¶

Configures the site-admin’s name and e-mail. It is used for both ADMINS setting and creating admin user (see WEBLATE_ADMIN_PASSWORD for more info on that).

Example:

environment:
  WEBLATE_ADMIN_NAME: Weblate admin
  WEBLATE_ADMIN_EMAIL: noreply@example.com

Ver también

Admin login, Properly configure admins, ADMINS

WEBLATE_ADMIN_PASSWORD¶

Sets the password for the admin user.

If not set and admin user does not exist, it is created with a random password shown on first container startup.
If not set and admin user exists, no action is performed.
If set the admin user is adjusted on every container startup to match WEBLATE_ADMIN_PASSWORD, WEBLATE_ADMIN_NAME and WEBLATE_ADMIN_EMAIL.

Advertencia

It might be a security risk to store password in the configuration file. Consider using this variable only for initial setup (or let Weblate generate random password on initial startup) or for password recovery.

Ver también

Admin login, WEBLATE_ADMIN_PASSWORD, WEBLATE_ADMIN_NAME, WEBLATE_ADMIN_EMAIL

WEBLATE_SERVER_EMAIL¶

WEBLATE_DEFAULT_FROM_EMAIL¶: Configures the address for outgoing e-mails.

Ver también

Configure e-mail sending

WEBLATE_ALLOWED_HOSTS¶

Configures allowed HTTP hostnames using ALLOWED_HOSTS.

El valor predeterminado es *, que permite todos los nombres de anfitrión.

Example:

environment:
  WEBLATE_ALLOWED_HOSTS: weblate.example.com,example.com

Ver también

ALLOWED_HOSTS, Allowed hosts setup, Set correct site domain

WEBLATE_REGISTRATION_OPEN¶

Configures whether registrations are open by toggling REGISTRATION_OPEN.

Example:

environment:
  WEBLATE_REGISTRATION_OPEN: 0

WEBLATE_REGISTRATION_ALLOW_BACKENDS¶

Configure which authentication methods can be used to create new account via REGISTRATION_ALLOW_BACKENDS.

Example:

environment:
  WEBLATE_REGISTRATION_OPEN: 0
  WEBLATE_REGISTRATION_ALLOW_BACKENDS: azuread-oauth2,azuread-tenant-oauth2

WEBLATE_TIME_ZONE¶

Configures the used time zone in Weblate, see TIME_ZONE.

Nota

To change the time zone of the Docker container itself, use the TZ environment variable.

Example:

environment:
  WEBLATE_TIME_ZONE: Europe/Prague

WEBLATE_ENABLE_HTTPS¶

Makes Weblate assume it is operated behind a reverse HTTPS proxy, it makes Weblate use HTTPS in e-mail and API links or set secure flags on cookies.

Nota

This does not make the Weblate container accept HTTPS connections, you need to configure that as well, see Contenedor Docker con compatibilidad con HTTPS for examples.

Example:

environment:
  WEBLATE_ENABLE_HTTPS: 1

Ver también

Set correct site domain

WEBLATE_IP_PROXY_HEADER¶

Lets Weblate fetch the IP address from any given HTTP header. Use this when using a reverse proxy in front of the Weblate container.

Enables IP_BEHIND_REVERSE_PROXY and sets IP_PROXY_HEADER.

Nota

The format must conform to Django’s expectations. Django transforms raw HTTP header names as follows:

converts all characters to uppercase
replaces any hyphens with underscores
prepends HTTP_ prefix

So X-Forwarded-For would be mapped to HTTP_X_FORWARDED_FOR.

Example:

environment:
  WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR

WEBLATE_SECURE_PROXY_SSL_HEADER¶

A tuple representing a HTTP header/value combination that signifies a request is secure. This is needed when Weblate is running behind a reverse proxy doing SSL termination which does not pass standard HTTPS headers.

Example:

environment:
  WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https

Ver también

SECURE_PROXY_SSL_HEADER

WEBLATE_REQUIRE_LOGIN¶

Configures login required for the whole of the Weblate installation using LOGIN_REQUIRED_URLS.

Example:

environment:
  WEBLATE_REQUIRE_LOGIN: 1

WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶

WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS¶

WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS¶

Adds URL exceptions for login required for the whole Weblate installation using LOGIN_REQUIRED_URLS_EXCEPTIONS.

You can either replace whole settings, or modify default value using ADD and REMOVE variables.

WEBLATE_GOOGLE_ANALYTICS_ID¶: Configures ID for Google Analytics by changing GOOGLE_ANALYTICS_ID.

WEBLATE_GITHUB_USERNAME¶: Configures GitHub username for GitHub pull-requests by changing GITHUB_USERNAME.

Ver también

GitHub, Setting up hub

WEBLATE_GITLAB_USERNAME¶: Configures GitLab username for GitLab merge-requests by changing GITLAB_USERNAME

Ver también

GitLab Setting up Lab

WEBLATE_GITLAB_HOST¶: Configures GitLab Host for GitLab merge-requests

Ver también

GitLab Setting up Lab

WEBLATE_GITLAB_TOKEN¶: Configures GitLab access token for GitLab merge-requests

Ver también

GitLab Setting up Lab

WEBLATE_SIMPLIFY_LANGUAGES¶: Configures the language simplification policy, see SIMPLIFY_LANGUAGES.

WEBLATE_DEFAULT_ACCESS_CONTROL¶: Configures the default Control de acceso for new projects, see DEFAULT_ACCESS_CONTROL.

WEBLATE_DEFAULT_RESTRICTED_COMPONENT¶: Configures the default value for Acceso restringido for new components, see DEFAULT_RESTRICTED_COMPONENT.

WEBLATE_DEFAULT_TRANSLATION_PROPAGATION¶: Configures the default value for Permitir propagación de traducciones for new components, see DEFAULT_TRANSLATION_PROPAGATION.

WEBLATE_AKISMET_API_KEY¶: Configures the Akismet API key, see AKISMET_API_KEY.

WEBLATE_GPG_IDENTITY¶: Configures GPG signing of commits, see WEBLATE_GPG_IDENTITY.

Ver también

Signing Git commits with GnuPG

WEBLATE_URL_PREFIX¶: Configures URL prefix where Weblate is running, see URL_PREFIX.

WEBLATE_SILENCED_SYSTEM_CHECKS¶: Configures checks which you do not want to be displayed, see SILENCED_SYSTEM_CHECKS.

WEBLATE_CSP_SCRIPT_SRC¶

WEBLATE_CSP_IMG_SRC¶

WEBLATE_CSP_CONNECT_SRC¶

WEBLATE_CSP_STYLE_SRC¶

WEBLATE_CSP_FONT_SRC¶: Allows to customize Content-Security-Policy HTTP header.

Ver también

Content security policy, CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC

Machine translation settings¶

WEBLATE_MT_AWS_REGION¶

WEBLATE_MT_AWS_ACCESS_KEY_ID¶

WEBLATE_MT_AWS_SECRET_ACCESS_KEY¶

Configures AWS machine translation.

environment:
  WEBLATE_MT_AWS_REGION: us-east-1
  WEBLATE_MT_AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
  WEBLATE_MT_AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

WEBLATE_MT_DEEPL_KEY¶: Enables DeepL machine translation and sets MT_DEEPL_KEY

WEBLATE_MT_DEEPL_API_VERSION¶: Configures DeepL API version to use, see MT_DEEPL_API_VERSION.

WEBLATE_MT_GOOGLE_KEY¶: Enables Google Translate and sets MT_GOOGLE_KEY

WEBLATE_MT_MICROSOFT_COGNITIVE_KEY¶: Enables Microsoft Cognitive Services Translator and sets MT_MICROSOFT_COGNITIVE_KEY

WEBLATE_MT_MICROSOFT_ENDPOINT_URL¶: Sets MT_MICROSOFT_ENDPOINT_URL, please note this is supposed to contain domain name only.

WEBLATE_MT_MICROSOFT_REGION¶: Sets MT_MICROSOFT_REGION

WEBLATE_MT_MICROSOFT_BASE_URL¶: Sets MT_MICROSOFT_BASE_URL

WEBLATE_MT_MODERNMT_KEY¶: Enables ModernMT and sets MT_MODERNMT_KEY.

WEBLATE_MT_MYMEMORY_ENABLED¶

Enables MyMemory machine translation and sets MT_MYMEMORY_EMAIL to WEBLATE_ADMIN_EMAIL.

Example:

environment:
  WEBLATE_MT_MYMEMORY_ENABLED: 1

WEBLATE_MT_GLOSBE_ENABLED¶

Enables Glosbe machine translation.

environment:
  WEBLATE_MT_GLOSBE_ENABLED: 1

WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED¶

Enables Microsoft Terminology Service machine translation.

environment:
  WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED: 1

WEBLATE_MT_SAP_BASE_URL¶

WEBLATE_MT_SAP_SANDBOX_APIKEY¶

WEBLATE_MT_SAP_USERNAME¶

WEBLATE_MT_SAP_PASSWORD¶

WEBLATE_MT_SAP_USE_MT¶

Configures SAP Translation Hub machine translation.

environment:
    WEBLATE_MT_SAP_BASE_URL: "https://example.hana.ondemand.com/translationhub/api/v1/"
    WEBLATE_MT_SAP_USERNAME: "user"
    WEBLATE_MT_SAP_PASSWORD: "password"
    WEBLATE_MT_SAP_USE_MT: 1

Authentication settings¶

LDAP¶

WEBLATE_AUTH_LDAP_SERVER_URI¶

WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE¶

WEBLATE_AUTH_LDAP_USER_ATTR_MAP¶

WEBLATE_AUTH_LDAP_BIND_DN¶

WEBLATE_AUTH_LDAP_BIND_PASSWORD¶

WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS¶

WEBLATE_AUTH_LDAP_USER_SEARCH¶

WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER¶

WEBLATE_AUTH_LDAP_USER_SEARCH_UNION¶

WEBLATE_AUTH_LDAP_USER_SEARCH_UNION_DELIMITER¶

LDAP authentication configuration.

Example for direct bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE: uid=%(user)s,ou=People,dc=example,dc=net
  # map weblate 'full_name' to ldap 'name' and weblate 'email' attribute to 'mail' ldap attribute.
  # another example that can be used with OpenLDAP: 'full_name:cn,email:mail'
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail

Example for search and bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com

Example for union search and bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_USER_SEARCH_UNION: ou=users,dc=example,dc=com|ou=otherusers,dc=example,dc=com

Example with search and bind against Active Directory:

environment:
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS: 0
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER: (sAMAccountName=%(user)s)

Ver también

LDAP authentication

GitHub¶

WEBLATE_SOCIAL_AUTH_GITHUB_KEY¶

WEBLATE_SOCIAL_AUTH_GITHUB_SECRET¶: Enables Autenticación por GitHub.

Bitbucket¶

WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY¶

WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET¶: Enables Autenticación por Bitbucket.

Facebook¶

WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY¶

WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET¶: Enables OAuth 2 de Facebook.

Google¶

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY¶

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET¶

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS¶

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_EMAILS¶: Enables OAuth 2 de Google.

GitLab¶

WEBLATE_SOCIAL_AUTH_GITLAB_KEY¶

WEBLATE_SOCIAL_AUTH_GITLAB_SECRET¶

WEBLATE_SOCIAL_AUTH_GITLAB_API_URL¶: Enables OAuth 2 de GitLab.

Active Directory de Azure¶

WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY¶

WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET¶: Enables Azure Active Directory authentication, see Active Directory de Microsoft Azure.

Azure Active Directory with Tenant support¶

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY¶

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET¶

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID¶: Enables Azure Active Directory authentication with Tenant support, see Active Directory de Microsoft Azure.

Keycloak¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_KEY¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_SECRET¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALGORITHM¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL¶

WEBLATE_SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL¶: Enables Keycloak authentication, see documentation.

Proveedores de Linux¶

You can enable authentication using Linux vendors authentication services by setting following variables to any value.

WEBLATE_SOCIAL_AUTH_FEDORA¶

WEBLATE_SOCIAL_AUTH_OPENSUSE¶

WEBLATE_SOCIAL_AUTH_UBUNTU¶

Slack¶

WEBLATE_SOCIAL_AUTH_SLACK_KEY¶

SOCIAL_AUTH_SLACK_SECRET¶: Enables Slack authentication, see Slack.

SAML¶

Self-signed SAML keys are automatically generated on first container startup. In case you want to use own keys, place the certificate and private key in /app/data/ssl/saml.crt and /app/data/ssl/saml.key.

WEBLATE_SAML_IDP_ENTITY_ID¶

WEBLATE_SAML_IDP_URL¶

WEBLATE_SAML_IDP_X509CERT¶: SAML Identity Provider settings, see Autenticación por SAML.

Otras configuraciones de autenticación¶

WEBLATE_NO_EMAIL_AUTH¶: Desactiva la autenticación por correo electrónico al asignársele cualquier valor.

Puesta en marcha de la base de datos PostgreSQL¶

The database is created by docker-compose.yml, so these settings affect both Weblate and PostgreSQL containers.

Ver también

Configuración de base de datos para Weblate

POSTGRES_PASSWORD¶: Contraseña de PostgreSQL.

POSTGRES_USER¶: Nombre de usuario de PostgreSQL.

POSTGRES_DATABASE¶: Nombre de base de datos de PostgreSQL.

POSTGRES_HOST¶: PostgreSQL server hostname or IP address. Defaults to database.

POSTGRES_PORT¶: PostgreSQL server port. Defaults to none (uses the default value).

POSTGRES_SSL_MODE¶: Configure how PostgreSQL handles SSL in connection to the server, for possible choices see SSL Mode Descriptions

Configuración de copia de respaldo de la base de datos¶

Ver también

Dumped data for backups

WEBLATE_DATABASE_BACKUP¶: Configures the daily database dump using DATABASE_BACKUP. Defaults to plain.

Caching server setup¶

Using Redis is strongly recommended by Weblate and you have to provide a Redis instance when running Weblate in Docker.

Ver también

Enable caching

REDIS_HOST¶: The Redis server hostname or IP address. Defaults to cache.

REDIS_PORT¶: The Redis server port. Defaults to 6379.

REDIS_DB¶: The Redis database number, defaults to 1.

REDIS_PASSWORD¶: The Redis server password, not used by default.

REDIS_TLS¶: Enables using SSL for Redis connection.

REDIS_VERIFY_SSL¶: Can be used to disable SSL certificate verification for Redis connection.

Email server setup¶

To make outgoing e-mail work, you need to provide a mail server.

Example TLS configuration:

environment:
    WEBLATE_EMAIL_HOST: smtp.example.com
    WEBLATE_EMAIL_HOST_USER: user
    WEBLATE_EMAIL_HOST_PASSWORD: pass

Example SSL configuration:

environment:
    WEBLATE_EMAIL_HOST: smtp.example.com
    WEBLATE_EMAIL_PORT: 465
    WEBLATE_EMAIL_HOST_USER: user
    WEBLATE_EMAIL_HOST_PASSWORD: pass
    WEBLATE_EMAIL_USE_TLS: 0
    WEBLATE_EMAIL_USE_SSL: 1

Ver también

Configurar el correo electrónico saliente

WEBLATE_EMAIL_HOST¶: Mail server hostname or IP address.

Ver también

WEBLATE_EMAIL_PORT, WEBLATE_EMAIL_USE_SSL, WEBLATE_EMAIL_USE_TLS, EMAIL_HOST

WEBLATE_EMAIL_PORT¶: Mail server port, defaults to 25.

Ver también

EMAIL_PORT

WEBLATE_EMAIL_HOST_USER¶: E-mail authentication user.

Ver también

EMAIL_HOST_USER

WEBLATE_EMAIL_HOST_PASSWORD¶: E-mail authentication password.

Ver también

EMAIL_HOST_PASSWORD

WEBLATE_EMAIL_USE_SSL¶: Whether to use an implicit TLS (secure) connection when talking to the SMTP server. In most e-mail documentation, this type of TLS connection is referred to as SSL. It is generally used on port 465. If you are experiencing problems, see the explicit TLS setting WEBLATE_EMAIL_USE_TLS.

Ver también

WEBLATE_EMAIL_PORT, WEBLATE_EMAIL_USE_TLS, EMAIL_USE_SSL

WEBLATE_EMAIL_USE_TLS¶: Whether to use a TLS (secure) connection when talking to the SMTP server. This is used for explicit TLS connections, generally on port 587 or 25. If you are experiencing connections that hang, see the implicit TLS setting WEBLATE_EMAIL_USE_SSL.

Ver también

WEBLATE_EMAIL_PORT, WEBLATE_EMAIL_USE_SSL, EMAIL_USE_TLS

WEBLATE_EMAIL_BACKEND¶: Configures Django back-end to use for sending e-mails.

Ver también

Configure e-mail sending, EMAIL_BACKEND

Error reporting¶

It is recommended to collect errors from the installation systematically, see Collecting error reports.

To enable support for Rollbar, set the following:

ROLLBAR_KEY¶: Your Rollbar post server access token.

ROLLBAR_ENVIRONMENT¶: Your Rollbar environment, defaults to production.

To enable support for Sentry, set following:

SENTRY_DSN¶: Your Sentry DSN.

SENTRY_ENVIRONMENT¶: Your Sentry Environment (optional).

Localization CDN¶

WEBLATE_LOCALIZE_CDN_URL¶

WEBLATE_LOCALIZE_CDN_PATH¶

Nuevo en la versión 4.2.1.

Configuration for CDN de regionalización de JavaScript.

The WEBLATE_LOCALIZE_CDN_PATH is path within the container. It should be stored on the persistent volume and not in the transient storage.

One of possibilities is storing that inside the Weblate data dir:

environment:
  WEBLATE_LOCALIZE_CDN_URL: https://cdn.example.com/
  WEBLATE_LOCALIZE_CDN_PATH: /app/data/l10n-cdn

Nota

You are responsible for seting up serving of the files generated by Weblate, it only does stores the files in configured location.

Ver también

Translating HTML and JavaScript using Weblate CDN, LOCALIZE_CDN_URL, LOCALIZE_CDN_PATH

Changing enabled apps, checks, addons or autofixes¶

Nuevo en la versión 3.8-5.

The built-in configuration of enabled checks, addons or autofixes can be adjusted by the following variables:

WEBLATE_ADD_APPS¶

WEBLATE_REMOVE_APPS¶

WEBLATE_ADD_CHECK¶

WEBLATE_REMOVE_CHECK¶

WEBLATE_ADD_AUTOFIX¶

WEBLATE_REMOVE_AUTOFIX¶

WEBLATE_ADD_ADDONS¶

WEBLATE_REMOVE_ADDONS¶

Example:

environment:
  WEBLATE_REMOVE_AUTOFIX: weblate.trans.autofixes.whitespace.SameBookendingWhitespace
  WEBLATE_ADD_ADDONS: customize.addons.MyAddon,customize.addons.OtherAddon

Ver también

CHECK_LIST, AUTOFIX_LIST, WEBLATE_ADDONS, INSTALLED_APPS

Configuración de contenedor¶

CELERY_MAIN_OPTIONS¶

CELERY_NOTIFY_OPTIONS¶

CELERY_TRANSLATE_OPTIONS¶

CELERY_MEMORY_OPTIONS¶

CELERY_BACKUP_OPTIONS¶

CELERY_BEAT_OPTIONS¶

These variables allow you to adjust Celery worker options. It can be useful to adjust concurrency (--concurrency 16) or use different pool implementation (--pool=gevent).

By default, the number of concurrent workers matches the number of processors (except the backup worker, which is supposed to run only once).

Example:

environment:
  CELERY_MAIN_OPTIONS: --concurrency 16

Ver también

Celery worker options, Tareas en segundo plano con Celery

UWSGI_WORKERS¶

Configure how many uWSGI workers should be executed.

It defaults to number of processors + 1.

Example:

environment:
  UWSGI_WORKERS: 32

Volúmenes de contenedores Docker¶

There is single data volume exported by the Weblate container. The other service containers (PostgreSQL or Redis) have their data volumes as well, but those are not covered by this document.

The data volume is used to store Weblate persistent data such as cloned repositories or to customize Weblate installation.

The placement of the Docker volume on host system depends on your Docker configuration, but usually it is stored in /var/lib/docker/volumes/weblate-docker_weblate-data/_data/. In the container it is mounted as /app/data.

Ver también

Docker volumes documentation

Further configuration customization¶

You can further customize Weblate installation in the data volume, see Volúmenes de contenedores Docker.

Archivos de configuración personalizados¶

You can additionally override the configuration in /app/data/settings-override.py (see Volúmenes de contenedores Docker). This is executed after all environment settings are loaded, so it gets completely set up, and can be used to customize anything.

Replacing logo and other static files¶

Nuevo en la versión 3.8-5.

The static files coming with Weblate can be overridden by placing into /app/data/python/customize/static (see Volúmenes de contenedores Docker). For example creating /app/data/python/customize/static/favicon.ico will replace the favicon.

Consejo

The files are copied to the corresponding location upon container startup, so a restart of Weblate is needed after changing the content of the volume.

Alternatively you can also include own module (see Personalizar Weblate) and add it as separate volume to the Docker container, for example:

weblate:
  volumes:
    - weblate-data:/app/data
    - ./weblate_customization/weblate_customization:/app/data/python/weblate_customization
  environment:
    WEBLATE_ADD_APPS: weblate_customization

Adding own Python modules¶

Nuevo en la versión 3.8-5.

You can place own Python modules in /app/data/python/ (see Volúmenes de contenedores Docker) and they can be then loaded by Weblate, most likely by using Archivos de configuración personalizados.

Ver también

Personalizar Weblate

Hub setup¶

In order to use the GitHub’s pull-request feature, you must initialize your hub configuration by entering the Weblate container and executing an arbitrary Hub command. For example:

docker-compose exec --user weblate weblate bash
cd
HOME=/app/data/home hub clone octocat/Spoon-Knife

The username passed for credentials must be the same as GITHUB_USERNAME.

Ver también

GitHub, Setting up hub

Lab setup¶

In order to use GitLab’s merge-request feature, you must initialize the lab configuration by entering the Weblate container and executing the lab command. For example:

docker-compose exec --user weblate weblate bash
cd
HOME=/app/data/home lab

You can also use environment variables to configure lab on each container start. Just add WEBLATE_GITLAB_USERNAME, WEBLATE_GITLAB_HOST``and ``WEBLATE_GITLAB_TOKEN to your env configuration.

weblate:
  environment:
    WEBLATE_GITLAB_USERNAME: translations_bot
    WEBLATE_GITLAB_HOST: https://gitlab.example.com
    WEBLATE_GITLAB_TOKEN: personal_access_token_of_translations_bot

The access_token passed for lab configuration must be same as GITLAB_USERNAME.

Ver también

GitLab Setting up Lab

Select your machine - local or cloud providers¶

With Docker Machine you can create your Weblate deployment either on your local machine, or on any large number of cloud-based deployments on e.g. Amazon AWS, Greenhost, and many other providers.

Instalar en Debian y Ubuntu¶

Requisitos de hardware¶

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

2 GB de RAM
2 núcleos de CPU
1 GB de espacio de almacenamiento

Cuanta más memoria tenga, mejor, ya que se utiliza para el prealmacenaje en todos los niveles (sistema de archivos, base de datos y Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

Nota

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Instalación¶

Requisitos del sistema¶

Install the dependencies needed to build the Python modules (see Requisitos de software):

apt install \
   libxml2-dev libxslt-dev libfreetype6-dev libjpeg-dev libz-dev libyaml-dev \
   libcairo-dev gir1.2-pango-1.0 libgirepository1.0-dev libacl1-dev libssl-dev \
   build-essential python3-gdbm python3-dev python3-pip python3-virtualenv virtualenv git

Instale las dependencias opcionales que desee en función de las funcionalidades que vaya a utilizar (vea Dependencias opcionales):

apt install tesseract-ocr libtesseract-dev libleptonica-dev

Optionally install software for running production server, see Running server, Configuración de base de datos para Weblate, Tareas en segundo plano con Celery. Depending on size of your installation you might want to run these components on dedicated servers.

Las instrucciones de instalación local:

# Web server option 1: NGINX and uWSGI
apt install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
apt install apache2 libapache2-mod-wsgi

# Caching backend: Redis
apt install redis-server

# Database server: PostgreSQL
apt install postgresql postgresql-contrib

# SMTP server
apt install exim4

Módulos de Python¶

Consejo

We’re using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

Create the virtualenv for Weblate:

virtualenv --python=python3 ~/weblate-env

Activate the virtualenv for Weblate:
```
. ~/weblate-env/bin/activate
```
Install Weblate including all dependencies:
```
pip install Weblate
```
Instale el controlador de la base de datos:
```
pip install psycopg2-binary
```
Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Dependencias opcionales):
```
pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
```

Configurar Weblate¶

Nota

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py
Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.
Create the database and its structure for Weblate (the example settings use PostgreSQL, check Configuración de base de datos para Weblate for production ready setup):
```
weblate migrate
```
Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:
```
weblate createadmin
```
Collect static files for web server (see Running server and Serving static files):
```
weblate collectstatic
```
Compress JavaScript and CSS files (optional, see Compressing client assets):
```
weblate compress
```
Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Tareas en segundo plano con Celery for more info:
```
~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
```
Start the development server (see Running server for production setup):
```
weblate runserver
```

After installation¶

Congratulations, your Weblate server is now running and you can start using it.

You can now access Weblate on http://localhost:8000/.
Login with admin credentials obtained during installation or register with new users.
You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Órdenes de gestión.
You can stop the test server with Ctrl+C.

Adding translation¶

Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Configuración de proyectos for more details.

All you need to specify here is the project name and its website.
Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Configuración de componentes for more details.

The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Formatos de archivo admitidos for more details.
Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Instalar en SUSE y openSUSE¶

Requisitos de hardware¶

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

2 GB de RAM
2 núcleos de CPU
1 GB de espacio de almacenamiento

Cuanta más memoria tenga, mejor, ya que se utiliza para el prealmacenaje en todos los niveles (sistema de archivos, base de datos y Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

Nota

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Instalación¶

Requisitos del sistema¶

Install the dependencies needed to build the Python modules (see Requisitos de software):

zypper install \
   libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel \
   cairo-devel typelib-1_0-Pango-1_0 gobject-introspection-devel libacl-devel \
   python3-pip python3-virtualenv python3-devel git

Instale las dependencias opcionales que desee en función de las funcionalidades que vaya a utilizar (vea Dependencias opcionales):

zypper install tesseract-ocr tesseract-devel leptonica-devel

Las instrucciones de instalación local:

# Web server option 1: NGINX and uWSGI
zypper install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
zypper install apache2 apache2-mod_wsgi

# Caching backend: Redis
zypper install redis-server

# Database server: PostgreSQL
zypper install postgresql postgresql-contrib

# SMTP server
zypper install postfix

Módulos de Python¶

Consejo

We’re using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

Create the virtualenv for Weblate:

virtualenv --python=python3 ~/weblate-env

Activate the virtualenv for Weblate:
```
. ~/weblate-env/bin/activate
```
Install Weblate including all dependencies:
```
pip install Weblate
```
Instale el controlador de la base de datos:
```
pip install psycopg2-binary
```
Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Dependencias opcionales):
```
pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
```

Configurar Weblate¶

Nota

Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py
Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.
Create the database and its structure for Weblate (the example settings use PostgreSQL, check Configuración de base de datos para Weblate for production ready setup):
```
weblate migrate
```
Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:
```
weblate createadmin
```
Collect static files for web server (see Running server and Serving static files):
```
weblate collectstatic
```
Compress JavaScript and CSS files (optional, see Compressing client assets):
```
weblate compress
```
Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Tareas en segundo plano con Celery for more info:
```
~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
```
Start the development server (see Running server for production setup):
```
weblate runserver
```

After installation¶

Congratulations, your Weblate server is now running and you can start using it.

You can now access Weblate on http://localhost:8000/.
Login with admin credentials obtained during installation or register with new users.
You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Órdenes de gestión.
You can stop the test server with Ctrl+C.

Adding translation¶

Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Configuración de proyectos for more details.

All you need to specify here is the project name and its website.
Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Configuración de componentes for more details.

The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Formatos de archivo admitidos for more details.
Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Instalar en Red Hat, Fedora y CentOS¶

Requisitos de hardware¶

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

2 GB de RAM
2 núcleos de CPU
1 GB de espacio de almacenamiento

Cuanta más memoria tenga, mejor, ya que se utiliza para el prealmacenaje en todos los niveles (sistema de archivos, base de datos y Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

Nota

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Instalación¶

Requisitos del sistema¶

Install the dependencies needed to build the Python modules (see Requisitos de software):

dnf install \
   libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel \
   cairo-devel pango-devel gobject-introspection-devel libacl-devel \
   python3-pip python3-virtualenv python3-devel git

Instale las dependencias opcionales que desee en función de las funcionalidades que vaya a utilizar (vea Dependencias opcionales):

dnf install tesseract-langpack-eng tesseract-devel leptonica-devel

Las instrucciones de instalación local:

# Web server option 1: NGINX and uWSGI
dnf install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
dnf install apache2 apache2-mod_wsgi

# Caching backend: Redis
dnf install redis

# Database server: PostgreSQL
dnf install postgresql postgresql-contrib

# SMTP server
dnf install postfix

Módulos de Python¶

Consejo

We’re using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

Create the virtualenv for Weblate:

virtualenv --python=python3 ~/weblate-env

Activate the virtualenv for Weblate:
```
. ~/weblate-env/bin/activate
```
Install Weblate including all dependencies:
```
pip install Weblate
```
Instale el controlador de la base de datos:
```
pip install psycopg2-binary
```
Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Dependencias opcionales):
```
pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
```

Configurar Weblate¶

Nota

Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py
Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.
Create the database and its structure for Weblate (the example settings use PostgreSQL, check Configuración de base de datos para Weblate for production ready setup):
```
weblate migrate
```
Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:
```
weblate createadmin
```
Collect static files for web server (see Running server and Serving static files):
```
weblate collectstatic
```
Compress JavaScript and CSS files (optional, see Compressing client assets):
```
weblate compress
```
Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Tareas en segundo plano con Celery for more info:
```
~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
```
Start the development server (see Running server for production setup):
```
weblate runserver
```

After installation¶

Congratulations, your Weblate server is now running and you can start using it.

You can now access Weblate on http://localhost:8000/.
Login with admin credentials obtained during installation or register with new users.
You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Órdenes de gestión.
You can stop the test server with Ctrl+C.

Adding translation¶

Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Configuración de proyectos for more details.

All you need to specify here is the project name and its website.
Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Configuración de componentes for more details.

The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Formatos de archivo admitidos for more details.
Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Instalar en macOS¶

Requisitos de hardware¶

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

2 GB de RAM
2 núcleos de CPU
1 GB de espacio de almacenamiento

Cuanta más memoria tenga, mejor, ya que se utiliza para el prealmacenaje en todos los niveles (sistema de archivos, base de datos y Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

Nota

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

Instalación¶

Requisitos del sistema¶

Install the dependencies needed to build the Python modules (see Requisitos de software):

brew install pango libjpeg python git libyaml gobject-introspection
pip3 install virtualenv

Make sure pip will be able to find the libffi version provided by homebrew — this will be needed during the installation build step.

export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"

Instale las dependencias opcionales que desee en función de las funcionalidades que vaya a utilizar (vea Dependencias opcionales):

brew install tesseract

Las instrucciones de instalación local:

# Web server option 1: NGINX and uWSGI
brew install nginx uwsgi

# Web server option 2: Apache with ``mod_wsgi``
brew install httpd

# Caching backend: Redis
brew install redis

# Database server: PostgreSQL
brew install postgresql

Módulos de Python¶

Consejo

We’re using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

Create the virtualenv for Weblate:

virtualenv --python=python3 ~/weblate-env

Activate the virtualenv for Weblate:
```
. ~/weblate-env/bin/activate
```
Install Weblate including all dependencies:
```
pip install Weblate
```
Instale el controlador de la base de datos:
```
pip install psycopg2-binary
```
Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Dependencias opcionales):
```
pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
```

Configurar Weblate¶

Nota

Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py
Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.
Create the database and its structure for Weblate (the example settings use PostgreSQL, check Configuración de base de datos para Weblate for production ready setup):
```
weblate migrate
```
Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:
```
weblate createadmin
```
Collect static files for web server (see Running server and Serving static files):
```
weblate collectstatic
```
Compress JavaScript and CSS files (optional, see Compressing client assets):
```
weblate compress
```
Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Tareas en segundo plano con Celery for more info:
```
~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
```
Start the development server (see Running server for production setup):
```
weblate runserver
```

After installation¶

Congratulations, your Weblate server is now running and you can start using it.

You can now access Weblate on http://localhost:8000/.
Login with admin credentials obtained during installation or register with new users.
You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Órdenes de gestión.
You can stop the test server with Ctrl+C.

Adding translation¶

Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Configuración de proyectos for more details.

All you need to specify here is the project name and its website.
Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Configuración de componentes for more details.

The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Formatos de archivo admitidos for more details.
Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Installing from sources¶

Please follow the installation instructions for your system first:
Grab the latest Weblate sources using Git (or download a tarball and unpack that):
```
git clone https://github.com/WeblateOrg/weblate.git weblate-src
```
Alternatively you can use released archives. You can download them from our website <https://weblate.org/>. Those downloads are cryptographically signed, please see Comprobar las firmas de versión.

Install current Weblate code into the virtualenv:

. ~/weblate-env/bin/activate
pip install -e weblate-src

Copy weblate/settings_example.py to weblate/settings.py.
Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.
Create the database used by Weblate, see Configuración de base de datos para Weblate.
Build Django tables, static files and initial data (see Filling up the database and Serving static files):
```
weblate migrate
weblate collectstatic
weblate compress
weblate compilemessages
```
Nota

Este paso debe repetirse siempre que actualice el repositorio.

Instalar en OpenShift¶

Nota

This guide is looking for contributors experienced with OpenShift, see <https://github.com/WeblateOrg/weblate/issues/2889>.

Weblate supports OpenShift, the needed integration files are in main repository in the openshift3 directory.

En función de la preparación y su experiencia, elija un método de instalación apropiado para usted:

Instalar con Docker, recommended for production setups.
Virtualenv installation, recommended for production setups:
Installing from sources, recommended for development.
Instalar en OpenShift.

Requisitos de software¶

Sistema operativo¶

Se sabe que Weblate funciona en Linux, FreeBSD y macOS. Es posible que funcione también en otros sistemas similares a Unix.

Weblate no es compatible con Windows. Aun así, es posible hacerlo funcionar; aceptaremos parches para este fin.

Otros servicios¶

Weblate utiliza otros servicios para su funcionamiento. Habrá de ejecutar al menos los siguientes:

PostgreSQL database server, see Configuración de base de datos para Weblate.
Redis server for cache and tasks queue, see Tareas en segundo plano con Celery.
SMTP server for outgoing e-mail, see Configurar el correo electrónico saliente.

Dependencias de Python¶

Weblate is written in Python and supports Python 3.6 or newer. You can install dependencies using pip or from your distribution packages, full list is available in requirements.txt.

Dependencias más notables:

Django: https://www.djangoproject.com/
Celery: https://docs.celeryproject.org/
Translate Toolkit: https://toolkit.translatehouse.org/
translation-finder: https://github.com/WeblateOrg/translation-finder
Python Social Auth: https://python-social-auth.readthedocs.io/
Marco REST de Django: https://www.django-rest-framework.org/

Dependencias opcionales¶

Los módulos siguientes son necesarios para algunas funcionalidades de Weblate: Los encontrará todos en requirements-optional.txt.

Mercurial (opcional para admitir repositorios Mercurial): https://www.mercurial-scm.org/
phply (opcional para admitir PHP): https://github.com/viraptor/phply
tesserocr (opcional para el OCR de capturas de pantalla): https://github.com/sirfz/tesserocr
akismet (opcional para evitar spam en las sugerencias): https://github.com/ubernostrum/akismet
ruamel.yaml (opcional para YAML files): https://pypi.org/project/ruamel.yaml/
Zeep (opcional para Microsoft Terminology Service): https://docs.python-zeep.org/
aeidon (opcional para Archivos de subtítulos): https://pypi.org/project/aeidon/

Dependencias del motor de la base de datos¶

Weblate supports PostgreSQL, MySQL and MariaDB, see Configuración de base de datos para Weblate and backends documentation for more details.

Otros requisitos de sistema¶

Deben instalarse las dependencias siguientes en el sistema:

Git: https://git-scm.com/
Pango, Cairo and related header files and gir introspection data: https://cairographics.org/, https://pango.gnome.org/, see Pango y Cairo
hub (opcional para enviar solicitudes de incorporación a GitHub): https://hub.github.com/
git-review (opcional para admitir Gerrit): https://pypi.org/project/git-review/
git-svn (opcional para admitir Subversion): https://git-scm.com/docs/git-svn
tesseract y sus datos (opcional para el reconocimiento óptico de caracteres en capturas de pantalla): https://github.com/tesseract-ocr/tesseract

Dependencias de tiempo de compilación¶

To compile some of the Dependencias de Python you might need to install their dependencies. This depends on how you install them, so please consult individual packages for documentation. You won’t need those if using prebuilt Wheels while installing using pip or when you use distribution packages.

Pango y Cairo¶

Distinto en la versión 3.7.

Weblate uses Pango and Cairo for rendering bitmap widgets (see Promoting the translation) and rendering checks (see Managing fonts). To properly install Python bindings for those you need to install system libraries first - you need both Cairo and Pango, which in turn need Glib. All those should be installed with development files and GObject introspection data.

Comprobar las firmas de versión¶

Weblate release are cryptographically signed by the releasing developer. Currently this is Michal Čihař. Fingerprint of his PGP key is:

63CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D

and you can get more identification information from <https://keybase.io/nijel>.

Debería verificar que coincida la firma con el archivador que ha descargado. Así, podrá tener la certeza de que está utilizando el mismo código que fue publicado. Además, compruebe la fecha de la firma para asegurarse de que ha descargado la versión más reciente.

Todos los archivadores incluyen un archivo .asc, que contiene la firma PGP correspondiente. Coloque el archivador y el archivo de firma en la misma carpeta para verificarlos:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Ne 3. března 2019, 16:43:15 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Can't check signature: public key not found

Como podrá darse cuenta, GPG responde que no se conoce la clave pública. Efectúe uno de los procedimientos siguientes:

Utilice wkd para descargar la clave:

$ gpg --auto-key-locate wkd --locate-keys michal@cihar.com
pub   rsa4096 2009-06-17 [SC]
      63CB1DF1EF12CF2AC0EE5A329C27B31342B7511D
uid           [ultimate] Michal Čihař <michal@cihar.com>
uid           [ultimate] Michal Čihař <nijel@debian.org>
uid           [ultimate] [jpeg image of size 8848]
uid           [ultimate] Michal Čihař (Braiins) <michal.cihar@braiins.cz>
sub   rsa4096 2009-06-17 [E]
sub   rsa4096 2015-09-09 [S]

Descargue el llavero del servidor de Michal y, a continuación, impórtelo con:

$ gpg --import wmxth3chu9jfxdxywj1skpmhsj311mzm

Descargue e importe la clave de uno de los servidores de claves:

$ gpg --keyserver hkp://pgp.mit.edu --recv-keys 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: key 9C27B31342B7511D: "Michal Čihař <michal@cihar.com>" imported
gpg: Total number processed: 1
gpg:              unchanged: 1

This will improve the situation a bit - at this point you can verify that the signature from the given key is correct but you still can not trust the name used in the key:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Ne 3. března 2019, 16:43:15 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Good signature from "Michal Čihař <michal@cihar.com>" [ultimate]
gpg:                 aka "Michal Čihař <nijel@debian.org>" [ultimate]
gpg:                 aka "[jpeg image of size 8848]" [ultimate]
gpg:                 aka "Michal Čihař (Braiins) <michal.cihar@braiins.cz>" [ultimate]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 63CB 1DF1 EF12 CF2A C0EE  5A32 9C27 B313 42B7 511D

The problem here is that anybody could issue the key with this name. You need to ensure that the key is actually owned by the mentioned person. The GNU Privacy Handbook covers this topic in the chapter Validating other keys on your public keyring. The most reliable method is to meet the developer in person and exchange key fingerprints, however you can also rely on the web of trust. This way you can trust the key transitively though signatures of others, who have met the developer in person.

Cuando la clave sea de fiar, el aviso dejará de emitirse:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Sun Mar  3 16:43:15 2019 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Good signature from "Michal Čihař <michal@cihar.com>" [ultimate]
gpg:                 aka "Michal Čihař <nijel@debian.org>" [ultimate]
gpg:                 aka "[jpeg image of size 8848]" [ultimate]
gpg:                 aka "Michal Čihař (Braiins) <michal.cihar@braiins.cz>" [ultimate]

Should the signature be invalid (the archive has been changed), you would get a clear error regardless of the fact that the key is trusted or not:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: Signature made Sun Mar  3 16:43:15 2019 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: BAD signature from "Michal Čihař <michal@cihar.com>" [ultimate]

Permisos del sistema de archivos¶

The Weblate process needs to be able to read and write to the directory where it keeps data - DATA_DIR. All files within this directory should be owned and writable by the user running Weblate.

The default configuration places them in the same tree as the Weblate sources, however you might prefer to move these to a better location such as: /var/lib/weblate.

Weblate tries to create these directories automatically, but it will fail when it does not have permissions to do so.

You should also take care when running Órdenes de gestión, as they should be ran under the same user as Weblate itself is running, otherwise permissions on some files might be wrong.

Ver también

Serving static files

Configuración de base de datos para Weblate¶

Es recomendable ejecutar Weblate con un servidor de bases de datos PostgreSQL.

Ver también

Use a powerful database engine, Databases, Migrating from other databases to PostgreSQL

PostgreSQL¶

PostgreSQL is usually the best choice for Django based sites. It’s the reference database used for implementing Django database layer.

Nota

Weblate uses trigram extension which has to be installed separately in some cases. Look for postgresql-contrib or a similarly named package.

Ver también

PostgreSQL notes

Crear una base de datos en PostgreSQL¶

Suele ser una buena idea ejecutar Weblate en su propia base de datos, en una cuenta de usuario separada:

# If PostgreSQL was not installed before, set the main password
sudo -u postgres psql postgres -c "\password postgres"

# Create a database user called "weblate"
sudo -u postgres createuser --superuser --pwprompt weblate

# Create the database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

Consejo

If you don’t want to make the Weblate user a superuser in PostgreSQL, you can omit that. In that case you will have to perform some of the migration steps manually as a PostgreSQL superuser in schema Weblate will use:

CREATE EXTENSION IF NOT EXISTS pg_trgm WITH SCHEMA weblate;

Configurar Weblate para que utilice PostgreSQL¶

The settings.py snippet for PostgreSQL:

DATABASES = {
    'default': {
        # Database engine
        'ENGINE': 'django.db.backends.postgresql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
    }
}

MySQL y MariaDB¶

Weblate can be also used with MySQL or MariaDB, please see MySQL notes and MariaDB notes for caveats using Django with those.

Consejo

Some Weblate features will perform better with PostgreSQL. This includes searching and translation memory, which both utilize full-text features in the database and PostgreSQL implementation is superior.

Because of this it is recommended to use PostgreSQL for new installations.

Se recomienda la configuración siguiente para Weblate:

Use the utf8mb4 charset to allow representation of higher Unicode planes (for example emojis).
Configure the server with Innodb_large_prefix to allow longer indices on text fields.
Set the isolation level to READ COMMITTED.
The SQL mode should be set to STRICT_TRANS_TABLES.

Otras configuraciones¶

Configurar el correo electrónico saliente¶

Weblate sends out e-mails on various occasions - for account activation and on various notifications configured by users. For this it needs access to an SMTP server.

The mail server setup is configured using these settings: EMAIL_HOST, EMAIL_HOST_PASSWORD, EMAIL_HOST_USER and EMAIL_PORT. Their names are quite self-explanatory, but you can find more info in the Django documentation.

Nota

You can verify whether outgoing e-mail is working correctly by using the sendtestemail management command (see Invocar órdenes de gestión for instructions on how to invoke it in different environments).

Running behind reverse proxy¶

Several features in Weblate rely on being able to get client IP address. This includes Rate limiting, Spam protection or Registro de auditoría.

In default configuration Weblate parses IP address from REMOTE_ADDR which is set by the WSGI handler.

In case you are running a reverse proxy, this field will most likely contain its address. You need to configure Weblate to trust additional HTTP headers and parse the IP address from these. This can not be enabled by default as it would allow IP address spoofing for installations not using a reverse proxy. Enabling IP_BEHIND_REVERSE_PROXY might be enough for the most usual setups, but you might need to adjust IP_PROXY_HEADER and IP_PROXY_OFFSET as well.

Ver también

Spam protection, Rate limiting, Registro de auditoría, IP_BEHIND_REVERSE_PROXY, IP_PROXY_HEADER, IP_PROXY_OFFSET, SECURE_PROXY_SSL_HEADER

HTTP proxy¶

Weblate does execute VCS commands and those accept proxy configuration from environment. The recommended approach is to define proxy settings in settings.py:

import os
os.environ['http_proxy'] = "http://proxy.example.com:8080"
os.environ['HTTPS_PROXY'] = "http://proxy.example.com:8080"

Ver también

Proxy Environment Variables

Adjusting configuration¶

Ver también

Configuración de muestra

Copy weblate/settings_example.py to weblate/settings.py and adjust it to match your setup. You will probably want to adjust the following options:

ADMINS

List of site administrators to receive notifications when something goes wrong, for example notifications on failed merges, or Django errors.

Ver también

ADMINS

ALLOWED_HOSTS

You need to set this to list the hosts your site is supposed to serve. For example:
ALLOWED_HOSTS = ['demo.weblate.org']
Alternatively you can include wildcard:
ALLOWED_HOSTS = ['*']
Ver también

ALLOWED_HOSTS, WEBLATE_ALLOWED_HOSTS, Allowed hosts setup

SESSION_ENGINE

Configure how your sessions will be stored. In case you keep the default database backend engine, you should schedule: weblate clearsessions to remove stale session data from the database.

If you are using Redis as cache (see Enable caching) it is recommended to use it for sessions as well:
SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
Ver también

Configuring the session engine, SESSION_ENGINE

DATABASES

Connectivity to database server, please check Django’s documentation for more details.

Ver también

Configuración de base de datos para Weblate, DATABASES, Databases

DEBUG

Disable this for any production server. With debug mode enabled, Django will show backtraces in case of error to users, when you disable it, errors will be sent per e-mail to ADMINS (see above).

Debug mode also slows down Weblate, as Django stores much more info internally in this case.

Ver también

DEBUG

DEFAULT_FROM_EMAIL

E-mail sender address for outgoing e-mail, for example registration e-mails.

Ver también

DEFAULT_FROM_EMAIL

SECRET_KEY

Key used by Django to sign some info in cookies, see Django secret key for more info.

Ver también

SECRET_KEY

SERVER_EMAIL

E-mail used as sender address for sending e-mails to the administrator, for example notifications on failed merges.

Ver también

SERVER_EMAIL

Filling up the database¶

After your configuration is ready, you can run weblate migrate to create the database structure. Now you should be able to create translation projects using the admin interface.

In case you want to run an installation non interactively, you can use weblate migrate --noinput, and then create an admin user using createadmin command.

Once you are done, you should also check the Performance report in the admin interface, which will give you hints of potential non optimal configuration on your site.

Ver también

Configuración, Control de acceso

Production setup¶

For a production setup you should carry out adjustments described in the following sections. The most critical settings will trigger a warning, which is indicated by an exclamation mark in the top bar if signed in as a superuser:

It is also recommended to inspect checks triggered by Django (though you might not need to fix all of them):

weblate check --deploy

Ver también

Deployment checklist

Desactivar el modo de depuración¶

Ejecute esto para desactivar el modo de depuración (DEBUG) de Django:

DEBUG = False

Con el modo de depuración activado, Django almacena todas las consultas ejecutadas y muestra a los usuarios el seguimiento regresivo de los errores, lo cual no es deseable en un entorno de producción.

Ver también

Adjusting configuration

Properly configure admins¶

Set the correct admin addresses to the ADMINS setting to defining who will receive e-mails in case something goes wrong on the server, for example:

ADMINS = (
    ('Your Name', 'your_email@example.com'),
)

Ver también

Adjusting configuration

Set correct site domain¶

Adjust site name and domain in the admin interface, otherwise links in RSS or registration e-mails will not work. This is configured using SITE_DOMAIN which should contain site domain name.

Distinto en la versión 4.2: Prior to the 4.2 release the Django sites framework was used instead, please see The “sites” framework.

Ver también

Allowed hosts setup, Correctly configure HTTPS SITE_DOMAIN, WEBLATE_SITE_DOMAIN, ENABLE_HTTPS

Correctly configure HTTPS¶

It is strongly recommended to run Weblate using the encrypted HTTPS protocol. After enabling it, you should set ENABLE_HTTPS in the settings:

ENABLE_HTTPS = True

Consejo

You might want to set up HSTS as well, see SSL/HTTPS for more details.

Ver también

ENABLE_HTTPS, Allowed hosts setup, Set correct site domain

Set properly SECURE_HSTS_SECONDS¶

If your site is served over SSL, you have to consider setting a value for SECURE_HSTS_SECONDS in the settings.py to enable HTTP Strict Transport Security. By default it’s set to 0 as shown below.

SECURE_HSTS_SECONDS = 0

If set to a non-zero integer value, the django.middleware.security.SecurityMiddleware sets the HTTP Strict Transport Security header on all responses that do not already have it.

Advertencia

Setting this incorrectly can irreversibly (for some time) break your site. Read the HTTP Strict Transport Security documentation first.

Use a powerful database engine¶

Please use PostgreSQL for a production environment, see Configuración de base de datos para Weblate for more info.

Ver también

Configuración de base de datos para Weblate, Migrating from other databases to PostgreSQL, Adjusting configuration, Databases

Enable caching¶

If possible, use Redis from Django by adjusting the CACHES configuration variable, for example:

CACHES = {
    'default': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': 'redis://127.0.0.1:6379/0',
        # If redis is running on same host as Weblate, you might
        # want to use unix sockets instead:
        # 'LOCATION': 'unix:///var/run/redis/redis.sock?db=0',
        'OPTIONS': {
            'CLIENT_CLASS': 'django_redis.client.DefaultClient',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
        }
    }
}

Ver también

Caché de avatars, Django’s cache framework

Caché de avatars¶

In addition to caching of Django, Weblate performs caching of avatars. It is recommended to use a separate, file-backed cache for this purpose:

CACHES = {
    'default': {
        # Default caching backend setup, see above
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': 'unix:///var/run/redis/redis.sock?db=0',
        'OPTIONS': {
            'CLIENT_CLASS': 'django_redis.client.DefaultClient',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
        }
    },
    'avatar': {
        'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
        'LOCATION': os.path.join(DATA_DIR, 'avatar-cache'),
        'TIMEOUT': 604800,
        'OPTIONS': {
            'MAX_ENTRIES': 1000,
        },
    }

Ver también

ENABLE_AVATARS, AVATAR_URL_PREFIX, Avatars, Enable caching, Django’s cache framework

Configure e-mail sending¶

Weblate needs to send out e-mails on several occasions, and these e-mails should have a correct sender address, please configure SERVER_EMAIL and DEFAULT_FROM_EMAIL to match your environment, for example:

SERVER_EMAIL = 'admin@example.org'
DEFAULT_FROM_EMAIL = 'weblate@example.org'

Nota

To disable sending e-mails by Weblate set EMAIL_BACKEND to django.core.mail.backends.dummy.EmailBackend.

This will disable all e-mail delivery including registration or password reset e-mails.

Ver también

Adjusting configuration, Configurar el correo electrónico saliente, EMAIL_BACKEND, DEFAULT_FROM_EMAIL, SERVER_EMAIL

Allowed hosts setup¶

Django requires ALLOWED_HOSTS to hold a list of domain names your site is allowed to serve, leaving it empty will block any requests.

In case this is not configured to match your HTTP server, you will get errors like Invalid HTTP_HOST header: '1.1.1.1'. You may need to add '1.1.1.1' to ALLOWED_HOSTS.

Consejo

On Docker container, this is available as WEBLATE_ALLOWED_HOSTS.

Ver también

ALLOWED_HOSTS, WEBLATE_ALLOWED_HOSTS, Set correct site domain

Django secret key¶

The SECRET_KEY setting is used by Django to sign cookies, and you should really generate your own value rather than using the one from the example setup.

You can generate a new key using weblate/examples/generate-secret-key shipped with Weblate.

Ver también

SECRET_KEY

Directorio del usuario¶

Distinto en la versión 2.1: This is no longer required, Weblate now stores all its data in DATA_DIR.

The home directory for the user running Weblate should exist and be writable by this user. This is especially needed if you want to use SSH to access private repositories, but Git might need to access this directory as well (depending on the Git version you use).

You can change the directory used by Weblate in settings.py, for example to set it to configuration directory under the Weblate tree:

os.environ['HOME'] = os.path.join(BASE_DIR, 'configuration')

Nota

On Linux, and other UNIX like systems, the path to user’s home directory is defined in /etc/passwd. Many distributions default to a non-writable directory for users used for serving web content (such as apache, www-data or wwwrun), so you either have to run Weblate under a different user, or change this setting.

Ver también

Accessing repositories

Carga de plantillas¶

It is recommended to use a cached template loader for Django. It caches parsed templates and avoids the need to do parsing with every single request. You can configure it using the following snippet (the loaders setting is important here):

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            os.path.join(BASE_DIR, 'templates'),
        ],
        'OPTIONS': {
            'context_processors': [
                'django.contrib.auth.context_processors.auth',
                'django.template.context_processors.debug',
                'django.template.context_processors.i18n',
                'django.template.context_processors.request',
                'django.template.context_processors.csrf',
                'django.contrib.messages.context_processors.messages',
                'weblate.trans.context_processors.weblate_context',
            ],
            'loaders': [
                ('django.template.loaders.cached.Loader', [
                    'django.template.loaders.filesystem.Loader',
                    'django.template.loaders.app_directories.Loader',
                ]),
            ],
        },
    },
]

Ver también

django.template.loaders.cached.Loader

Efectuar tareas de mantenimiento¶

For optimal performance, it is good idea to run some maintenance tasks in the background. This is now automatically done by Tareas en segundo plano con Celery and covers following tasks:

Configuration health check (hourly).
Committing pending changes (hourly), see Consignas diferidas and commit_pending.
Updating component alerts (daily).
Update remote branches (nightly), see AUTO_UPDATE.
Translation memory backup to JSON (daily), see dump_memory.
Fulltext and database maintenance tasks (daily and weekly tasks), see cleanuptrans.

Distinto en la versión 3.2: Since version 3.2, the default way of executing these tasks is using Celery and Weblate already comes with proper configuration, see Tareas en segundo plano con Celery.

System locales and encoding¶

The system locales should be configured to UTF-8 capable ones. On most Linux distributions this is the default setting. In case it is not the case on your system, please change locales to UTF-8 variant.

For example by editing /etc/default/locale and setting there LANG="C.UTF-8".

In some cases the individual services have separate configuration for locales. For example when using Apache you might want to set it in /etc/apache2/envvars:

export LANG='en_US.UTF-8'
export LC_ALL='en_US.UTF-8'

Using custom certificate authority¶

Weblate does verify SSL certificates during HTTP requests. In case you are using custom certificate authority which is not trusted in default bundles, you will have to add its certificate as trusted.

The preferred approach is to do this at system level, please check your distro documentation for more details (for example on debian this can be done by placing the CA certificate into /usr/local/share/ca-certificates/ and running update-ca-certificates).

Once this is done, system tools will trust the certificate and this includes Git.

For Python code, you will need to configure requests to use system CA bundle instead of the one shipped with it. This can be achieved by placing following snippet to settings.py (the path is Debian specific):

import os
os.environ["REQUESTS_CA_BUNDLE"] = "/etc/ssl/certs/ca-certificates.crt"

Compressing client assets¶

Weblate comes with a bunch of JavaScript and CSS files. For performance reasons it is good to compress them before sending to a client. In default configuration this is done on the fly at cost of little overhead. On big installations, it is recommended to enable offline compression mode. This needs to be done in the configuration and the compression has to be triggered on every Weblate upgrade.

The configuration switch is simple by enabling django.conf.settings.COMPRESS_OFFLINE and configuring django.conf.settings.COMPRESS_OFFLINE_CONTEXT (the latter is already included in the example configuration):

COMPRESS_OFFLINE = True

On each deploy you need to compress the files to match current version:

weblate compress

Consejo

La imagen oficial para Docker ya tiene activada esta funcionalidad.

Ver también

Common Deployment Scenarios, Serving static files

Running server¶

You will need several services to run Weblate, the recommended setup consists of:

Database server (see Configuración de base de datos para Weblate)
Cache server (see Enable caching)
Frontend web server for static files and SSL termination (see Serving static files)
Wsgi server for dynamic content (see Sample configuration for NGINX and uWSGI)
Celery for executing background tasks (see Tareas en segundo plano con Celery)

Nota

There are some dependencies between the services, for example cache and database should be running when starting up Celery or uwsgi processes.

In most cases, you will run all services on single (virtual) server, but in case your installation is heavy loaded, you can split up the services. The only limitation on this is that Celery and Wsgi servers need access to DATA_DIR.

Running web server¶

Running Weblate is not different from running any other Django based program. Django is usually executed as uWSGI or fcgi (see examples for different webservers below).

For testing purposes, you can use the built-in web server in Django:

weblate runserver

Advertencia

DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through security audits or performance tests. See also Django documentation on runserver.

Consejo

The Django built-in server serves static files only with DEBUG enabled as it is intended for development only. For production use, please see wsgi setups in Sample configuration for NGINX and uWSGI, Sample configuration for Apache, Sample configuration for Apache and Gunicorn, and Serving static files.

Serving static files¶

Distinto en la versión 2.4: Prior to version 2.4, Weblate didn’t properly use the Django static files framework and the setup was more complex.

Django needs to collect its static files in a single directory. To do so, execute weblate collectstatic --noinput. This will copy the static files into a directory specified by the STATIC_ROOT setting (this defaults to a static directory inside DATA_DIR).

It is recommended to serve static files directly from your web server, you should use that for the following paths:

/static/: Serves static files for Weblate and the admin interface (from defined by STATIC_ROOT).
/media/: Used for user media uploads (e.g. screenshots).
/favicon.ico: Should be rewritten to rewrite a rule to serve /static/favicon.ico.

Ver también

Compressing client assets, Deploying Django, Deploying static files

Content security policy¶

The default Weblate configuration enables weblate.middleware.SecurityMiddleware middleware which sets security related HTTP headers like Content-Security-Policy or X-XSS-Protection. These are by default set up to work with Weblate and its configuration, but this might need customization for your environment.

Ver también

CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC

Sample configuration for NGINX and uWSGI¶

To run production webserver, use the wsgi wrapper installed with Weblate (in virtual env case it is installed as ~/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py). Don’t forget to set the Python search path to your virtualenv as well (for example using virtualenv = /home/user/weblate-env in uWSGI).

The following configuration runs Weblate as uWSGI under the NGINX webserver.

Configuration for NGINX (also available as weblate/examples/weblate.nginx.conf):

# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
server {
    listen 80;
    server_name weblate;
    # Not used
    root /var/www/html;

    location ~ ^/favicon.ico$ {
        # DATA_DIR/static/favicon.ico
        alias /home/weblate/data/static/favicon.ico;
        expires 30d;
    }

    location /static/ {
        # DATA_DIR/static/
        alias /home/weblate/data/static/;
        expires 30d;
    }

    location /media/ {
        # DATA_DIR/media/
        alias /home/weblate/data/media/;
        expires 30d;
    }

    location / {
        include uwsgi_params;
        # Needed for long running operations in admin interface
        uwsgi_read_timeout 3600;
        # Adjust based to uwsgi configuration:
        uwsgi_pass unix:///run/uwsgi/app/weblate/socket;
        # uwsgi_pass 127.0.0.1:8080;
    }
}

Configuration for uWSGI (also available as weblate/examples/weblate.uwsgi.ini):

# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
[uwsgi]
plugins       = python3
master        = true
protocol      = uwsgi
socket        = 127.0.0.1:8080
wsgi-file     = /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py

# Add path to Weblate checkout if you did not install
# Weblate by pip
# python-path   = /path/to/weblate

# In case you're using virtualenv uncomment this:
virtualenv = /home/weblate/weblate-env

# Needed for OAuth/OpenID
buffer-size   = 8192

# Reload when consuming too much of memory
reload-on-rss = 250

# Increase number of workers for heavily loaded sites
workers       = 8

# Enable threads for Sentry error submission
enable-threads = true

# Child processes do not need file descriptors
close-on-exec = true

# Avoid default 0000 umask
umask = 0022

# Run as weblate user
uid = weblate
gid = weblate

# Enable harakiri mode (kill requests after some time)
# harakiri = 3600
# harakiri-verbose = true

# Enable uWSGI stats server
# stats = :1717
# stats-http = true

# Do not log some errors caused by client disconnects
ignore-sigpipe = true
ignore-write-errors = true
disable-write-exception = true

Ver también

How to use Django with uWSGI

Sample configuration for Apache¶

The following configuration runs Weblate as WSGI, you need to have enabled mod_wsgi (available as weblate/examples/apache.conf):

#
# VirtualHost for Weblate
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:80>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    # Path to your Weblate virtualenv
    WSGIDaemonProcess weblate python-home=/home/weblate/weblate-env
    WSGIProcessGroup weblate
    WSGIApplicationGroup %{GLOBAL}

    WSGIScriptAlias / /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py process-group=weblate
    WSGIPassAuthorization On

    <Directory /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/>
        <Files wsgi.py>
        Require all granted
        </Files>
    </Directory>

</VirtualHost>

Nota

Weblate requires Python 3, so please make sure you are running Python 3 variant of the modwsgi. Usually it is available as a separate package, for example libapache2-mod-wsgi-py3.

Ver también

System locales and encoding, How to use Django with Apache and mod_wsgi

Sample configuration for Apache and Gunicorn¶

The following configuration runs Weblate in Gunicorn and Apache 2.4 (available as weblate/examples/apache.gunicorn.conf):

#
# VirtualHost for Weblate using gunicorn on localhost:8000
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:443>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    SSLEngine on
    SSLCertificateFile /etc/apache2/ssl/https_cert.cert
    SSLCertificateKeyFile /etc/apache2/ssl/https_key.pem
    SSLProxyEngine On

    ProxyPass /favicon.ico !
    ProxyPass /static/ !
    ProxyPass /media/ !

    ProxyPass / http://localhost:8000/
    ProxyPassReverse / http://localhost:8000/
    ProxyPreserveHost On
</VirtualHost>

Ver también

How to use Django with Gunicorn

Running Weblate under path¶

Distinto en la versión 1.3: This is supported since Weblate 1.3.

A sample Apache configuration to serve Weblate under /weblate. Again using mod_wsgi (also available as weblate/examples/apache-path.conf):

#
# VirtualHost for Weblate, running under /weblate path
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:80>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /weblate/favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /weblate/static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /weblate/media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    # Path to your Weblate virtualenv
    WSGIDaemonProcess weblate python-home=/home/weblate/weblate-env
    WSGIProcessGroup weblate
    WSGIApplicationGroup %{GLOBAL}

    WSGIScriptAlias /weblate /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py process-group=weblate
    WSGIPassAuthorization On

    <Directory /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/>
        <Files wsgi.py>
        Require all granted
        </Files>
    </Directory>

</VirtualHost>

Additionally, you will have to adjust weblate/settings.py:

URL_PREFIX = '/weblate'

Tareas en segundo plano con Celery¶

Nuevo en la versión 3.2.

Weblate uses Celery to process background tasks. The example settings come with eager configuration, which does process all tasks in place, but you want to change this to something more reasonable for a production setup.

A typical setup using Redis as a backend looks like this:

CELERY_TASK_ALWAYS_EAGER = False
CELERY_BROKER_URL = 'redis://localhost:6379'
CELERY_RESULT_BACKEND = CELERY_BROKER_URL

You should also start the Celery worker to process the tasks and start scheduled tasks, this can be done directly on the command line (which is mostly useful when debugging or developing):

./weblate/examples/celery start
./weblate/examples/celery stop

Running Celery as system service¶

Most likely you will want to run Celery as a daemon and that is covered by Daemonization. For the most common Linux setup using systemd, you can use the example files shipped in the examples folder listed below.

Systemd unit to be placed as /etc/systemd/system/celery-weblate.service:

[Unit]
Description=Celery Service (Weblate)
After=network.target

[Service]
Type=forking
User=weblate
Group=weblate
EnvironmentFile=/etc/default/celery-weblate
WorkingDirectory=/home/weblate
RuntimeDirectory=celery
RuntimeDirectoryPreserve=restart
LogsDirectory=celery
ExecStart=/bin/sh -c '${CELERY_BIN} multi start ${CELERYD_NODES} \
  -A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
  --logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'
ExecStop=/bin/sh -c '${CELERY_BIN} multi stopwait ${CELERYD_NODES} \
  --pidfile=${CELERYD_PID_FILE}'
ExecReload=/bin/sh -c '${CELERY_BIN} multi restart ${CELERYD_NODES} \
  -A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
  --logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'

[Install]
WantedBy=multi-user.target

Environment configuration to be placed as /etc/default/celery-weblate:

# Name of nodes to start
CELERYD_NODES="celery notify backup translate"

# Absolute or relative path to the 'celery' command:
CELERY_BIN="/home/weblate/weblate-env/bin/celery"

# App instance to use
# comment out this line if you don't use an app
CELERY_APP="weblate.utils"

# Extra command-line arguments to the worker,
# increase concurency if you get weblate.E019
CELERYD_OPTS="--beat:celery --concurrency:celery=4 --queues:celery=celery --prefetch-multiplier:celery=4 \
    --concurrency:notify=4 --queues:notify=notify --prefetch-multiplier:notify=10 \
    --concurrency:translate=4 --queues:translate=translate --prefetch-multiplier:translate=4 \
    --concurrency:backup=1 --queues:backup=backup  --prefetch-multiplier:backup=2"

# Logging configuration
# - %n will be replaced with the first part of the nodename.
# - %I will be replaced with the current child process index
#   and is important when using the prefork pool to avoid race conditions.
CELERYD_PID_FILE="/var/run/celery/weblate-%n.pid"
CELERYD_LOG_FILE="/var/log/celery/weblate-%n%I.log"
CELERYD_LOG_LEVEL="INFO"

# Internal Weblate variable to indicate we're running inside Celery
CELERY_WORKER_RUNNING="1"

Logrotate configuration to be placed as /etc/logrotate.d/celery:

/var/log/celery/*.log {
        weekly
        missingok
        rotate 12
        compress
        notifempty
}

Nota

The Celery process has to be executed under the same user as Weblate and the WSGI process, otherwise files in the DATA_DIR will be stored with mixed ownership, leading to runtime issues.

Periodic tasks using Celery beat¶

Weblate comes with built-in setup for scheduled tasks. You can however define additional tasks in settings.py, for example see Consignas diferidas.

The tasks are supposed to be executed by Celery beats daemon. In case it is not working properly, it might not be running or its database was corrupted. Check the Celery startup logs in such case to figure out root cause.

Monitoring Celery status¶

You can use celery_queues to see current length of Celery task queues. In case the queue will get too long, you will also get configuration error in the admin interface.

Advertencia

The Celery errors are by default only logged into Celery log and are not visible to user. In case you want to have overview on such failures, it is recommended to configure Collecting error reports.

Ver también

Configuration and defaults, Workers Guide, Daemonization, Monitoring and Management Guide, celery_queues

Monitoring Weblate¶

Weblate provides the /healthz/ URL to be used in simple health checks, for example using Kubernetes.

Collecting error reports¶

Weblate, as any other software, can fail. In order to collect useful failure states we recommend to use third party services to collect such information. This is especially useful in case of failing Celery tasks, which would otherwise only report error to the logs and you won’t get notified on them. Weblate has support for the following services:

Sentry¶

Weblate has built-in support for Sentry. To use it, it’s enough to set SENTRY_DSN in the settings.py:

SENTRY_DSN = "https://id@your.sentry.example.com/"

Rollbar¶

Weblate has built-in support for Rollbar. To use it, it’s enough to follow instructions for Rollbar notifier for Python.

In short, you need to adjust settings.py:

# Add rollbar as last middleware:
MIDDLEWARE = [
    # … other middleware classes …
    'rollbar.contrib.django.middleware.RollbarNotifierMiddleware',
]

# Configure client access
ROLLBAR = {
    'access_token': 'POST_SERVER_ITEM_ACCESS_TOKEN',
    'client_token': 'POST_CLIENT_ITEM_ACCESS_TOKEN',
    'environment': 'development' if DEBUG else 'production',
    'branch': 'master',
    'root': '/absolute/path/to/code/root',
}

Everything else is integrated automatically, you will now collect both server and client side errors.

Migrating Weblate to another server¶

Migrating Weblate to another server should be pretty easy, however it stores data in few locations which you should migrate carefully. The best approach is to stop Weblate for the migration.

Migrating database¶

Depending on your database backend, you might have several options to migrate the database. The most straightforward one is to dump the database on one server and import it on the new one. Alternatively you can use replication in case your database supports it.

The best approach is to use database native tools, as they are usually the most effective (e.g. mysqldump or pg_dump). If you want to migrate between different databases, the only option might be to use Django management to dump and import the database:

# Export current data
weblate dumpdata > /tmp/weblate.dump
# Import dump
weblate loaddata /tmp/weblate.dump

Migrating VCS repositories¶

The VCS repositories stored under DATA_DIR need to be migrated as well. You can simply copy them or use rsync to do the migration more effectively.

Otras notas¶

No olvide trasladar los otros servicios que Weblate esté utilizando, como Redis, las tareas de Cron o los dorsales de autenticación personalizados.

Implantaciones de Weblate¶

Es sencillo instalar Weblate en su nube. Consulte la guía detallada correspondiente a su plataforma:

Helm Chart¶

Puede instalar Weblate en Kubernetes con la ayuda de Helm. Vea <https://github.com/WeblateOrg/helm/tree/master/charts/weblate> para obtener instrucciones detalladas.

Pila de Weblate para Bitnami¶

Bitnami provides a Weblate stack for many platforms at <https://bitnami.com/stack/weblate>. The setup will be adjusted during installation, see <https://bitnami.com/stack/weblate/README.txt> for more documentation.

Weblate en YunoHost¶

The self-hosting project YunoHost provides a package for Weblate. Once you have your YunoHost installation, you may install Weblate as any other application. It will provide you with a fully working stack with backup and restoration, but you may still have to edit your settings file for specific usages.

You may use your administration interface, or this button (it will bring you to your server):

También se puede utilizar la interfaz de línea de órdenes:

yunohost app install https://github.com/YunoHost-Apps/weblate_ynh

Actualizar Weblate¶

Docker image upgrades¶

The official Docker image (see Instalar con Docker) has all upgrade steps integrated. There are no manual step besides pulling latest version.

Instrucciones de actualización genéricas¶

Before upgrading, please check the current Requisitos de software as they might have changed. Once all requirements are installed or updated, please adjust your settings.py to match changes in the configuration (consult settings_example.py for correct values).

Always check Version specific instructions before upgrade. In case you are skipping some versions, please follow instructions for all versions you are skipping in the upgrade. Sometimes it’s better to upgrade to some intermediate version to ensure a smooth migration. Upgrading across multiple releases should work, but is not as well tested as single version upgrades.

Nota

It is recommended to perform a full database backup prior to upgrade so that you can roll back the database in case upgrade fails, see Backing up and moving Weblate.

Stop wsgi and Celery processes. The upgrade can perform incompatible changes in the database, so it is always safer to avoid old processes running while upgrading.

Upgrade Weblate code.

For pip installs it can be achieved by:

pip install -U Weblate

With Git checkout you need to fetch new source code and update your installation:

cd weblate-src
git pull
# Update Weblate inside your virtualenv
. ~/weblate-env/bin/pip install -e .
# Install dependencies directly when not using virtualenv
pip install --upgrade -r requirements.txt

Upgrade configuration file, refer to settings_example.py or Version specific instructions for needed steps.
Upgrade database structure:
```
weblate migrate --noinput
```
Collect updated static files (see Running server and Serving static files):
```
weblate collectstatic --noinput
```
Compress JavaScript and CSS files (optional, see Compressing client assets):
```
weblate compress
```
If you are running version from Git, you should also regenerate locale files every time you are upgrading. You can do this by invoking:
```
weblate compilemessages
```
Verify that your setup is sane (see also Production setup):
```
weblate check --deploy
```
Restart celery worker (see Tareas en segundo plano con Celery).

Version specific instructions¶

Upgrade from 2.x¶

If you are upgrading from 2.x release, always first upgrade to 3.0.1 and the continue upgrading in the 3.x series. Upgrades skipping this step are not supported and will break.

Ver también

Upgrade from 2.20 to 3.0 in Weblate 3.0 documentation

Upgrade from 3.x¶

If you are upgrading from 3.x release, always first upgrade to 4.0.4 and the continue upgrading in the 4.x series. Upgrades skipping this step are not supported and will break.

Ver también

Upgrade from 3.11 to 4.0 in Weblate 4.0 documentation

Upgrade from 4.0 to 4.1¶

Please follow Instrucciones de actualización genéricas in order to perform update.

Notable configuration or dependencies changes:

There are several changes in settings_example.py, most notable middleware changes, please adjust your settings accordingly.
There are new file formats, you might want to include them in case you modified the WEBLATE_FORMATS.
There are new quality checks, you might want to include them in case you modified the CHECK_LIST.
There is change in DEFAULT_THROTTLE_CLASSES setting to allow reporting of rate limiting in the API.
There are some new and updated requirements.
There is a change in INSTALLED_APPS.
The DeepL machine translation now defaults to v2 API, you might need to adjust MT_DEEPL_API_VERSION in case your current DeepL subscription does not support that.

Ver también

Instrucciones de actualización genéricas

Upgrade from 4.1 to 4.2¶

Please follow Instrucciones de actualización genéricas in order to perform update.

Notable configuration or dependencies changes:

Upgrade from 3.x releases is not longer supported, please upgrade to 4.0 or 4.1 first.
There are some new and updated requirements.
There are several changes in settings_example.py, most notable new middleware and changed application ordering.
The keys for JSON based formats no longer include leading dot. The strings are adjusted during the database migration, but external components might need adjustment in case you rely on keys in exports or API.
The Celery configuration was changed to no longer use memory queue. Please adjust your startup scripts and CELERY_TASK_ROUTES setting.
The Weblate domain is now configured in the settings, see SITE_DOMAIN (or WEBLATE_SITE_DOMAIN). You will have to configure it before running Weblate.

Ver también

Instrucciones de actualización genéricas

Upgrading from Python 2 to Python 3¶

Weblate no longer supports Python older than 3.5. In case you are still running on older version, please perform migration to Python 3 first on existing version and upgrade later. See Upgrading from Python 2 to Python 3 in the Weblate 3.11.1 documentation.

Migrating from other databases to PostgreSQL¶

If you are running Weblate on other dabatase than PostgreSQL, you should migrate to PostgreSQL as that will be the only supported database backend in the 4.0 release. The following steps will guide you in migrating your data between the databases. Please remember to stop both web and Celery servers prior to the migration, otherwise you might end up with inconsistent data.

Crear una base de datos en PostgreSQL¶

Suele ser una buena idea ejecutar Weblate en su propia base de datos, en una cuenta de usuario separada:

# If PostgreSQL was not installed before, set the main password
sudo -u postgres psql postgres -c "\password postgres"

# Create a database user called "weblate"
sudo -u postgres createuser -D -P weblate

# Create the database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

Migrating using Django JSON dumps¶

The simplest approach for migration is to utilize Django JSON dumps. This works well for smaller installations. On bigger sites you might want to use pgloader instead, see Migrating to PotsgreSQL using pgloader.

Add PostgeSQL as additional database connection to the settings.py:

DATABASES = {
    'default': {
        # Database engine
        'ENGINE': 'django.db.backends.mysql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
        # Additional database options
        'OPTIONS': {
            # In case of using an older MySQL server, which has MyISAM as a default storage
            # 'init_command': 'SET storage_engine=INNODB',
            # Uncomment for MySQL older than 5.7:
            # 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            # If your server supports it, see the Unicode issues above
           'charset': 'utf8mb4',
           # Change connection timeout in case you get MySQL gone away error:
           'connect_timeout': 28800,
        }
    },
    'postgresql': {
        # Database engine
        'ENGINE': 'django.db.backends.postgresql',
        # Database name
        'NAME': 'weblate',
        # Database user
        'USER': 'weblate',
        # Database password
        'PASSWORD': 'password',
        # Set to empty string for localhost
        'HOST': 'database.example.com',
        # Set to empty string for default
        'PORT': '',
    }
}

Run migrations and drop any data inserted into the tables:

weblate migrate --database=postgresql
weblate sqlflush --database=postgresql | weblate dbshell --database=postgresql

Dump legacy database and import to PostgreSQL

weblate dumpdata --all --output weblate.json
weblate loaddata weblate.json --database=postgresql

Adjust DATABASES to use just PostgreSQL database as default, remove legacy connection.

Weblate should be now ready to run from the PostgreSQL database.

Migrating to PotsgreSQL using pgloader¶

The pgloader is a generic migration tool to migrate data to PostgreSQL. You can use it to migrate Weblate database.

Adjust your settings.py to use PostgeSQL as a database.

Migrate the schema in the PostgreSQL database:

weblate migrate
weblate sqlflush | weblate dbshell

Run the pgloader to transfer the data. The following script can be used to migrate the database, but you might want to learn more about pgloader to understand what it does and tweak it to match your setup:

LOAD DATABASE
     FROM      mysql://weblate:password@localhost/weblate
     INTO postgresql://weblate:password@localhost/weblate

WITH include no drop, truncate, create no tables, create no indexes, no foreign keys, disable triggers, reset sequences, data only

ALTER SCHEMA 'weblate' RENAME TO 'public'
;

Migrating from Pootle¶

As Weblate was originally written as replacement from Pootle, it is supported to migrate user accounts from Pootle. You can dump the users from Pootle and import them using importusers.

Backing up and moving Weblate¶

Automated backup¶

Nuevo en la versión 3.9.

Weblate has built-in support for creating service backups using BorgBackup. Borg creates space-effective encrypted backups which can be safely stored in the cloud. The backups can be controlled in the management interface on the Backups tab.

Advertencia

Only PostgreSQL database is included in the automated backups. Other database engines have to be backed up manually. You are recommended to migrate to PostgreSQL, see Configuración de base de datos para Weblate and Migrating from other databases to PostgreSQL.

The backups using Borg are incremental and Weblate is configured to keep following backups:

14 daily backups
8 weekly backups
6 monthly backups

Using Weblate provisioned backup storage¶

The easiest approach to backup your Weblate instance is to purchase backup service at weblate.org. The process of activating can be performed in few steps:

Purchase backup service on https://weblate.org/support/#backup.
Enter obtained key in the management interface, see Integrating support.
Weblate will connect to the cloud service and obtain access information for the backups.
Turn on the new backup configuration on the Backups tab.
Backup Borg credentials in order to be able to restore the backups, see Borg encryption key.

Consejo

The manual step of turning on is there for your safety. Without your consent no data is sent to the backup repository obtained through the registration process.

Using custom backup storage¶

You can also use your own storage for the backups. SSH can be used to store backups on the remote destination, the target server needs to have BorgBackup installed.

Ver también

General in the Borg documentation

Borg encryption key¶

BorgBackup creates encrypted backups and without a passphrase you will not be able to restore the backup. The passphrase is generated when adding new backup service and you should copy it and keep it in a secure place.

In case you are using Using Weblate provisioned backup storage, please backup your private SSH key as well — it is used to access your backups.

Ver también

borg init

Restoring from BorgBackup¶

Restore access to your backup repository and prepare your backup passphrase.
List backup existing on the server using borg list REPOSITORY.
Restore the desired backup to current directory using borg extract REPOSITORY::ARCHIVE.
Restore the database from the SQL dump placed in the backup directory in the Weblate data dir (see Dumped data for backups).
Copy Weblate configuration (backups/settings.py, see Dumped data for backups) to the correct location, see Adjusting configuration.
Copy the whole restored data dir to location configured by DATA_DIR.

The Borg session might look like:

$ borg list /tmp/xxx
Enter passphrase for key /tmp/xxx:
2019-09-26T14:56:08                  Thu, 2019-09-26 14:56:08 [de0e0f13643635d5090e9896bdaceb92a023050749ad3f3350e788f1a65576a5]
$ borg extract /tmp/xxx::2019-09-26T14:56:08
Enter passphrase for key /tmp/xxx:

Ver también

borg list, borg extract

Manual backup¶

Depending on what you want to save, back up the type data Weblate stores in each respective place.

Consejo

In case you are doing manual backups, you might want to silent Weblate warning about lack of backups by adding weblate.I028 to SILENCED_SYSTEM_CHECKS in settings.py or WEBLATE_SILENCED_SYSTEM_CHECKS for Docker.

SILENCED_SYSTEM_CHECKS.append("weblate.I028")

Database¶

The actual storage location depends on your database setup.

The database is the most important storage. Set up regular backups of your database, without it all your translation setup will be gone.

Native database backup¶

The recommended approach is to do dump of the database using database native tools such as pg_dump or mysqldump. It usually performs better than Django backup and restores complete tables with all data.

You can restore this backup in newer Weblate release, it will perform any necessary migrations when running in migrate. Please consult Actualizar Weblate on more detailed information how to perform upgrade between versions.

Django database backup¶

Alternatively you can backup database using Django’s dumpdata command. That way the backup is database agnostic and can be used in case you want to change database backend.

Prior to restoring you need to be running exactly same Weblate version as was used when doing backups. This is necessary as the database structure does change between releases and you would end up corrupting the data in some way. After installing the same version, run all database migrations using migrate.

Once this is done, some entries will be already created in the database and you will have them in the database backup as well. The recommended approach is to delete such entries manually using management shell (see Invocar órdenes de gestión):

weblate shell
>>> from weblate.auth.models import User
>>> User.objects.get(username='anonymous').delete()

Archivos¶

If you have enough backup space, simply backup the whole DATA_DIR. This is safe bet even if it includes some files you don’t want. The following sections describe in detail what you should back up and what you can skip.

Dumped data for backups¶

Stored in DATA_DIR /backups.

Weblate dumps various data here, and you can include these files for more complete backups. The files are updated daily (requires a running Celery beats server, see Tareas en segundo plano con Celery). Currently, this includes:

Weblate settings as settings.py (there is also expanded version in settings-expanded.py).
PostgreSQL database backup as database.sql.

The database backups are by default saved as plain text, but they can also be compressed or entirely skipped by using DATABASE_BACKUP.

Version control repositories¶

Stored in DATA_DIR /vcs.

The version control repositories contain a copy of your upstream repositories with Weblate changes. If you have push on commit enabled for all your translation components, all Weblate changes are included upstream and you do not have to backup the repositories on the Weblate side. They can be cloned again from the upstream locations with no data loss.

SSH and GPG keys¶

Stored in DATA_DIR /ssh and DATA_DIR /home.

If you are using SSH or GPG keys generated by Weblate, you should back up these locations, otherwise you will lose the private keys and you will have to regenerate new ones.

Archivos cargados por los usuarios¶

Stored in DATA_DIR /media.

You should back up user uploaded files (e.g. Contexto visual para cadenas).

Command line for manual backup¶

Con la ayuda de una tarea de cron es posible montar una orden de bash que se ejecute diariamente. Por ejemplo:

$ XZ_OPT="-9" tar -Jcf ~/backup/weblate-backup-$(date -u +%Y-%m-%d_%H%M%S).xz backups vcs ssh home media fonts secret

The string between quotes after XZ_OPT allows you to choose your xz options, for instance the amount of memory used for compression; see https://linux.die.net/man/1/xz

You can adjust the list of folders and files to your needs. For instance, to avoid saving the translation memory (in backups folder), you could use:

$ XZ_OPT="-9" tar -Jcf ~/backup/weblate-backup-$(date -u +%Y-%m-%d_%H%M%S).xz backups/database.sql backups/settings.py vcs ssh home media fonts secret

Tareas de Celery¶

The Celery tasks queue might contain some info, but is usually not needed for a backup. At most you will lose updates that have not yet been processed to translation memory. It is recommended to perform the fulltext or repository updates upon restoring anyhow, so there is no problem in losing these.

Ver también

Tareas en segundo plano con Celery

Restoring manual backup¶

Restore all data you have backed up.
Update all repositories using updategit.
```
weblate updategit --all
```

Moving a Weblate installation¶

Relocate your installation to a different system by following the backup and restore instructions above.

Ver también

Upgrading from Python 2 to Python 3, Migrating from other databases to PostgreSQL

Autenticación¶

Registro de usuarios¶

The default setup for Weblate is to use python-social-auth, a form on the website to handle registration of new users. After confirming their e-mail a new user can contribute or authenticate by using one of the third party services.

You can also turn off registration of new users using REGISTRATION_OPEN.

The authentication attempts are subject to Rate limiting.

Dorsales de autenticación¶

The built-in solution of Django is used for authentication, including various social options to do so. Using it means you can import the user database of other Django-based projects (see Migrating from Pootle).

Django can additionally be set up to authenticate against other means too.

Ver también

Authentication settings describes how to configure authentication in the official Docker image.

Autenticación por contraseña¶

The default settings.py comes with a reasonable set of AUTH_PASSWORD_VALIDATORS:

Las contraseñas no deben asemejarse demasiado a otros datos personales suyos.
Las contraseñas deben tener por lo menos 10 caracteres de longitud.
Las contraseñas no pueden figurar entre las más comúnmente utilizadas.
Las contraseñas no pueden consistir enteramente de números.
Las contraseñas no pueden consistir de un único carácter o de solo espacios.
Las contraseñas no pueden coincidir con alguna que haya utilizado en el pasado.

Puede personalizar esta configuración para que se ajuste a su normativa de contraseñas.

Additionally you can also install django-zxcvbn-password which gives quite realistic estimates of password difficulty and allows rejecting passwords below a certain threshold.

Autenticación por SAML¶

Nuevo en la versión 4.1.1.

Please follow the Python Social Auth instructions for configuration. Notable differences:

Weblate supports single IDP which has to be called weblate in SOCIAL_AUTH_SAML_ENABLED_IDPS.
The SAML XML metadata URL is /accounts/metadata/saml/.
Following settings are automatically filled in: SOCIAL_AUTH_SAML_SP_ENTITY_ID, SOCIAL_AUTH_SAML_TECHNICAL_CONTACT, SOCIAL_AUTH_SAML_SUPPORT_CONTACT

Ejemplo de configuración:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.email.EmailAuth",
    "social_core.backends.saml.SAMLAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_SAML_SP_PUBLIC_CERT = "-----BEGIN CERTIFICATE-----"
SOCIAL_AUTH_SAML_SP_PRIVATE_KEY = "-----BEGIN PRIVATE KEY-----"
SOCIAL_AUTH_SAML_ENABLED_IDPS = {
    "weblate": {
        "entity_id": "https://idp.testshib.org/idp/shibboleth",
        "url": "https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO",
        "x509cert": "MIIEDjCCAvagAwIBAgIBADA ... 8Bbnl+ev0peYzxFyF5sQA==",
        "attr_name": "full_name",
        "attr_username": "username",
        "attr_email": "email",
    }
}

Ver también

Configuring SAML in Docker, SAML

LDAP authentication¶

LDAP authentication can be best achieved using the django-auth-ldap package. You can install it via usual means:

# Using PyPI
pip install django-auth-ldap>=1.3.0

# Using apt-get
apt-get install python-django-auth-ldap

Advertencia

With django-auth-ldap older than 1.3.0 the Asignaciones de grupo automático will not work properly for newly created users.

Nota

There are some incompatibilities in the Python LDAP 3.1.0 module, which might prevent you from using that version. If you get error AttributeError: “module” object has no attribute “_trace_level”, downgrading python-ldap to 3.0.0 might help.

Once you have the package installed, you can hook it into the Django authentication:

# Add LDAP backed, keep Django one if you want to be able to login
# even without LDAP for admin account
AUTHENTICATION_BACKENDS = (
    'django_auth_ldap.backend.LDAPBackend',
    'weblate.accounts.auth.WeblateUserBackend',
)

# LDAP server address
AUTH_LDAP_SERVER_URI = 'ldaps://ldap.example.net'

# DN to use for authentication
AUTH_LDAP_USER_DN_TEMPLATE = 'cn=%(user)s,o=Example'
# Depending on your LDAP server, you might use a different DN
# like:
# AUTH_LDAP_USER_DN_TEMPLATE = 'ou=users,dc=example,dc=com'

# List of attributes to import from LDAP upon login
# Weblate stores full name of the user in the full_name attribute
AUTH_LDAP_USER_ATTR_MAP = {
    'full_name': 'name',
    # Use the following if your LDAP server does not have full name
    # Weblate will merge them later
    # 'first_name': 'givenName',
    # 'last_name': 'sn',
    # Email is required for Weblate (used in VCS commits)
    'email': 'mail',
}

# Hide the registration form
REGISTRATION_OPEN = False

Nota

You should remove 'social_core.backends.email.EmailAuth' from the AUTHENTICATION_BACKENDS setting, otherwise users will be able to set their password in Weblate, and authenticate using that. Keeping 'weblate.accounts.auth.WeblateUserBackend' is still needed in order to make permissions and facilitate anonymous users. It will also allow you to sign in using a local admin account, if you have created it (e.g. by using createadmin).

Using bind password¶

If you can not use direct bind for authentication, you will need to use search, and provide a user to bind for the search. For example:

import ldap
from django_auth_ldap.config import LDAPSearch

AUTH_LDAP_BIND_DN = ""
AUTH_LDAP_BIND_PASSWORD = ""
AUTH_LDAP_USER_SEARCH = LDAPSearch("ou=users,dc=example,dc=com",
    ldap.SCOPE_SUBTREE, "(uid=%(user)s)")

Integración con Active Directory¶

import ldap
from django_auth_ldap.config import LDAPSearch, NestedActiveDirectoryGroupType

AUTH_LDAP_BIND_DN = "CN=ldap,CN=Users,DC=example,DC=com"
AUTH_LDAP_BIND_PASSWORD = "password"

# User and group search objects and types
AUTH_LDAP_USER_SEARCH = LDAPSearch("CN=Users,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(sAMAccountName=%(user)s)")

# Make selected group a superuser in Weblate
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
    # is_superuser means user has all permissions
    "is_superuser": "CN=weblate_AdminUsers,OU=Groups,DC=example,DC=com",
}

# Map groups from AD to Weblate
AUTH_LDAP_GROUP_SEARCH = LDAPSearch("OU=Groups,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(objectClass=group)")
AUTH_LDAP_GROUP_TYPE = NestedActiveDirectoryGroupType()
AUTH_LDAP_FIND_GROUP_PERMS = True

# Optionally enable group mirroring from LDAP to Weblate
# AUTH_LDAP_MIRROR_GROUPS = True

Ver también

Django Authentication Using LDAP, Authentication

Autenticación CAS¶

Se puede implantar una autenticación CAS al utilizar un paquete como django-cas-ng.

El primer paso consiste en revelar el campo Correo electrónico del usuario mediante CAS. Esto debe configurarse en el propio servidor CAS, y necesitará ejecutar al menos la versión 2 de CAS, ya que CAS v1 no admite atributos.

El segundo paso será actualizar Weblate para que utilice el servidor y los atributos de CAS.

Para instalar django-cas-ng:

pip install django-cas-ng

Una vez que haya instalado el paquete, puede conectarlo con el sistema de autenticación de Django; para ello, modifique el archivo settings.py:

# Add CAS backed, keep the Django one if you want to be able to sign in
# even without LDAP for the admin account
AUTHENTICATION_BACKENDS = (
    'django_cas_ng.backends.CASBackend',
    'weblate.accounts.auth.WeblateUserBackend',
)

# CAS server address
CAS_SERVER_URL = 'https://cas.example.net/cas/'

# Add django_cas_ng somewhere in the list of INSTALLED_APPS
INSTALLED_APPS = (
    ...,
    'django_cas_ng'
)

Finalmente, se puede utilizar una señal para vincular el campo Correo electrónico y el objeto de usuario. Para que esto funcione, debe importar la señal del paquete django-cas-ng y conectar su código con esta señal. Realizar esto en el archivo de configuración puede causar problemas, por lo cual se recomienda ponerlo:

En el método django.apps.AppConfig.ready() de la configuración de su aplicación
En el archivo urls.py del proyecto (cuando no existan modelos)

from django_cas_ng.signals import cas_user_authenticated
from django.dispatch import receiver
@receiver(cas_user_authenticated)
def update_user_email_address(sender, user=None, attributes=None, **kwargs):
    # If your CAS server does not always include the email attribute
    # you can wrap the next two lines of code in a try/catch block.
    user.email = attributes['email']
    user.save()

Ver también

Django CAS NG

Configurar la autenticación de Django de terceros¶

Generally any Django authentication plugin should work with Weblate. Just follow the instructions for the plugin, just remember to keep the Weblate user backend installed.

Ver también

LDAP authentication, Autenticación CAS

Typically the installation will consist of adding an authentication backend to AUTHENTICATION_BACKENDS and installing an authentication app (if there is any) into INSTALLED_APPS:

AUTHENTICATION_BACKENDS = (
    # Add authentication backend here
    'weblate.accounts.auth.WeblateUserBackend',
)

INSTALLED_APPS = (
    ...
    'weblate',
    # Install authentication app here
)

Control de acceso¶

Distinto en la versión 3.0: Hasta Weblate 3.0, el sistema de privilegios se basaba en Django, pero ahora se ha construido específicamente para Weblate. Si utiliza una versión antigua, consulte la documentación que corresponda a esa versión, ya que la información que aquí se ofrece no será relevante.

Weblate incluye un sistema de privilegios detallado que permite asignar permisos de usuario en toda la instalación o en un ámbito limitado.

The permission system based on groups and roles, where roles define a set of permissions, and groups assign them to users and translations, see Users, roles, groups and permissions for more details.

After installation a default set of groups is created, and you can use those to assign users roles for the whole instance (see Default groups and roles). Additionally when Control de acceso por proyecto is turned on, you can assign users to specific translation projects. More fine-grained configuration can be achieved using Custom access control

Common setups¶

Bloquear Weblate¶

To completely lock down your Weblate installation, you can use LOGIN_REQUIRED_URLS to force users to sign in and REGISTRATION_OPEN to prevent new registrations.

Permisos para todo el sitio¶

To manage permissions for a whole instance, just add users to Users (this is done by default using the Asignaciones de grupo automático), Reviewers and Managers groups. Keep all projects configured as Public (see Control de acceso por proyecto).

Permisos por proyecto¶

Set your projects to Protected or Private, and manage users per project in the Weblate interface.

Añadir permisos a idiomas, componentes o proyectos¶

You can additionally grant permissions to any user based on project, component or language set. To achieve this, create a new group (e.g. Czech translators) and configure it for a given resource. Any assigned permissions will be granted to members of that group for selected resources.

This will work just fine without additional setup, if using per project permissions. For permissions on the whole instance, you will probably also want to remove these permissions from the Users group, or change automatic assignment of all users to that group (see Asignaciones de grupo automático).

Ver también

Comprobación de permisos

Control de acceso por proyecto¶

Nota

By enabling ACL, all users are prohibited from accessing anything within a given project, unless you add the permissions for them to do just that.

You can limit user’s access to individual projects. This feature is turned on by Access control in the configuration of each respective project. This automatically creates several groups for this project, see Grupos predefinidos.

The following choices exist for Access control:

Público: Públicamente visible y traducibles
Protegido: Publicly visible, but translatable only for selected users
Privado: Visible and translatable only for selected users
Personalizado: Weblate no gestiona los usuarios; vea Custom access control.

To allow access to this project, you have to add the privilege either directly to the given user, or group of users in the Django admin interface, or by using user management on the project page, as described in Managing per project access control.

Nota

Aunque se haya activado ACL, determinados datos de resumen sobre su proyecto estarán disponibles:

Estadísticas de toda la instalación, incluidos recuentos para todos los proyectos.
Language summary for the whole instance, including counts for all projects.

Asignaciones de grupo automático¶

You can set up Weblate to automatically add users to groups based on their e-mail addresses. This automatic assignment happens only at the time of account creation.

This can be set up in the Django admin interface for each group (in the Authentication section).

Nota

The automatic group assignment for the Users and Viewers groups will always be created by Weblate upon migrations, in case you want to turn it off, simply set the regular expression to ^$, which will never match.

Users, roles, groups and permissions¶

Los modelos de autenticación consisten de varios objetos:

Permission: Individual permissions defined by Weblate. You can not assign individual permissions, this can only be done through assignment of roles.
Role: Role defines a set of permissions. This allows reuse of these sets in several places, and makes the administration easier.
User: Los usuarios pueden ser miembros de varios grupos.
Group: Groups connect roles, users and authentication objects (projects, languages and component lists).

Comprobación de permisos¶

Whenever a permission is checked to decide whether one is able to perform a given action, the check is carried out according to scope, and the following checks are performed in the order:

Component list is matched against component or project.
Components are matched against component or project.
Projects are matched against project.

Como podrá apreciar, otorgar acceso a un componente también da automáticamente al usuario acceso al proyecto contenedor.

Nota

Only the first rule will be used. So if you set all of Component list, Components and Project, only Component list will be applied.

An additional step is performed if checking permission for the translation:

4. Languages are matched against the scope of translations if set, if not set, this does not match any language.

Consejo

You can use Language selection or Project selection to automate inclusion of all languages or projects.

Comprobar el acceso a un proyecto¶

A user has to be a member of a group linked to the project or any component inside it. Only membership is enough, no specific permissions are needed to access a project (this is used in the default Viewers group, see Default groups and roles).

Comprobar el acceso a un componente¶

A user can access the unrestricted component once he can access the containing project. With enabled Acceso restringido the access to the component requires explicit permission to the component (or containing component list).

Gestionar usuarios y grupos¶

All users and groups can be managed using the Django admin interface, available under /admin/ URL.

Managing per project access control¶

Nota

This feature only works for ACL controlled projects, see Control de acceso por proyecto.

Users with the Can manage ACL rules for a project privilege (see Control de acceso) can also manage users in projects with access control turned on through the project page. The interface allows you to:

Añadir usuarios existentes al proyecto
Invitar usuarios nuevos al proyecto
Cambiar los permisos de los usuarios
Revocar el acceso de los usuarios

The user management is available in the Manage menu of a project:

Ver también

Control de acceso por proyecto

Grupos predefinidos¶

Weblate comes with a predefined set of groups for a project, wherefrom you can assign users.

Administration: Has all permissions available in the project.

Glossary: Can manage glossary (add or remove entries, or upload).

Languages: Can manage translated languages - add or remove translations.

Screenshots: Can manage screenshots - add or remove them, and associate them to source strings.

Template: Can edit translation templates in Componentes monolingües and source string info.

Translate: Can translate the project, and upload translations made offline.

VCS: Can manage VCS and access the exported repository.

Review: Can approve translations during review.

Billing: Can access billing info (see Facturación).

Custom access control¶

By choosing Custom as Access control, Weblate will stop managing access for a given project, and all users and groups can be managed using the Django admin interface. This can be used to define more complex access control, or set up a shared access policy for all projects in a single Weblate instance. If you want to turn this on for all projects by default, please configure the DEFAULT_ACCESS_CONTROL.

Advertencia

By turning this on, Weblate will remove all Control de acceso por proyecto it has created for this project. If you are doing this without admin permission from the instance, you will instantly lose your access to manage the project.

Default groups and roles¶

Lista de privilegios¶

Billing (see Facturación)

View billing info [Administration, Billing]

Cambios

Descargar cambios [Administración]

Comentarios

Post comment [Administration, Edit source, Power user, Review strings, Translate]

Eliminar comentario [Administración]

Componente

Editar configuración de componentes [Administración]

Lock component, preventing it from being translated [Administration]

Glosario

Añadir entrada de glosario [Administración, Gestionar glosario, Usuario avanzado]

Editar entrada de glosario [Administración, Gestionar glosario, Usuario avanzado]

Eliminar entrada de glosario [Administración, Gestionar glosario, Usuario avanzado]

Cargar entradas de glosario [Administración, Gestionar glosario, Usuario avanzado]

Automatización

Utilizar automatización [Administración, Usuario avanzado]

Proyectos

Editar configuración del proyecto [Administración]

Gestionar acceso al proyecto [Administración]

Informes

Download reports [Administration]

Capturas de pantalla

Add screenshot [Administration, Manage screenshots]

Edit screenshot [Administration, Manage screenshots]

Delete screenshot [Administration, Manage screenshots]

Cadenas de origen

Edit source string info [Administration, Edit source]

Cadenas

Añadir cadenas nuevas [Administración]

Ignore failing checks [Administration, Edit source, Power user, Review strings, Translate]

Edit strings [Administration, Edit source, Power user, Review strings, Translate]

Review strings [Administration, Review strings]

Editar cadena cuando son obligatorias las sugerencias [Administración, Revisar cadenas]

Edit source strings [Administration, Edit source, Power user]

Sugerencias

Accept suggestions [Administration, Edit source, Power user, Review strings, Translate]

Add suggestions [Add suggestion, Administration, Edit source, Power user, Review strings, Translate]

Eliminar sugerencias [Administración]

Vote on suggestions [Administration, Edit source, Power user, Review strings, Translate]

Traducciones

Start new translation [Administration, Manage languages, Power user]

Perform automatic translation [Administration, Manage languages]

Delete existing translations [Administration, Manage languages]

Start translation into a new language [Administration, Manage languages]

Cargas

Definir autor/a de la traducción cargada [Administración]

Overwrite existing strings with an upload [Administration, Edit source, Power user, Review strings, Translate]

Upload translation strings [Administration, Edit source, Power user, Review strings, Translate]

Sistema de control de versiones

Access the internal repository [Access repository, Administration, Manage repository, Power user]

Commit changes to the internal repository [Administration, Manage repository]

Push change from the internal repository [Administration, Manage repository]

Reset changes in the internal repository [Administration, Manage repository]

View upstream repository location [Access repository, Administration, Manage repository, Power user]

Actualizar el repositorio interno [Administración, Gestionar repositorio]

Privilegios en todo el sitio

Utilizar interfaz de gestión

Añadir definiciones de idioma

Gestionar definiciones de idioma

Añadir grupos

Gestionar grupos

Añadir usuarios

Administrar usuarios

Gestionar anuncios

Gestionar memoria de traducción

Nota

The site wide privileges are not granted to any default role. These are powerful and quite close to the superuser status—most of them affect all the projects of your Weblate installation.

List of groups¶

The following groups are created upon installation (or after executing setupgroups):

Guests

Defines permissions for non authenticated users.

This group contains only anonymous users (see ANONYMOUS_USER_NAME).

You can remove roles from this group to limit permissions for non authenticated users.

Default roles: Add suggestion, Access repository

Viewers

This role ensures visibility of public projects for all users. By default all users are members of this group.

By default all users are members of this group, using Asignaciones de grupo automático.

Default roles: none

Users

Default group for all users.

By default all users are members of this group using Asignaciones de grupo automático.

Default roles: Power user

Reviewers

Group for reviewers (see Flujos de trabajo de traducción).

Default roles: Review strings

Managers

Group for administrators.

Default roles: Administration

Advertencia

Never remove the predefined Weblate groups and users, as this can lead to unexpected problems. If you do not want to use these features, just remove all privileges from them.

Proyectos de traducción¶

Organización de traducción¶

Weblate organiza el contenido traducible del sistema de control de versiones del proyecto o los componentes en una estructura semejante a un árbol.

The bottom level object is Configuración de proyectos, which should hold all translations belonging together (for example translation of an application in several versions and/or accompanying documentation).
On the level above, Configuración de componentes, which is actually the component to translate, you define the VCS repository to use, and the mask of files to translate.
Above Configuración de componentes there are individual translations, handled automatically by Weblate as translation files (which match the mask defined in Configuración de componentes) appear in the VCS repository.

Weblate supports a wide range of translation formats (both bilingual and monolingual ones) supported by Translate Toolkit, see Formatos de archivo admitidos.

Nota

You can share cloned VCS repositories using URL internos de Weblate. Using this feature is highly recommended when you have many components sharing the same VCS. It improves performance and decreases required disk space.

Añadir proyectos y componentes de traducción¶

Distinto en la versión 3.2: An interface for adding projects and components is included, and you no longer have to use La interfaz administrativa de Django.

Distinto en la versión 3.4: The process of adding components is now multi staged, with automated discovery of most parameters.

Based on your permissions, new translation projects and components can be created. It is always permitted for superusers, and if your instance uses billing (e.g. like https://hosted.weblate.org/ see Facturación), you can also create those based on your plans allowance from the user account that manages billing.

Puede ver su plan de facturación actual en una página separada:

The project creation can be initiated from there, or using the menu in the navigation bar, filling in basic info about the translation project to complete addition of it:

After creating the project, you are taken directly to the project page:

Creating a new translation component can be initiated via a single click there. The process of creating a component is multi-staged and automatically detects most translation parameters. There are several approaches to creating component:

Desde control de versiones: Crea el componente a partir de un repositorio de control de versiones remoto.
Desde componente existente: Creates additional component to existing one by choosing different files.
Rama adicional: Creates additional component to existing one, just for different branch.
Cargar archivos de traducción: Upload translation files to Weblate in case you do not have version control or do not want to integrate it with Weblate. You can later update the content using the web interface or API.
Traducir documento: Cargue un documento único y tradúzcalo.
Comenzar de cero: Create blank translation project and add strings manually.

Once you have existing translation components, you can also easily add new ones for additional files or branches using same repository.

Primero debe suplir el nombre y la ubicación del repositorio:

En la próxima página verá una lista de recursos traducibles descubiertos:

_images/user-add-component-discovery.png

Como último paso, revise la información del componente de traducción y supla datos opcionales:

Ver también

La interfaz administrativa de Django, Configuración de proyectos, Configuración de componentes

Configuración de proyectos¶

Create a translation project and then add a new component for translation in it. The project is like a shelf, in which real translations are stacked. All components in the same project share suggestions and their dictionary; the translations are also automatically propagated through all components in a single project (unless turned off in the component configuration), see Memory Management.

These basic attributes set up and inform translators of a project:

Nombre del proyecto¶

Verbose project name, used to display the project name.

«Slug» del proyecto¶

Project name suitable for URLs.

Sitio web del proyecto¶

URL where translators can find more info about the project.

Lista de correo¶

Mailing list where translators can discuss or comment translations.

Instrucciones de traducción¶

URL to more site with more detailed instructions for translators.

Set Language-Team header¶

Whether Weblate should manage the Language-Team header (this is a GNU gettext only feature right now).

Utilizar memoria de traducción compartida¶

Whether to use shared translation memory, see Memoria de traducción compartida for more details.

Contribuir a la memoria de traducción compartida¶

Whether to contribute to shared translation memory, see Memoria de traducción compartida for more details.

Control de acceso¶

Configure per project access control, see Control de acceso por proyecto for more details.

Default value can be changed by DEFAULT_ACCESS_CONTROL.

Activar revisiones¶

Enable review workflow for translations, see Revisores dedicados.

Activar revisiones de origen¶

Enable review workflow for source strings, see Source strings reviews.

Activar actuadores¶

Whether unauthenticated Actuadores de notificaciones are to be used for this repository.

Idioma del código fuente¶

Language used for source strings in all components. Change this if you are translating from something else than English.

Consejo

In case you are translating bilingual files from English, but want to be able to do fixes in the English translation as well, you might want to choose English (Developer) as a source language. To avoid conflict between name of the source language and existing translation.

For monolingual translations, you can use intermediate translation in this case, see Archivo de idioma intermediario.

Ver también

Archivo de idioma intermediario, Quality gateway for the source strings, Formatos bilingües y monolingües, Language definitions

Alias de idiomas¶

Defina una vinculación entre códigos de idioma durante la importación de traducciones en Weblate. Utilice esta función si los códigos de idioma son irregulares en sus repositorios y quiere obtener una visualización coherente en Weblate.

The typical use case might be mapping American English to English: en_US:en

Multiple mappings to be separated by comma: en_GB:en,en_US:en

Consejo

The language codes are mapped when matching the translation files and the matches are case sensitive, so make sure you use the source language codes in same form as used in the filenames.

Ver también

Parsing language codes

Configuración de componentes¶

A component is a grouping of something for translation. You enter a VCS repository location and file mask for which files you want translated, and Weblate automatically fetches from this VCS, and finds all matching translatable files.

You can find some examples of typical configurations in the Formatos de archivo admitidos.

Nota

Es aconsejable mantener un tamaño razonable para los componentes de traducción. Divídala en secciones que tengan sentido para su proyecto (por ejemplo, por aplicaciones o complementos, capítulos o sitios web).

Weblate puede manejar con facilidad traducciones de decenas de miles de cadenas, pero es más difícil distribuir el trabajo y coordinar los traductores al utilizar componentes de tales dimensiones.

Should the language definition for a translation be missing, an empty definition is created and named as «cs_CZ (generated)». You should adjust the definition and report this back to the Weblate authors, so that the missing languages can be included in next release.

The component contains all important parameters for working with the VCS, and for getting translations out of it:

Nombre de componente¶

Verbose component name, used to display the component name.

«Slug» del componente¶

Component name suitable for URLs.

Proyecto del componente¶

Configuración de proyectos where the component belongs.

Sistema de control de versiones¶

VCS to use, see Integración de control de versiones for details.

Repositorio de código fuente¶

VCS repository used to pull changes.

Ver también

See Accessing repositories for more details on specifying URLs.

Consejo

This can either be a real VCS URL or weblate://project/component indicating that the repository should be shared with another component. See URL internos de Weblate for more details.

URL de envío al repositorio¶

Repository URL used for pushing. This setting is used only for Git and Mercurial and push support is turned off for these when this is empty.

Ver también

See Accessing repositories for more details on how to specify a repository URL and Enviar cambios efectuados en Weblate for more details on pushing changes from Weblate.

Explorador del repositorio¶

URL of repository browser used to display source files (location of used messages). When empty, no such links will be generated. You can use Template markup.

For example on GitHub, use something like: https://github.com/WeblateOrg/hello/blob/{{branch}}/{{filename}}#L{{line}}

In case your paths are relative to different folder, you might want to strip leading directory by parentdir filter (see Template markup): https://github.com/WeblateOrg/hello/blob/{{branch}}/{{filename|parentdir}}#L{{line}}

URL de repositorio exportado¶

URL where changes made by Weblate are exported. This is important when Regionalización continua is not used, or when there is a need to manually merge changes. You can use Git exporter to automate this for Git repositories.

Rama del repositorio¶

Which branch to checkout from the VCS, and where to look for translations.

Rama a la que enviar¶

Branch for pushing changes, leave empty to use Rama del repositorio.

Nota

This is currently only supported for Git and GitHub, it is ignored for other VCS integrations.

File mask¶

Mask of files to translate, including path. It should include one «*» replacing language code (see Language definitions for info on how this is processed). In case your repository contains more than one translation file (e.g. more gettext domains), you need to create a component for each of them.

For example po/*.po or locale/*/LC_MESSAGES/django.po.

In case your filename contains special characters such as [, ], these need to be escaped as [[] or []].

Ver también

Formatos bilingües y monolingües, What does mean «There are more files for the single language (en)»?

Archivo de base monolingüe¶

Base file containing string definitions for Componentes monolingües.

Ver también

Formatos bilingües y monolingües, What does mean «There are more files for the single language (en)»?

Editar archivo de base¶

Whether to allow editing the base file for Componentes monolingües.

Archivo de idioma intermediario¶

Intermediate language file for Componentes monolingües. In most cases this is a translation file provided by developers and is used when creating actual source strings.

When set, the source translation is based on this file, but all others are based on Archivo de base monolingüe. In case the string is not translated in source translation, translating to other languages is prohibited. This provides Quality gateway for the source strings.

Ver también

Quality gateway for the source strings, Formatos bilingües y monolingües, What does mean «There are more files for the single language (en)»?

Plantilla para traducciones nuevas¶

Base file used to generate new translations, e.g. .pot file with gettext.

Consejo

In many monolingual formats Weblate starts with blank file by default. Use this in case you want to have all strings present with empty value when creating new translation.

Ver también

Adding new translations, Adición de traducciones nuevas, Formatos bilingües y monolingües, What does mean «There are more files for the single language (en)»?

Formato de archivo¶

Translation file format, see also Formatos de archivo admitidos.

Source string bug report address¶

Email address used for reporting upstream bugs. This address will also receive notification about any source string comments made in Weblate.

Permitir propagación de traducciones¶

You can turn off propagation of translations to this component from other components within same project. This really depends on what you are translating, sometimes it’s desirable to have make use of a translation more than once.

It’s usually a good idea to turn this off for monolingual translations, unless you are using the same IDs across the whole project.

Default value can be changed by DEFAULT_TRANSLATION_PROPAGATION.

Activar sugerencias¶

Whether translation suggestions are accepted for this component.

Votar sugerencias¶

Turns on votecasting for suggestions, see Votar sugerencias.

Autoaceptar sugerencias¶

Automatically accept voted suggestions, see Votar sugerencias.

Indicadores de traducción¶

Customization of quality checks and other Weblate behavior, see Customizing behavior.

Comprobaciones forzosas¶

List of checks which can not be ignored, see Enforcing checks.

Licencia de la traducción¶

License of the translation (does not need to be the same as the source code license).

Acuerdo de contribuidor¶

Acuerdo de usuario que debe aprobarse antes de que un usuario pueda traducir este componente.

Adición de traducciones nuevas¶

How to handle requests for creation of new languages. Available options:

Contactar a responsables: User can select desired language and the project maintainers will receive a notification about this. It is up to them to add (or not) the language to the repository.
Apuntar a la URL con instrucciones de traducción: User is presented a link to page which describes process of starting new translations. Use this in case more formal process is desired (for example forming a team of people before starting actual translation).
Crear archivo de idioma nuevo: User can select language and Weblate automatically creates the file for it and translation can begin.
Desactivar adición de traducciones nuevas: There will be no option for user to start new translation.

Ver también

Adding new translations.

Estilo de código de idioma¶

Customize language code used to generate the filename for translations created by Weblate, see Adding new translations for more details.

Estilo de fusión¶

You can configure how updates from the upstream repository are handled. This might not be supported for some VCSs. See Fusionar o cambiar base for more details.

Default value can be changed by DEFAULT_MERGE_STYLE.

Commit, add, delete, merge and addon messages¶

Message used when committing a translation, see Template markup.

Default value can be changed by DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE.

Nombre de consignante¶

Name of the committer used for Weblate commits, the author will always be the real translator. On some VCSs this might be not supported.

Default value can be changed by DEFAULT_COMMITER_NAME.

Correo electrónico de consignante¶

Email of committer used for Weblate commits, the author will always be the real translator. On some VCSs this might be not supported. The default value can be changed in DEFAULT_COMMITER_EMAIL.

Enviar al consignar¶

Whether committed changes should be automatically pushed to the upstream repository. When enabled, the push is initiated once Weblate commits changes to its internal repository (see Consignas diferidas). To actually enable pushing Repository push URL has to be configured as well.

Antigüedad de cambios por consignar¶

Sets how old changes (in hours) are to get before they are committed by background task or commit_pending management command. All changes in a component are committed once there is at least one older than this period.

Default value can be changed by COMMIT_PENDING_HOURS.

Bloquear al producirse un error¶

Enables locking the component on repository error (failed pull, push or merge). Locking in this situation avoids adding another conflict which would have to be resolved manually.

The component will be automatically unlocked once there are no repository errors left.

Filtro de idioma¶

Regular expression used to filter the translation when scanning for filemask. This can be used to limit the list of languages managed by Weblate.

Nota

You need to list language codes as they appear in the filename.

Some examples of filtering:

Descripción del filtro	Expresión regular
Solo los idiomas seleccionados	`^(cs\|de\|es)$`
Excluir idiomas	`^(?!(it\|fr)$).+$`
Excluir archivos no lingüísticos	`^(?!(blank)$).+$`
Incluir todos los archivos (predeterminado)	`^[^.]+$`

Expresión regular de variantes¶

Regular expression used to determine the variants of a string, see String variants.

Nota

Los propietarios y los gestores del proyecto pueden editar la mayoría de los demás campos, en la interfaz de Weblate.

Ver también

¿Weblate admite sistemas de control de versiones aparte de Git y Mercurial?, Translation component alerts

Prioridad¶

Se ofrecen primero a los traductores los componentes con mayor prioridad.

Acceso restringido¶

By default the component is visible to anybody who has access to the project, even if the person can not perform any changes in the component. This makes it easier to keep translation consistency within the project.

Enable this in case you want to grant access to this component explicitly - the project level permissions will not apply and you will have to specify component or component list level permission in order to grant access.

Default value can be changed by DEFAULT_RESTRICTED_COMPONENT.

Consejo

This applies to project managers as well - please make sure you will not loose access to the component after toggling the status.

Template markup¶

Weblate uses simple markup language in several places where text rendering is needed. It is based on The Django template language, so it can be quite powerful.

Currently it is used in:

Commit message formatting, see Configuración de componentes
Several addons

There following variables are available in the component templates:

{{ language_code }}: Código de idioma
{{ language_name }}: Nombre del idioma
{{ component_name }}: Nombre de componente
{{ component_slug }}: «Slug» del componente
{{ project_name }}: Nombre del proyecto
{{ project_slug }}: «Slug» del proyecto
{{ url }}: Translation URL
{{ filename }}: Nombre de archivo de traducción
{{ stats }}: Translation stats, this has further attributes, examples below.
{{ stats.all }}: Total strings count
{{ stats.fuzzy }}: Count of strings needing review
{{ stats.fuzzy_percent }}: Percent of strings needing review
{{ stats.translated }}: Translated strings count
{{ stats.translated_percent }}: Translated strings percent
{{ stats.allchecks }}: Number of strings with failing checks
{{ stats.allchecks_percent }}: Percent of strings with failing checks
{{ author }}: Author of current commit, available only in the commit scope.
{{ addon_name }}: Name of currently executed addon, available only in the addon commit message.

The following variables are available in the repository browser or editor templates:

{{branch}}: current branch
{{line}}: line in file
{{filename}}: filename, you can also strip leading parts using the parentdir filter, for example {{filename|parentdir}}

You can combine them with filters:

{{ component|title }}

You can use conditions:

{% if stats.translated_percent > 80 %}Well translated!{% endif %}

There is additional tag available for replacing characters:

{% replace component "-" " " %}

You can combine it with filters:

{% replace component|capfirst "-" " " %}

There are also additional filter to manipulate with filenames:

Directory of a file: {{ filename|dirname }}
File without extension: {{ filename|stripext }}
File in parent dir: {{ filename|parentdir }}
It can be used multiple times:  {{ filename|parentdir|parentdir }}

…and other Django template features.

Importing speed¶

Fetching VCS repository and importing translations to Weblate can be a lengthy process, depending on size of your translations. Here are some tips:

Optimize configuration¶

The default configuration is useful for testing and debugging Weblate, while for a production setup, you should do some adjustments. Many of them have quite a big impact on performance. Please check Production setup for more details, especially:

Configure Celery for executing background tasks (see Tareas en segundo plano con Celery)
Enable caching
Use a powerful database engine
Desactivar el modo de depuración

Check resource limits¶

If you are importing huge translations or repositories, you might be hit by resource limitations of your server.

Check the amount of free memory, having translation files cached by the operating system will greatly improve performance.
Disk operations might be bottleneck if there is a lot of strings to process—the disk is pushed by both Weblate and the database.
Additional CPU cores might help improve performance of background tasks (see Tareas en segundo plano con Celery).

Disable unneeded checks¶

Some quality checks can be quite expensive, and if not needed, can save you some time during import if omitted. See CHECK_LIST for info on configuration.

Creación automática de componentes¶

In case your project has dozen of translation files (e.g. for different gettext domains, or parts of Android apps), you might want to import them automatically. This can either be achieved from the command line by using import_project or import_json, or by installing the Descubrimiento de componentes addon.

To use the addon, you first need to create a component for one translation file (choose the one that is the least likely to be renamed or removed in future), and install the addon on this component.

For the management commands, you need to create a project which will contain all components and then run import_project or import_json.

Ver también

Órdenes de gestión, Descubrimiento de componentes

Language definitions¶

To present different translations properly, info about language name, text direction, plural definitions and language code is needed. Definitions for about 350 languages are included.

Parsing language codes¶

While parsing translations, Weblate attempts to map language code (usually the ISO 639-1 one) to any existing language object.

You can further adjust this mapping at project level by Alias de idiomas.

If no exact match can be found, an attempt will be made to best fit it into an existing language (e.g. ignoring the default country code for a given language—choosing cs instead of cs_CZ).

Should that also fail, a new language definition will be created using the defaults (left to right text direction, one plural) and naming of the language as xx_XX (generated). You might want to change this in the admin interface later, (see Changing language definitions) and report it to the issue tracker (see Contributing to Weblate).

Consejo

In case you see something unwanted as a language, you might want to adjust Filtro de idioma to ignore such file when parsing translations.

Changing language definitions¶

You can change language definitions in the languages interface (/languages/ URL).

While editing, make sure all fields are correct (especially plurals and text direction), otherwise translators will be unable to properly edit those translations.

Language definitions¶

Each language consists of following fields:

Código de idioma¶

Code identifying the language. Weblate prefers two letter codes as defined by ISO 639-1, but uses ISO 639-2 or ISO 639-3 codes for languages that do not have two letter code. It can also support extended codes as defined by BCP 47.

Ver también

Parsing language codes

Nombre del idioma¶

Visible name of the language. The language names included in Weblate are also being localized depending on user interface language.

Dirección del texto¶

Determines whether language is written right to left or left to right. This property is autodetected correctly for most of the languages.

Plural number¶

Number of plurals used in the language.

Fórmula de plurales¶

Gettext compatible plural formula used to determine which plural form is used for given count.

Ver también

Plurales, GNU gettext utilities: Plural forms, Language Plural Rules by the Unicode Consortium

Regionalización continua¶

There is infrastructure in place so that your translation closely follows development. This way translators can work on translations the entire time, instead of working through huge amount of new text just prior to release.

This is the process:

Developers make changes and push them to the VCS repository.
Optionally the translation files are updated (this depends on the file format, see Why does Weblate still show old translation strings when I’ve updated the template?).
Weblate pulls changes from the VCS repository, see Updating repositories.
Once Weblate detects changes in translations, translators are notified based on their subscription settings.
Translators submit translations using the Weblate web interface, or upload offline changes.
Once the translators are finished, Weblate commits the changes to the local repository (see Consignas diferidas) and pushes them back if it has permissions to do so (see Enviar cambios efectuados en Weblate).

Updating repositories¶

You should set up some way of updating backend repositories from their source.

Use Actuadores de notificaciones to integrate with most of common code hosting services
Manually trigger update either in the repository management or using API or Cliente de Weblate
Enable AUTO_UPDATE to automatically update all components on your Weblate instance
Execute updategit (with selection of project or –all to update all)

Whenever Weblate updates the repository, the post update addons will be triggered, see Complementos.

Avoiding merge conflicts¶

The merge conflicts from Weblate arise when same file was changed both in Weblate and outside it. There are two approaches to deal with that - avoid edits outside Weblate or integrate Weblate into your updating process, so that it flushes changes prior to updating the files outside Weblate.

The first approach is easy with monolingual files - you can add new strings within Weblate and leave whole editing of the files there. For bilingual files, there is usually some kind of message extraction process to generate translatable files from the source code. In some cases this can be split into two parts - one for the extraction generates template (for example gettext POT is generated using xgettext) and then further process merges it into actual translations (the gettext PO files are updated using msgmerge). You can perform the second step within Weblate and it will make sure that all pending changes are included prior to this operation.

The second approach can be achieved by using API to force Weblate to push all pending changes and lock the translation while you are doing changes on your side.

The script for doing updates can look like this:

# Lock Weblate translation
wlc lock
# Push changes from Weblate to upstream repository
wlc push
# Pull changes from upstream repository to your local copy
git pull
# Update translation files, this example is for Django
./manage.py makemessages --keep-pot -a
git commit -m 'Locale updates' -- locale
# Push changes to upstream repository
git push
# Tell Weblate to pull changes (not needed if Weblate follows your repo
# automatically)
wlc pull
# Unlock translations
wlc unlock

If you have multiple components sharing same repository, you need to lock them all separately:

wlc lock foo/bar
wlc lock foo/baz
wlc lock foo/baj

Nota

The example uses Cliente de Weblate, which needs configuration (API keys) to be able to control Weblate remotely. You can also achieve this using any HTTP client instead of wlc, e.g. curl, see API.

Recibir cambios automáticamente de GitHub¶

Weblate admite GitHub nativamente.

If you are using Hosted Weblate, the recommended approach is to install the Weblate app, that way you will get the correct setup without having to set much up. It can also be used for pushing changes back.

To receive notifications on every push to a GitHub repository, add the Weblate Webhook in the repository settings (Webhooks) as shown on the image below:

For the payload URL, append /hooks/github/ to your Weblate URL, for example for the Hosted Weblate service, this is https://hosted.weblate.org/hooks/github/.

You can leave other values at default settings (Weblate can handle both content types and consumes just the push event).

Ver también

POST /hooks/github/, Accessing repositories from Hosted Weblate

Recibir cambios automáticamente de Bitbucket¶

Weblate has support for Bitbucket webhooks, add a webhook which triggers upon repository push, with destination to /hooks/bitbucket/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/bitbucket/).

Ver también

POST /hooks/bitbucket/, Accessing repositories from Hosted Weblate

Automatically receiving changes from GitLab¶

Weblate has support for GitLab hooks, add a project webhook with destination to /hooks/gitlab/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitlab/).

Ver también

POST /hooks/gitlab/, Accessing repositories from Hosted Weblate

Recibir cambios automáticamente de Pagure¶

Nuevo en la versión 3.3.

Weblate has support for Pagure hooks, add a webhook with destination to /hooks/pagure/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/pagure/). This can be done in Activate Web-hooks under Project options:

Ver también

POST /hooks/pagure/, Accessing repositories from Hosted Weblate

Recibir cambios automáticamente de Azure Repos¶

Nuevo en la versión 3.8.

Weblate has support for Azure Repos web hooks, add a webhook for Code pushed event with destination to /hooks/azure/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/azure/). This can be done in Service hooks under Project settings.

Ver también

Web hooks in Azure DevOps manual, POST /hooks/azure/, Accessing repositories from Hosted Weblate

Recibir cambios automáticamente de Gitea¶

Nuevo en la versión 3.9.

Weblate has support for Gitea webhooks, add a Gitea Webhook for Push events event with destination to /hooks/gitea/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitea/). This can be done in Webhooks under repository Settings.

Ver también

Webhooks in Gitea manual, POST /hooks/gitea/, Accessing repositories from Hosted Weblate

Recibir cambios automáticamente de Gitee¶

Nuevo en la versión 3.9.

Weblate has support for Gitee webhooks, add a WebHook for Push event with destination to /hooks/gitee/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitee/). This can be done in WebHooks under repository Management.

Ver también

Webhooks in Gitee manual, POST /hooks/gitee/, Accessing repositories from Hosted Weblate

Automatically updating repositories nightly¶

Weblate automatically fetches remote repositories nightly to improve performance when merging changes later. You can optionally turn this into doing nightly merges as well, by enabling AUTO_UPDATE.

Enviar cambios efectuados en Weblate¶

Each translation component can have a push URL set up (see URL de envío al repositorio), and in that case Weblate will be able to push change to the remote repository. Weblate can be also be configured to automatically push changes on every commit (this is default, see Enviar al consignar). If you do not want changes to be pushed automatically, you can do that manually under Repository maintenance or using API via wlc push.

The push options differ based on the Integración de control de versiones used, more details are found in that chapter.

In case you do not want direct pushes by Weblate, there is support for GitHub, GitLab pull requests or Gerrit reviews, you can activate these by choosing GitHub, GitLab or Gerrit as Sistema de control de versiones in Configuración de componentes.

Overall, following options are available with Git, GitHub and GitLab:

Desired setup	Sistema de control de versiones	URL de envío al repositorio	Rama a la que enviar
No push	Git	empty	empty
Enviar directamente	Git	URL SSH	empty
Enviar en una rama separada	Git	URL SSH	Nombre de la rama
GitHub pull request from fork	GitHub	empty	empty
GitHub pull request from branch	GitHub	SSH URL 1	Nombre de la rama
GitLab merge request from fork	GitLab	empty	empty
GitLab merge request from branch	GitLab	SSH URL 1	Nombre de la rama

1(1,2): Can be empty in case Repositorio de código fuente supports pushing.

Nota

You can also enable automatic pushing of changes after Weblate commits, this can be done in Enviar al consignar.

Ver también

See Accessing repositories for setting up SSH keys, and Consignas diferidas for info about when Weblate decides to commit changes.

Ramas protegidas¶

If you are using Weblate on protected branch, you can configure it to use pull requests and perform actual review on the translations (what might be problematic for languages you do not know). An alternative approach is to waive this limitation for the Weblate push user.

For example on GitHub this can be done in the repository configuration:

Fusionar o cambiar base¶

By default, Weblate merges the upstream repository into its own. This is the safest way in case you also access the underlying repository by other means. In case you don’t need this, you can enable rebasing of changes on upstream, which will produce a history with fewer merge commits.

Nota

Rebasing can cause you trouble in case of complicated merges, so carefully consider whether or not you want to enable them.

Interactuar con otros¶

Weblate makes it easy to interact with others using its API.

Ver también

API

Consignas diferidas¶

The behaviour of Weblate is to group commits from the same author into one commit if possible. This greatly reduces the number of commits, however you might need to explicitly tell it to do the commits in case you want to get the VCS repository in sync, e.g. for merge (this is by default allowed for the Managers group, see Control de acceso).

Los cambios en esta modalidad se consignan una vez que cualquiera de estas condiciones se cumpla:

Alguien más modifica una cadena ya modificada.
Se produce una fusión desde el origen ascendente.
Se solicita explícitamente una consigna.
Change is older than period defined as Age of changes to commit on Configuración de componentes.

Consejo

Commits are created for every component. So in case you have many components you will still see lot of commits. You might utilize Concentrar consignas de Git addon in that case.

If you want to commit changes more frequently and without checking of age, you can schedule a regular task to perform a commit:

CELERY_BEAT_SCHEDULE = {
    # Unconditionally commit all changes every 2 minutes
    "commit": {
        "task": "weblate.trans.tasks.commit_pending",
        # Ommiting hours will honor per component settings,
        # otherwise components with no changes older than this
        # won't be committed
        "kwargs": {"hours": 0},
        # How frequently to execute the job in seconds
        "schedule": 120,
    }
}

Procesar el repositorio con secuencias¶

The way to customize how Weblate interacts with the repository is Complementos. Consult Executing scripts from addon for info on how to execute external scripts through addons.

Mantener iguales las traducciones entre los componentes¶

Once you have multiple translation components, you might want to ensure that the same strings have same translation. This can be achieved at several levels.

Propagación de traducciones¶

With translation propagation enabled (what is the default, see Configuración de componentes), all new translations are automatically done in all components with matching strings. Such translations are properly credited to currently translating user in all components.

Nota

The translation propagation requires the key to be match for monolingual translation formats, so keep that in mind when creating translation keys.

Comprobación de coherencia¶

The Incoherente check fires whenever the strings are different. You can utilize this to review such differences manually and choose the right translation.

Traducción automática¶

Automatic translation based on different components can be way to synchronize the translations across components. You can either trigger it manually (see Traducción automática) or make it run automatically on repository update using addon (see Traducción automática).

Licensing translations¶

You can specify which license translations are contributed under. This is especially important to do if translations are open to the public, to stipulate what they can be used for.

You should specify Configuración de componentes license info. You should avoid requiring a contributor license agreement, though it is possible.

License info¶

Upon specifying license info (license name and URL), this info is shown in the translation info section of the respective Configuración de componentes.

Usually this is best place to post licensing info if no explicit consent is required. If your project or translation is not libre you most probably need prior consent.

Acuerdo de contribuidor¶

If you specify a contributor license agreement, only users who have agreed to it will be able to contribute. This is a clearly visible step when accessing the translation:

The entered text is formatted into paragraphs and external links can be included. HTML markup can not be used.

User licenses¶

Any user can review all translation licenses of all public projects on the instance from their profile:

Proceso de traducción¶

Votar sugerencias¶

Everyone can add suggestions by default, to be accepted by signed in users. Suggestion voting can be used to make use of a string when more than signed in user agrees, by setting up the Configuración de componentes configuration with Suggestion voting to turn on voting, and Autoaccept suggestions to set a threshold for accepted suggestions (this includes a vote from the user making the suggestion if it is cast).

Nota

Once automatic acceptance is set up, normal users lose the privilege to directly save translations or accept suggestions. This can be overridden with the Can override suggestion state privilege (see Control de acceso).

You can combine these with Control de acceso into one of the following setups:

Users suggest and vote for suggestions and a limited group controls what is accepted. - Turn on voting. - Turn off automatic acceptance. - Don’t let users save translations.
Users suggest and vote for suggestions with automatic acceptance once the defined number of them agree. - Turn on voting. - Set the desired number of votes for automatic acceptance.
Optional voting for suggestions. (Can optionally be used by users when they are unsure about a translation by making multiple suggestions.) - Only turn on voting.

Información adicional sobre las cadenas de origen¶

Enhance the translation process with info available in the translation files. This includes explanation, string priority, check flags, or providing visual context. All these features can be set in the Reviewing strings:

Access this directly from the translation interface by clicking the «Edit» icon next to Screenshot context or Flags.

Priorización de cadenas¶

Nuevo en la versión 2.0.

String priority can be changed to offer higher priority strings for translation earlier by using the priority flag

Consejo

This can be used to order the flow of translation in a logical manner.

Ver también

Quality checks

Indicadores de traducción¶

Nuevo en la versión 2.4.

Distinto en la versión 3.3: Previously called Quality checks flags, it no longer configures only checks.

The default set of translation flags is determined by the translation Configuración de componentes and the translation file. However, you might want to use it to customize this per source string.

Ver también

Quality checks

Explicación¶

Distinto en la versión 4.1: En versiones anteriores, esta prestación se denominaba «contexto adicional».

Utilice la explicación para aclarar el ámbito o la utilización de la traducción. Puede utilizar Markdown para incluir enlaces y dar formato.

Contexto visual para cadenas¶

Nuevo en la versión 2.9.

You can upload a screenshot showing a given source string in use within your program. This helps translators understand where it is used, and how it should be translated.

La captura cargada se muestra en la barra lateral de contexto de la traducción:

In addition to Reviewing strings, screenshots have a separate management interface under the Tools menu. Upload screenshots, assign them to source strings manually, or use optical character recognition to do so.

Once a screenshot is uploaded, this interface handles management and source string association:

Comprobaciones y correcciones¶

Custom automatic fixups¶

You can also implement your own automatic fixup in addition to the standard ones and include them in AUTOFIX_LIST.

The automatic fixes are powerful, but can also cause damage; be careful when writing one.

For example, the following automatic fixup would replace every occurrence of the string foo in a translation with bar:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#

from django.utils.translation import gettext_lazy as _

from weblate.trans.autofixes.base import AutoFix


class ReplaceFooWithBar(AutoFix):
    """Replace foo with bar."""

    name = _("Foobar")

    def fix_single_target(self, target, source, unit):
        if "foo" in target:
            return target.replace("foo", "bar"), True
        return target, False

To install custom checks, provide a fully-qualified path to the Python class in the AUTOFIX_LIST, see Comprobaciones de calidad, complementos y correcciones automáticas personalizadas.

Customizing behavior¶

You can fine-tune the behavior of Weblate (mostly checks) for each source string (in source strings review, see Información adicional sobre las cadenas de origen) or in the Configuración de componentes (Indicadores de traducción). Some file formats also allow to specify flags directly in the format (see Formatos de archivo admitidos).

The flags are comma-separated, the parameters are separated with colon. You can use quotes to include whitespace or special chars in the string. For example:

placeholders:"special:value":"other value", regex:.*

Here is a list of flags currently accepted:

rst-text: Treat a text as an RST document, affects Traducción no modificada.
md-text: Treat text as a Markdown document.
dos-eol: Uses DOS end-of-line markers instead of Unix ones (\r\n instead of \n).
url: The string should consist of only a URL.
safe-html: The string should be HTML safe, see HTML inseguro.
read-only: The string is read-only and should not be edited in Weblate, see Cadenas de solo lectura.
priority:N: Priority of the string. Higher priority strings are presented first for translation. The default priority is 100, the higher priority a string has, the earlier it is offered for translation.
max-length:N: Limit the maximal length for a string to N characters, see Longitud máxima de la traducción
xml-text: Treat text as XML document, affects Sintaxis XML and Marcado XML.
font-family:NAME: Define font-family for rendering checks, see Managing fonts.
font-weight:WEIGHT: Define font-weight for rendering checks, see Managing fonts.
font-size:SIZE: Define font-size for rendering checks, see Managing fonts.
font-spacing:SPACING: Define font-spacing for rendering checks, see Managing fonts.
placeholders:NAME: Placeholder strings expected in translation, see Sustitutorios.
replacements:FROM:TO:FROM2:TO2...`: Replacements to perform when checking resulting text parameters (for example in Tamaño máximo de la traducción or Longitud máxima de la traducción). The typical use case for this is to expand placeables to ensure that the text fits even with long names, for example: replacements:%s:"John Doe".
regex:REGEX: Expresión regular utilizada para relacionar traducciones; vea Expresión regular.
python-format, c-format, php-format, python-brace-format, javascript-format, c-sharp-format, java-format, java-messageformat, auto-java-messageformat, qt-format, qt-plural-format y ruby-format: Treats all strings like format strings, affects Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Traducción no modificada.
strict-same: Hace que «Traducción no modificada» evite la lista de palabras incorporada; vea Traducción no modificada.
ignore-bbcode: Skip the «BBcode markup» quality check.
ignore-duplicate: Skip the «Consecutive duplicated words» quality check.
ignore-double-space: Skip the «Double space» quality check.
ignore-angularjs-format: Skip the «AngularJS interpolation string» quality check.
ignore-c-format: Skip the «C format» quality check.
ignore-c-sharp-format: Skip the «C# format» quality check.
ignore-es-format: Pasa por alto la comprobación de calidad «Literales de plantilla ECMAScript».
ignore-i18next-interpolation: Skip the «i18next interpolation» quality check.
ignore-java-format: Skip the «Java format» quality check.
ignore-java-messageformat: Skip the «Java MessageFormat» quality check.
ignore-javascript-format: Skip the «JavaScript format» quality check.
ignore-percent-placeholders: Skip the «Percent placeholders» quality check.
ignore-perl-format: Skip the «Perl format» quality check.
ignore-php-format: Skip the «PHP format» quality check.
ignore-python-brace-format: Skip the «Python brace format» quality check.
ignore-python-format: Skip the «Python format» quality check.
ignore-qt-format: Skip the «Qt format» quality check.
ignore-qt-plural-format: Skip the «Qt plural format» quality check.
ignore-ruby-format: Skip the «Ruby format» quality check.
ignore-translated: Skip the «Has been translated» quality check.
ignore-inconsistent: Skip the «Inconsistent» quality check.
ignore-kashida: Skip the «Kashida letter used» quality check.
ignore-md-link: Pasa por alto la comprobación de calidad «Enlaces de Markdown».
ignore-md-reflink: Skip the «Markdown references» quality check.
ignore-md-syntax: Skip the «Markdown syntax» quality check.
ignore-max-length: Skip the «Maximum length of translation» quality check.
ignore-max-size: Skip the «Maximum size of translation» quality check.
ignore-escaped-newline: Skip the «Mismatched n» quality check.
ignore-end-colon: Pasa por alto la comprobación de calidad «Dos puntos desiguales».
ignore-end-ellipsis: Pasa por alto la comprobación de calidad «Puntos suspensivos desiguales».
ignore-end-exclamation: Pasa por alto la comprobación de calidad «Signo de exclamación desigual».
ignore-end-stop: Pasa por alto la comprobación de calidad «Punto final desigual».
ignore-end-question: Pasa por alto la comprobación de calidad «Signo de interrogación desigual».
ignore-end-semicolon: Pasa por alto la comprobación de calidad «Punto y coma desigual».
ignore-newline-count: Skip the «Mismatching line breaks» quality check.
ignore-plurals: Skip the «Missing plurals» quality check.
ignore-placeholders: Skip the «Placeholders» quality check.
ignore-punctuation-spacing: Skip the «Punctuation spacing» quality check.
ignore-regex: Skip the «Regular expression» quality check.
ignore-same-plurals: Skip the «Same plurals» quality check.
ignore-begin-newline: Skip the «Starting newline» quality check.
ignore-begin-space: Skip the «Starting spaces» quality check.
ignore-end-newline: Skip the «Trailing newline» quality check.
ignore-end-space: Skip the «Trailing space» quality check.
ignore-same: Skip the «Unchanged translation» quality check.
ignore-safe-html: Skip the «Unsafe HTML» quality check.
ignore-url: Skip the «URL» quality check.
ignore-xml-tags: Skip the «XML markup» quality check.
ignore-xml-invalid: Skip the «XML syntax» quality check.
ignore-zero-width-space: Skip the «Zero-width space» quality check.
ignore-ellipsis: Skip the «Ellipsis» quality check.
ignore-long-untranslated: Skip the «Long untranslated» quality check.
ignore-multiple-failures: Skip the «Multiple failing checks» quality check.
ignore-unnamed-format: Skip the «Multiple unnamed variables» quality check.
ignore-optional-plural: Skip the «Unpluralised» quality check.

Nota

Generally the rule is named ignore-* for any check, using its identifier, so you can use this even for your custom checks.

These flags are understood both in Configuración de componentes settings, per source string settings and in the translation file itself (for example in GNU gettext).

Enforcing checks¶

Nuevo en la versión 3.11.

You can configure a list of checks which can not be ignored by setting Enforced checks in Configuración de componentes. Each listed check can not be ignored in the user interface and any string failing this check is marked as Needs editing (see Translation states).

Managing fonts¶

Nuevo en la versión 3.7.

The Tamaño máximo de la traducción check used to calculate dimensions of the rendered text needs font info to be selected, which can be done in the Weblate font management tool in Fonts under the Manage menu of your translation project.

TrueType or OpenType fonts can be uploaded, set up font-groups and use those in the check.

The font-groups allow you to define different fonts for different languages, which is typically needed for non-latin languages:

The font-groups are identified by name, which can not contain whitespace or special characters, so that it can be easily used in the check definition:

Font-family and style is automatically recognized after uploading them:

You can have a number of fonts loaded into Weblate:

To use the fonts for checking the string length, pass it the appropriate flags (see Customizing behavior). You will probably need the following ones:

max-size:500: Defines maximal width.
font-family:ubuntu: Defines font group to use by specifying its identifier.
font-size:22: Defines font size.

Writing own checks¶

A wide range of quality checks are built-in, (see Quality checks), though they might not cover everything you want to check. The list of performed checks can be adjusted using CHECK_LIST, and you can also add custom checks.

Subclass the weblate.checks.Check
Defina algunos atributos.
Implement either the check (if you want to deal with plurals in your code) or the check_single method (which does it for you).

He aquí algunos ejemplos:

To install custom checks, provide a fully-qualified path to the Python class in the CHECK_LIST, see Comprobaciones de calidad, complementos y correcciones automáticas personalizadas.

Checking translation text does not contain «foo»¶

Esta es una comprobación bastante simple que se limita a revisar si a la traducción le falta la cadena «tal».

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Simple quality check example."""

from django.utils.translation import gettext_lazy as _

from weblate.checks.base import TargetCheck


class FooCheck(TargetCheck):

    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    name = _("Foo check")

    # Description for failing check
    description = _("Your translation is foo")

    # Real check code
    def check_single(self, source, target, unit):
        return "foo" in target

Checking that Czech translation text plurals differ¶

Comprobación que utiliza la información de idioma para cerciorarse de que las dos formas de plural en checo no sean iguales.

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Quality check example for Czech plurals."""

from django.utils.translation import gettext_lazy as _

from weblate.checks.base import TargetCheck


class PluralCzechCheck(TargetCheck):

    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    name = _("Foo check")

    # Description for failing check
    description = _("Your translation is foo")

    # Real check code
    def check_target_unit(self, sources, targets, unit):
        if self.is_language(unit, ("cs",)):
            return targets[1] == targets[2]
        return False

    def check_single(self, source, target, unit):
        """We don't check target strings here."""
        return False

Traducción automática¶

Built-in support for several machine translation services and can be turned on by the administrator using MT_SERVICES for each one. They come subject to their terms of use, so ensure you are allowed to use them how you want.

The source language can be configured at Configuración de proyectos.

amaGama¶

Special installation of tmserver run by the authors of Virtaal.

Turn on this service by adding weblate.machinery.tmserver.AmagamaTranslation to MT_SERVICES.

Ver también

Installing amaGama, Amagama, amaGama Translation Memory

Apertium¶

A libre software machine translation platform providing translations to a limited set of languages.

The recommended way to use Apertium is to run your own Apertium-APy server.

Turn on this service by adding weblate.machinery.apertium.ApertiumAPYTranslation to MT_SERVICES and set MT_APERTIUM_APY.

Ver también

MT_APERTIUM_APY, Apertium website, Apertium APy documentation

AWS¶

Nuevo en la versión 3.1.

Amazon Translate is a neural machine translation service for translating text to and from English across a breadth of supported languages.

1. Turn on this service by adding weblate.machinery.aws.AWSTranslation to MT_SERVICES.

Install the boto3 module.
Configure Weblate.

Ver también

MT_AWS_REGION, MT_AWS_ACCESS_KEY_ID, MT_AWS_SECRET_ACCESS_KEY Amazon Translate Documentation

Baidu API machine translation¶

Nuevo en la versión 3.2.

Machine translation service provided by Baidu.

This service uses an API and you need to obtain an ID and API key from Baidu to use it.

Turn on this service by adding weblate.machinery.baidu.BaiduTranslation to MT_SERVICES and set MT_BAIDU_ID and MT_BAIDU_SECRET.

Ver también

MT_BAIDU_ID, MT_BAIDU_SECRET Baidu Translate API

DeepL¶

Nuevo en la versión 2.20.

DeepL is paid service providing good machine translation for a few languages. You need to purchase DeepL API subscription or you can use legacy DeepL Pro (classic) plan.

Turn on this service by adding weblate.machinery.deepl.DeepLTranslation to MT_SERVICES and set MT_DEEPL_KEY.

Consejo

In case you have subscription for CAT tools, you are supposed to use «v1 API» instead of default «v2» used by Weblate (it is not really an API version in this case). You can toggle this by MT_DEEPL_API_VERSION.

Ver también

MT_DEEPL_KEY, MT_DEEPL_API_VERSION, DeepL website, DeepL pricing, DeepL API documentation

Glosbe¶

Free dictionary and translation memory for almost every living language.

The API is gratis to use, but subject to the used data source license. There is a limit of calls that may be done from one IP in a set period of time, to prevent abuse.

Turn on this service by adding weblate.machinery.glosbe.GlosbeTranslation to MT_SERVICES.

Ver también

Glosbe website

Google Translate¶

Machine translation service provided by Google.

This service uses the Google Translation API, and you need to obtain an API key and turn on billing in the Google API console.

To turn on this service, add weblate.machinery.google.GoogleTranslation to MT_SERVICES and set MT_GOOGLE_KEY.

Ver también

MT_GOOGLE_KEY, Google translate documentation

Google Translate API V3 (Advanced)¶

Machine translation service provided by Google Cloud services.

This service differs from the former one in how it authenticates. To enable service, add weblate.machinery.googlev3.GoogleV3Translation to MT_SERVICES and set

MT_GOOGLE_CREDENTIALS

MT_GOOGLE_PROJECT

If location fails, you may also need to specify MT_GOOGLE_LOCATION.

Ver también

MT_GOOGLE_CREDENTIALS, MT_GOOGLE_PROJECT, MT_GOOGLE_LOCATION Google translate documentation

Microsoft Cognitive Services Translator¶

Nuevo en la versión 2.10.

Machine translation service provided by Microsoft in Azure portal as a one of Cognitive Services.

Weblate implements Translator API V3.

To enable this service, add weblate.machinery.microsoft.MicrosoftCognitiveTranslation to MT_SERVICES and set MT_MICROSOFT_COGNITIVE_KEY.

Translator Text API V2¶

The key you use with Translator API V2 can be used with API 3.

Translator Text API V3¶

You need to register at Azure portal and use the key you obtain there. With new Azure keys, you also need to set MT_MICROSOFT_REGION to locale of your service.

Ver también

MT_MICROSOFT_COGNITIVE_KEY, MT_MICROSOFT_REGION, Cognitive Services - Text Translation API, Microsoft Azure Portal

Microsoft Terminology Service¶

Nuevo en la versión 2.19.

The Microsoft Terminology Service API allows you to programmatically access the terminology, definitions and user interface (UI) strings available in the Language Portal through a web service.

Turn this service on by adding weblate.machinery.microsoftterminology.MicrosoftTerminologyService to MT_SERVICES.

Ver también

Microsoft Terminology Service API

ModernMT¶

Nuevo en la versión 4.2.

Turn this service on by adding weblate.machinery.modernmt.ModernMTTranslation to MT_SERVICES and configure MT_MODERNMT_KEY.

Ver también

ModernMT API, MT_MODERNMT_KEY, MT_MODERNMT_URL

MyMemory¶

Huge translation memory with machine translation.

Free, anonymous usage is currently limited to 100 requests/day, or to 1000 requests/day when you provide a contact e-mail address in MT_MYMEMORY_EMAIL. You can also ask them for more.

Turn on this service by adding weblate.machinery.mymemory.MyMemoryTranslation to MT_SERVICES and set MT_MYMEMORY_EMAIL.

Ver también

MT_MYMEMORY_EMAIL, MT_MYMEMORY_USER, MT_MYMEMORY_KEY, MyMemory website

NetEase Sight API machine translation¶

Nuevo en la versión 3.3.

Machine translation service provided by Netease.

This service uses an API, and you need to obtain key and secret from NetEase.

Turn on this service by adding weblate.machinery.youdao.NeteaseSightTranslation to MT_SERVICES and set MT_NETEASE_KEY and MT_NETEASE_SECRET.

Ver también

MT_NETEASE_KEY, MT_NETEASE_SECRET Netease Sight Translation Platform

tmserver¶

You can run your own translation memory server by using the one bundled with Translate-toolkit and let Weblate talk to it. You can also use it with an amaGama server, which is an enhanced version of tmserver.

First you will want to import some data to the translation memory:

2. Turn on this service by adding weblate.machinery.tmserver.TMServerTranslation to MT_SERVICES.

build_tmdb -d /var/lib/tm/db -s en -t cs locale/cs/LC_MESSAGES/django.po
build_tmdb -d /var/lib/tm/db -s en -t de locale/de/LC_MESSAGES/django.po
build_tmdb -d /var/lib/tm/db -s en -t fr locale/fr/LC_MESSAGES/django.po

Start tmserver to listen to your requests:

tmserver -d /var/lib/tm/db

Configure Weblate to talk to it:

MT_TMSERVER = 'http://localhost:8888/tmserver/'

Ver también

MT_TMSERVER, tmserver Installing amaGama, Amagama, Amagama Translation Memory

Yandex Translate¶

Machine translation service provided by Yandex.

This service uses a Translation API, and you need to obtain an API key from Yandex.

Turn on this service by adding weblate.machinery.yandex.YandexTranslation to MT_SERVICES, and set MT_YANDEX_KEY.

Ver también

MT_YANDEX_KEY, Yandex Translate API, Powered by Yandex.Translate

Youdao Zhiyun API machine translation¶

Nuevo en la versión 3.2.

El servicio de traducciones automáticas lo brinda Youdao.

Este servicio utiliza una API; habrá de obtener un identificador y una clave de API de Youdao.

Turn on this service by adding weblate.machinery.youdao.YoudaoTranslation to MT_SERVICES and set MT_YOUDAO_ID and MT_YOUDAO_SECRET.

Ver también

MT_YOUDAO_ID, MT_YOUDAO_SECRET Youdao Zhiyun Natural Language Translation Service

Weblate¶

Weblate can be the source of machine translations as well. It is based on the Woosh fulltext engine, and provides both exact and inexact matches.

Turn on these services by adding weblate.machinery.weblatetm.WeblateTranslation to MT_SERVICES.

Weblate Translation Memory¶

Nuevo en la versión 2.20.

The Memoria de traducción can be used as a source for machine translation suggestions as well.

Turn on these services by adding weblate.memory.machine.WeblateMemory to the MT_SERVICES. This service is turned on by default.

SAP Translation Hub¶

Machine translation service provided by SAP.

You need to have a SAP account (and enabled the SAP Translation Hub in the SAP Cloud Platform) to use this service.

Turn on this service by adding weblate.machinery.saptranslationhub.SAPTranslationHub to MT_SERVICES and set the appropriate access to either sandbox or the productive API.

Nota

To access the Sandbox API, you need to set MT_SAP_BASE_URL and MT_SAP_SANDBOX_APIKEY.

To access the productive API, you need to set MT_SAP_BASE_URL, MT_SAP_USERNAME and MT_SAP_PASSWORD.

Ver también

MT_SAP_BASE_URL, MT_SAP_SANDBOX_APIKEY, MT_SAP_USERNAME, MT_SAP_PASSWORD, MT_SAP_USE_MT SAP Translation Hub API

Traducción automática personalizada¶

You can also implement your own machine translation services using a few lines of Python code. This example implements machine translation in a fixed list of languages using dictionary Python module:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Machine translation example."""

import dictionary

from weblate.machinery.base import MachineTranslation


class SampleTranslation(MachineTranslation):
    """Sample machine translation interface."""

    name = "Sample"

    def download_languages(self):
        """Return list of languages your machine translation supports."""
        return {"cs"}

    def download_translations(self, source, language, text, unit, user, search):
        """Return tuple with translations."""
        for t in dictionary.translate(text):
            yield {"text": t, "quality": 100, "service": self.name, "source": text}

You can list own class in MT_SERVICES and Weblate will start using that.

Complementos¶

Nuevo en la versión 2.19.

Addons provide ways to customize translation workflow. They can be installed in the translation component view, and work behind the scenes. Addon management is available from the Manage ↓ Addons menu of each respective translation component for admins.

Built-in addons¶

Traducción automática¶

Nuevo en la versión 3.9.

Traduce automáticamente las cadenas mediante traducción automática u otros componentes.

This addon is triggered automatically when new strings appear in a component.

Ver también

Traducción automática, Mantener iguales las traducciones entre los componentes

CDN de regionalización de JavaScript¶

Nuevo en la versión 4.2.

Añade un CDN para la regionalización de JavaScript o HTML.

It can be used to localize static HTML pages or used to load localization in the JavaScript code.

Upon installation the addon generates unique URL for your component which you can include in the HTML documents to get them localized. See Translating HTML and JavaScript using Weblate CDN for more details.

Ver también

Configuring Weblate CDN addon, Translating HTML and JavaScript using Weblate CDN, String extraction for Weblate CDN, HTML localization using Weblate CDN

Limpieza de archivos de traducción¶

Actualice todos los archivos de traducción para que coincidan con el archivo base monolingüe. Para la mayoría de los formatos de archivo, esto significa quitar las claves de traducción obsoletas que ya no están presentes en el archivo base.

Consistencia del idioma¶

Garantiza que todos los componentes de un proyecto tengan traducciones en todos los idiomas añadidos para traducción.

It creates empty translations in languages that have unadded components.

Missing languages are checked once every 24 hours and when a new language is added in Weblate.

Unlike most others, this addon affects the whole project.

Consejo

Auto-translate the newly added strings with Traducción automática.

Descubrimiento de componentes¶

Añade o quita automáticamente componentes del proyecto en función de los cambios de los archivos en el sistema de control de versiones.

It is triggered on every VCS update, and otherwise similar to the import_project management command. This way you can track multiple translation components within one VCS.

Create one main component least likely to disappear in the future, and others will employ URL internos de Weblate to it as a VCS configuration, and configure it to find all components in it.

The matching is done using regular expressions, where power is a tradeoff for complexity in configuration. Some examples for common use cases can be found in the addon help section.

Once you hit Save, a preview of matching components will be presented, from where you can check whether the configuration actually matches your needs:

Ver también

Template markup

Edición en masa¶

Nuevo en la versión 3.11.

Edite indicadores, etiquetas o estados de manera masiva.

Automating the labeling of new strings can be useful (start out with search query NOT has:label and add desired labels till all strings are properly labeled). You can also carry out any other automated operations for Weblate metadata.

Ver también

Edición en masa

Marcar traducciones sin cambios como «Necesitan edición»¶

Nuevo en la versión 3.1.

Cada vez que se importa una cadena traducible nueva desde el VCS y corresponde a una cadena de origen, se marca como necesaria la edición en Weblate. Esto es útil sobre todo para aquellos formatos de archivo que incluyen todas las cadenas, incluso las no traducidas.

Marcar cadenas de origen nuevas como «Necesitan edición»¶

Cuando se importa una cadena de origen nueva desde el VCS, se marca como necesaria la edición en Weblate. De esta manera usted puede filtrar y editar cadenas de origen escritas por los desarrolladores con facilidad.

Marcar traducciones nuevas como «Necesitan edición»¶

Cuando se importa una cadena traducible nueva desde el VCS, se marca como necesaria la edición en Weblate. De esta manera usted puede filtrar y editar las traducciones creadas por los desarrolladores con facilidad.

Generador de estadísticas¶

Genera un archivo con información detallada sobre la traducción.

You can use Django template in both filename and content, see Template markup for a detailed markup description.

For example generating summary file for each translation:

Nombre del archivo generado

locale/{{ language_code }}.json

Content

{
   "language": "{{ language_code }}",
   "strings": "{{ stats.all }}",
   "translated": "{{ stats.translated }}",
   "last_changed": "{{ stats.last_changed }}",
   "last_author": "{{ stats.last_author }}",
}

Ver también

Template markup

Contribuidores en comentarios¶

Actualiza el comentario en la cabecera del archivo PO para incluir los nombres de los contribuidores y los años de las contribuciones.

The PO file header will contain a list of contributors and years contributed:

# Michal Čihař <michal@cihar.com>, 2012, 2018, 2019, 2020.
# Pavel Borecki <pavel@example.com>, 2018, 2019.
# Filip Hron <filip@example.com>, 2018, 2019.
# anonymous <noreply@weblate.org>, 2019.

Actualizar variable ALL_LINGUAS en el archivo «configure»¶

Updates the ALL_LINGUAS variable in configure, configure.in or any configure.ac files, when a new translation is added.

Personalizar la salida de gettext¶

Permite la personalización del comportamiento de salida de gettext, por ejemplo, ajuste de líneas.

It offers the following options:

Wrap lines at 77 characters and at newlines
Ajustar renglones únicamente en los saltos
No ajustar renglones

Nota

By default gettext wraps lines at 77 characters and for newlines. With the --no-wrap parameter, it wraps only at newlines.

Actualizar archivo LINGUAS¶

Actualiza el archivo LINGUAS al añadir una traducción nueva.

Generar archivos MO¶

Genera automáticamente un archivo MO por cada archivo PO modificado.

Actualizar archivos PO para que coincidan con POT (msgmerge)¶

Actualiza todos los archivos PO para que coincidan con el archivo POT usando msgmerge. Esto se activa cada vez que se extraen nuevos cambios del repositorio original.

Concentrar consignas de Git¶

Concentrar las consignas de Git antes de enviar los cambios.

You can choose one of following modes:

Nuevo en la versión 3.4.

Todas las consignas en una sola
Por idioma
Por archivo

Nuevo en la versión 3.5.

Por autor

Original commit messages are kept, but authorship is lost unless «Per author» is selected, or the commit message is customized to include it.

Nuevo en la versión 4.1.

The original commit messages can optionally be overridden with a custom commit message.

Trailers (commit lines like Co-authored-by: ...) can optionally be removed from the original commit messages and appended to the end of the squashed commit message. This also generates proper Co-authored-by: credit for every translator.

Personalizar la salida de JSON¶

Permite ajustar el comportamiento de salida de JSON, por ejemplo, sangría o clasificación.

Formatos del archivo de propiedades Java¶

Ordena el archivo de propiedades de Java.

Retiro de comentarios obsoletos¶

Nuevo en la versión 3.7.

Fijar un plazo para el borrado de los comentarios.

Esto puede resultar útil para quitar los comentarios antiguos que pueden ya no ser aplicables. Utilícela con cuidado, pues el hecho de que un comentario sea antiguo no necesariamente denota que ha perdido importancia.

Retiro de sugerencias obsoletas¶

Nuevo en la versión 3.7.

Fijar un plazo para el borrado de sugerencias.

This can be very useful in connection with suggestion voting (see Revisión por pares) to remove suggestions which don’t receive enough positive votes in a given timeframe.

Actualizar archivos RESX¶

Nuevo en la versión 3.9.

Actualiza todos los archivos de traducción para que coincidan con el archivo de base monolingüe original. Las cadenas no utilizadas se retiran y las nuevas se añaden como copias de las cadenas de origen.

Consejo

Use Limpieza de archivos de traducción if you only want to remove stale translation keys.

Personalizar salida de YAML¶

Nuevo en la versión 3.10.2.

Permite ajustar el comportamiento de salida de YAML, como la longitud de los renglones y los saltos.

Customizing list of addons¶

The list of addons is configured by WEBLATE_ADDONS. To add another addon, simply include class absolute name in this setting.

Writing addon¶

You can write your own addons too, all you need to do is subclass BaseAddon, define the addon metadata and implement a callback which will do the processing.

Here is an example addon:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


from django.utils.translation import gettext_lazy as _

from weblate.addons.base import BaseAddon
from weblate.addons.events import EVENT_PRE_COMMIT


class ExampleAddon(BaseAddon):
    # Filter for compatible components, every key is
    # matched against property of component
    compat = {"file_format": {"po", "po-mono"}}
    # List of events addon should receive
    events = (EVENT_PRE_COMMIT,)
    # Addon unique identifier
    name = "weblate.example.example"
    # Verbose name shown in the user interface
    verbose = _("Example addon")
    # Detailed addon description
    description = _("This addon does nothing it is just an example.")

    # Callback to implement custom behavior
    def pre_commit(self, translation, author):
        return

Executing scripts from addon¶

Addons can also be used to execute external scripts. This used to be integrated in Weblate, but now you have to write some code to wrap your script with an addon.

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Example pre commit script."""


from django.utils.translation import gettext_lazy as _

from weblate.addons.events import EVENT_PRE_COMMIT
from weblate.addons.scripts import BaseScriptAddon


class ExamplePreAddon(BaseScriptAddon):
    # Event used to trigger the script
    events = (EVENT_PRE_COMMIT,)
    # Name of the addon, has to be unique
    name = "weblate.example.pre"
    # Verbose name and long descrption
    verbose = _("Execute script before commit")
    description = _("This addon executes a script.")

    # Script to execute
    script = "/bin/true"
    # File to add in commit (for pre commit event)
    # does not have to be set
    add_file = "po/{{ language_code }}.po"

For installation instructions see Comprobaciones de calidad, complementos y correcciones automáticas personalizadas.

The script is executed with the current directory set to the root of the VCS repository for any given component.

Additionally, the following environment variables are available:

WL_VCS¶: Sistema de control de versiones utilizado.

WL_REPO¶: Upstream repository URL.

WL_PATH¶: Absolute path to VCS repository.

WL_BRANCH¶: Nuevo en la versión 2.11.

Rama del repositorio configurada en el componente actual.

WL_FILEMASK¶: Filemask for current component.

WL_TEMPLATE¶: Nombre de archivo de plantilla para traducciones monolingües (puede quedar vacío).

WL_NEW_BASE¶: Nuevo en la versión 2.14.

Nombre del archivo utilizado para crear traducciones nuevas (puede quedar vacío).

WL_FILE_FORMAT¶: Formato de archivo utilizado en el componente actual.

WL_LANGUAGE¶: Idioma de la traducción procesada actualmente (no disponible para actuadores a nivel componente).

WL_PREVIOUS_HEAD¶: Previous HEAD on update (available only when running post update hook).

WL_COMPONENT_SLUG¶: Nuevo en la versión 3.9.

Component slug used to construct URL.

WL_PROJECT_SLUG¶: Nuevo en la versión 3.9.

Project slug used to construct URL.

WL_COMPONENT_NAME¶: Nuevo en la versión 3.9.

Nombre del componente.

WL_PROJECT_NAME¶: Nuevo en la versión 3.9.

Nombre del proyecto.

WL_COMPONENT_URL¶: Nuevo en la versión 3.9.

URL del componente.

WL_ENGAGE_URL¶: Nuevo en la versión 3.9.

URL de participación del proyecto.

Ver también

Configuración de componentes

Post update repository processing¶

Post update repository processing can be used to update translation files when the VCS upstream source changes. To achieve this, please remember that Weblate only sees files committed to the VCS, so you need to commit changes as a part of the script.

For example with Gulp you can do it using following code:

#! /bin/sh
gulp --gulpfile gulp-i18n-extract.js
git commit -m 'Update source strings' src/languages/en.lang.json

Pre commit processing of translations¶

Use the commit script to automatically make changes to the translation before it is committed to the repository.

It is passed as a single parameter consisting of the filename of a current translation.

Memoria de traducción¶

Nuevo en la versión 2.20.

Weblate incluye una memoria de traducción incorporada que consiste de lo siguiente:

Manually imported translation memory (see Interfaz de usuario).
Automatically stored translations performed in Weblate (depending on Ámbitos de la memoria de traducción).
Traducciones pasadas importadas automáticamente.

El contenido de la memoria de traducción puede aplicarse de dos maneras:

Manually, Traducción automática view while translating.
Automatically, by translating strings using Traducción automática, or Traducción automática addon.

For installation tips, see Weblate Translation Memory, which is turned on by default.

Ámbitos de la memoria de traducción¶

Nuevo en la versión 3.2: In earlier versions translation memory could be only loaded from a file corresponding to the current imported translation memory scope.

The translation memory scopes are there to allow both privacy and sharing of translations, to suit the desired behavior.

Memoria de traducción importada¶

Importing arbitrary translation memory data using the import_memory command makes memory content available to all users and projects.

Memoria de traducción por usuario¶

Stores all user translations automatically in the personal translation memory of each respective user.

Memoria de traducción por proyecto¶

All translations within a project are automatically stored in a project translation memory only available for this project.

Memoria de traducción compartida¶

Todas las traducciones que se realicen en proyectos con la memoria compartida activada se almacenan de modo tal que quedarán disponibles para todos los proyectos.

Pondere si quiere activar esta funcionalidad en instalaciones compartidas de Weblate, ya que puede tener implicaciones importantes:

Cualquiera puede hacer uso de las traducciones.
Esto podría causar la revelación de información secreta.

Gestionar la memoria de traducción¶

Interfaz de usuario¶

Nuevo en la versión 3.2.

In the basic user interface you can manage per user and per project translation memories. It can be used to download, wipe or import translation memory.

Consejo

Las memorias de traducción JSON pueden importarse en Weblate. Se brinda el formato TMX por razones de interoperatividad con otras herramientas.

Ver también

Weblate Translation Memory Schema

Interfaz de gestión¶

There are several management commands to manipulate the translation memory content. These operate on the translation memory as whole, unfiltered by scopes (unless requested by parameters):

dump_memory: Exporta la memoria a JSON
import_memory: Importa archivos TMX o JSON en la memoria de traducción

Configuración¶

All settings are stored in settings.py (as is usual for Django).

Nota

After changing any of these settings, you need to restart Weblate - both WSGI and Celery processes.

In case it is run as mod_wsgi, you need to restart Apache to reload the configuration.

Ver también

Please also check Django’s documentation for parameters configuring Django itself.

AKISMET_API_KEY¶

Weblate can use Akismet to check incoming anonymous suggestions for spam. Visit akismet.com to purchase an API key and associate it with a site.

ANONYMOUS_USER_NAME¶

Username of users that are not signed in.

Ver también

Control de acceso

AUDITLOG_EXPIRY¶

Nuevo en la versión 3.6.

How many days Weblate should keep audit logs, which contain info about account activity.

Defaults to 180 days.

AUTH_LOCK_ATTEMPTS¶

Nuevo en la versión 2.14.

Maximum number of failed authentication attempts before rate limiting is applied.

This is currently applied in the following locations:

Logins. Deletes the account password, preventing the user from signing in without requesting a new password.
Password resets. Prevents new e-mails from being sent, avoiding spamming users with too many password reset attempts.

Defaults to 10.

Ver también

Rate limiting,

AUTO_UPDATE¶

Nuevo en la versión 3.2.

Distinto en la versión 3.11: The original on/off option was changed to differentiate which strings are accepted.

Updates all repositories on a daily basis.

Consejo

Useful if you are not using Actuadores de notificaciones to update Weblate repositories automatically.

Nota

On/off options exist in addition to string selection for backward compatibility.

Options are:

"none": No daily updates.
"remote" also False: Only update remotes.
"full" also True: Update remotes and merge working copy.

Nota

This requires that Tareas en segundo plano con Celery is working, and will take effect after it is restarted.

AVATAR_URL_PREFIX¶

Prefix for constructing avatar URLs as: ${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}. The following services are known to work:

Gravatar (default), as per https://gravatar.com/: AVATAR_URL_PREFIX = 'https://www.gravatar.com/'
Libravatar, as per https://www.libravatar.org/: AVATAR_URL_PREFIX = 'https://www.libravatar.org/'

Ver también

Caché de avatars, ENABLE_AVATARS, Avatars

AUTH_TOKEN_VALID¶

Nuevo en la versión 2.14.

How long the authentication token and temporary password from password reset e-mails is valid for. Set in number of seconds, defaulting to 172800 (2 days).

AUTH_PASSWORD_DAYS¶

Nuevo en la versión 2.15.

How many days using the same password should be allowed.

Nota

Password changes made prior to Weblate 2.15 will not be accounted for in this policy.

Defaults to 180 days.

AUTOFIX_LIST¶

List of automatic fixes to apply when saving a string.

Nota

Provide a fully-qualified path to the Python class that implementing the autofixer interface.

Available fixes:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace: Matches whitespace at the start and end of the string to the source.
weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis: Replaces trailing dots (…) if the source string has ellipsis (…).
weblate.trans.autofixes.chars.RemoveZeroSpace: Removes zero-width space characters if the source does not contain any.
weblate.trans.autofixes.chars.RemoveControlChars: Removes control characters if the source does not contain any.
weblate.trans.autofixes.html.BleachHTML: Removes unsafe HTML markup from strings flagged as safe-html (see HTML inseguro).

You can select which ones to use:

AUTOFIX_LIST = (
    'weblate.trans.autofixes.whitespace.SameBookendingWhitespace',
    'weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis',
)

Ver también

Automatic fixups, Custom automatic fixups

BASE_DIR¶

Base directory where Weblate sources are located. Used to derive several other paths by default:

DATA_DIR

Default value: Top level directory of Weblate sources.

CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC¶

Customize Content-Security-Policy header for Weblate. The header is automatically generated based on enabled integrations with third-party services (Matomo, Google Analytics, Sentry, …).

All these default to empty list.

** Ejemplo:: **

# Enable Cloudflare Javascript optimizations
CSP_SCRIPT_SRC = ["ajax.cloudflare.com"]

Ver también

Content security policy, Directiva de seguridad de contenido (CSP)

CHECK_LIST¶

Lista de comprobaciones de calidad que ejecutar en una traducción.

Nota

Provide a fully-qualified path to the Python class implementing the check interface.

Adjust the list of checks to include ones relevant to you.

All built-in Quality checks are turned on by default, from where you can change these settings. By default they are commented out in Configuración de muestra so that default values are used. New checks then carried out for each new Weblate version.

Puede desactivar todas las comprobaciones:

CHECK_LIST = ()

Puede activar solo algunas:

CHECK_LIST = (
    'weblate.checks.chars.BeginNewlineCheck',
    'weblate.checks.chars.EndNewlineCheck',
    'weblate.checks.chars.MaxLengthCheck',
)

Nota

Changing this setting only affects newly changed translations, existing checks will still be stored in the database. To also apply changes to the stored translations, run updatechecks.

Ver también

Quality checks, Customizing behavior

COMMENT_CLEANUP_DAYS¶

Nuevo en la versión 3.6.

Delete comments after a given number of days. Defaults to None, meaning no deletion at all.

COMMIT_PENDING_HOURS¶

Nuevo en la versión 2.10.

Number of hours between committing pending changes by way of the background task.

Ver también

Configuración de componentes, Antigüedad de cambios por consignar, Efectuar tareas de mantenimiento, commit_pending

DATA_DIR¶

The folder Weblate stores all data in. It contains links to VCS repositories, a fulltext index and various configuration files for external tools.

A menudo existen los subdirectorios siguientes:

home: Directorio de inicio utilizado para invocar secuencias de órdenes.
ssh: Claves SSH y su configuración.
static: Ubicación predeterminada de los archivos de Django, especificada por STATIC_ROOT.
media: Ubicación predeterminada de los archivos multimedia de Django, especificada por MEDIA_ROOT.
vcs: Repositorios de control de versiones.
backups: Daily backup data, please check Dumped data for backups for details.

Nota

Weblate necesita ser capaz de escribir en este directorio. Ejecutarlo como uWSGI implica que el usuario www-data debe tener privilegios de escritura aquí.

La manera más sencilla de lograrlo es hacer que el usuario sea propietario del directorio:

sudo chown www-data:www-data -R $DATA_DIR

Defaults to $BASE_DIR/data.

Ver también

BASE_DIR, Backing up and moving Weblate

DATABASE_BACKUP¶

Nuevo en la versión 3.1.

Whether the database backups should be stored as plain text, compressed or skipped. The authorized values are:

"plain"
"compressed"
"none"

Ver también

Backing up and moving Weblate

DEFAULT_ACCESS_CONTROL¶

Nuevo en la versión 3.3.

La configuración de control de acceso predeterminada para proyectos nuevos:

0: Público
1: Protegido
100: Privado
200: Personalizado

Use Custom if you are managing ACL manually, which means not relying on the internal Weblate management.

Ver también

Control de acceso por proyecto, Control de acceso, Control de acceso

DEFAULT_RESTRICTED_COMPONENT¶

Nuevo en la versión 4.1.

El valor predeterminado para la restricción de componentes.

Ver también

Control de acceso por proyecto, Acceso restringido, Control de acceso

DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE¶

Default commit messages for different operations, please check Configuración de componentes for details.

Ver también

Template markup, Configuración de componentes, Commit, add, delete, merge and addon messages

DEFAULT_ADDONS¶

Los complementos predeterminados que se instalarán en todos los componentes que se creen.

Nota

Esta configuración solo surte efecto en los componentes nuevos.

Ejemplo:

DEFAULT_ADDONS = {
     # Addon with no parameters
     "weblate.flags.target_edit": {},

     # Addon with parameters
     "weblate.autotranslate.autotranslate": {
         "mode": "suggest",
         "filter_type": "todo",
         "auto_source": "mt",
         "component": "",
         "engines": ["weblate-translation-memory"],
         "threshold": "80",
     }
}

Ver también

install_addon

DEFAULT_COMMITER_EMAIL¶

Nuevo en la versión 2.4.

Committer e-mail address for created translation components defaulting to noreply@weblate.org.

Ver también

DEFAULT_COMMITER_NAME, Configuración de componentes, Correo electrónico de consignante

DEFAULT_COMMITER_NAME¶

Nuevo en la versión 2.4.

Committer name for created translation components defaulting to Weblate.

Ver también

DEFAULT_COMMITER_EMAIL, Configuración de componentes, Nombre de consignante

DEFAULT_MERGE_STYLE¶

Nuevo en la versión 3.4.

Merge style for any new components.

rebase - default
merge

Ver también

Configuración de componentes, Estilo de fusión

DEFAULT_TRANSLATION_PROPAGATION¶

Nuevo en la versión 2.5.

Default setting for translation propagation, defaults to True.

Ver también

Configuración de componentes, Permitir propagación de traducciones

DEFAULT_PULL_MESSAGE¶

Title for new pull requests, defaulting to 'Update from Weblate'.

ENABLE_AVATARS¶

Whether to turn on Gravatar-based avatars for users. By default this is on.

Avatars are fetched and cached on the server, lowering the risk of leaking private info, speeding up the user experience.

Ver también

Caché de avatars, AVATAR_URL_PREFIX, Avatars

ENABLE_HOOKS¶

Whether to enable anonymous remote hooks.

Ver también

Actuadores de notificaciones

ENABLE_HTTPS¶

Whether to send links to Weblate as HTTPS or HTTP. This setting affects sent e-mails and generated absolute URLs.

Consejo

In the default configuration this is also used for several Django settings related to HTTPS.

Ver también

SESSION_COOKIE_SECURE, CSRF_COOKIE_SECURE, SECURE_SSL_REDIRECT, Set correct site domain

GITLAB_USERNAME¶

GitLab username used to send merge requests for translation updates.

Ver también

GitLab, Setting up Lab

GITHUB_USERNAME¶

GitHub username used to send pull requests for translation updates.

Ver también

GitHub, Setting up hub

GOOGLE_ANALYTICS_ID¶

Google Analytics ID to turn on monitoring of Weblate using Google Analytics.

HIDE_REPO_CREDENTIALS¶

Hide repository credentials from appearing in the web interface. In case you have repository URL with user and password, Weblate will hide it when related info is shown to users.

For example instead of https://user:password@git.example.com/repo.git it will show just https://git.example.com/repo.git. It tries to clean up VCS error messages too in a similar manner.

Nota

This is turned on by default.

IP_BEHIND_REVERSE_PROXY¶

Nuevo en la versión 2.14.

Indicates whether Weblate is running behind a reverse proxy.

If set to True, Weblate gets IP address from a header defined by IP_PROXY_HEADER.

Advertencia

Ensure you are actually using a reverse proxy and that it sets this header, otherwise users will be able to fake the IP address.

Nota

This is not on by default.

Ver también

Running behind reverse proxy, Rate limiting, IP_PROXY_HEADER, IP_PROXY_OFFSET

IP_PROXY_HEADER¶

Nuevo en la versión 2.14.

Indicates which header Weblate should obtain the IP address from when IP_BEHIND_REVERSE_PROXY is turned on.

Defaults to HTTP_X_FORWARDED_FOR.

Ver también

Running behind reverse proxy, Rate limiting, SECURE_PROXY_SSL_HEADER, IP_BEHIND_REVERSE_PROXY, IP_PROXY_OFFSET

IP_PROXY_OFFSET¶

Nuevo en la versión 2.14.

Indicates which part of IP_PROXY_HEADER is used as client IP address.

Depending on your setup, this header might consist of several IP addresses, (for example X-Forwarded-For: a, b, client-ip) and you can configure which address from the header is used as client IP address here.

Advertencia

Setting this affects the security of your installation, you should only configure it to use trusted proxies for determining IP address.

Defaults to 0.

Ver también

Running behind reverse proxy, Rate limiting, SECURE_PROXY_SSL_HEADER, IP_BEHIND_REVERSE_PROXY, IP_PROXY_HEADER

LEGAL_URL¶

Nuevo en la versión 3.5.

URL where your Weblate instance shows its legal documents.

Consejo

Useful if you host your legal documents outside Weblate for embedding them inside Weblate, please check Información legal for details.

Ejemplo:

LEGAL_URL = "https://weblate.org/terms/"

LICENSE_EXTRA¶

Additional licenses to include in the license choices.

Nota

Each license definition should be tuple of its short name, a long name and an URL.

For example:

LICENSE_EXTRA = [
    (
        "AGPL-3.0",
        "GNU Affero General Public License v3.0",
        "https://www.gnu.org/licenses/agpl-3.0-standalone.html",
    ),
]

LICENSE_FILTER¶

Optional addition of licenses to show.

Nota

This filter uses the short license names.

For example:

LICENSE_FILTER = {"AGPL-3.0", "GPL-3.0-or-later"}

LICENSE_REQUIRED¶

Defines whether the license attribute in Configuración de componentes is required.

Nota

This is off by default.

LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH¶

Whether the length of a given translation should be limited. The restriction is the length of the source string * 10 characters.

Consejo

Set this to False to allow longer translations (up to 10.000 characters) irrespective of source string length.

Nota

Defaults to True.

LOCALIZE_CDN_URL and LOCALIZE_CDN_PATH¶

These settings configure the CDN de regionalización de JavaScript addon. LOCALIZE_CDN_URL defines root URL where the localization CDN is available and LOCALIZE_CDN_PATH defines path where Weblate should store generated files which will be served at the LOCALIZE_CDN_URL.

Consejo

On Hosted Weblate, this uses https://weblate-cdn.com/.

Ver también

CDN de regionalización de JavaScript

LOGIN_REQUIRED_URLS¶

A list of URLs you want to require logging into. (Besides the standard rules built into Weblate).

Consejo

This allows you to password protect a whole installation using:

LOGIN_REQUIRED_URLS = (
    r'/(.*)$',
)
REST_FRAMEWORK["DEFAULT_PERMISSION_CLASSES"] = [
    "rest_framework.permissions.IsAuthenticated"
]

Consejo

It is desirable to lock down API access as well, as shown in the above example.

LOGIN_REQUIRED_URLS_EXCEPTIONS¶

List of exceptions for LOGIN_REQUIRED_URLS. If not specified, users are allowed to access the login page.

Some of exceptions you might want to include:

LOGIN_REQUIRED_URLS_EXCEPTIONS = (
    r'/accounts/(.*)$', # Required for login
    r'/static/(.*)$',   # Required for development mode
    r'/widgets/(.*)$',  # Allowing public access to widgets
    r'/data/(.*)$',     # Allowing public access to data exports
    r'/hooks/(.*)$',    # Allowing public access to notification hooks
    r'/api/(.*)$',      # Allowing access to API
    r'/js/i18n/$',      # JavaScript localization
)

MATOMO_SITE_ID¶

Identificador de un sitio en Matomo (antes Piwik) al que quiere realizar seguimiento.

Nota

Esta integración no admite el gestor de etiquetas de Matomo.

Ver también

MATOMO_URL

MATOMO_URL¶

Full URL (including trailing slash) of a Matomo (formerly Piwik) installation you want to use to track Weblate use. Please check <https://matomo.org/> for more details.

Consejo

Esta integración no admite el gestor de etiquetas de Matomo.

For example:

MATOMO_SITE_ID = 1
MATOMO_URL = "https://example.matomo.cloud/"

Ver también

MATOMO_SITE_ID

MT_SERVICES¶

Distinto en la versión 3.0: The setting was renamed from MACHINE_TRANSLATION_SERVICES to MT_SERVICES to be consistent with other machine translation settings.

List of enabled machine translation services to use.

Nota

Many of the services need additional configuration like API keys, please check their documentation ref: machine for more details.

MT_SERVICES = (
    'weblate.machinery.apertium.ApertiumAPYTranslation',
    'weblate.machinery.deepl.DeepLTranslation',
    'weblate.machinery.glosbe.GlosbeTranslation',
    'weblate.machinery.google.GoogleTranslation',
    'weblate.machinery.microsoft.MicrosoftCognitiveTranslation',
    'weblate.machinery.microsoftterminology.MicrosoftTerminologyService',
    'weblate.machinery.mymemory.MyMemoryTranslation',
    'weblate.machinery.tmserver.AmagamaTranslation',
    'weblate.machinery.tmserver.TMServerTranslation',
    'weblate.machinery.yandex.YandexTranslation',
    'weblate.machinery.weblatetm.WeblateTranslation',
    'weblate.machinery.saptranslationhub.SAPTranslationHub',
    'weblate.memory.machine.WeblateMemory',
)

Ver también

Traducción automática, Traducción automática

MT_APERTIUM_APY¶

URL of the Apertium-APy server, https://wiki.apertium.org/wiki/Apertium-apy

Ver también

Apertium, Traducción automática, Traducción automática

MT_AWS_ACCESS_KEY_ID¶

Access key ID for Amazon Translate.

Ver también

AWS, Traducción automática, Traducción automática

MT_AWS_SECRET_ACCESS_KEY¶

API secret key for Amazon Translate.

Ver también

AWS, Traducción automática, Traducción automática

MT_AWS_REGION¶

Region name to use for Amazon Translate.

Ver también

AWS, Traducción automática, Traducción automática

MT_BAIDU_ID¶

Client ID for the Baidu Zhiyun API, you can register at https://api.fanyi.baidu.com/api/trans/product/index

Ver también

Baidu API machine translation, Traducción automática, Traducción automática

MT_BAIDU_SECRET¶

Client secret for the Baidu Zhiyun API, you can register at https://api.fanyi.baidu.com/api/trans/product/index

Ver también

Baidu API machine translation, Traducción automática, Traducción automática

MT_DEEPL_API_VERSION¶

Nuevo en la versión 4.1.1.

API version to use with DeepL service. The version limits scope of usage:

v1: Is meant for CAT tools and is usable with user-based subscription.
v2: Is meant for API usage and the subscription is usage based.

Previously Weblate was classified as a CAT tool by DeepL, so it was supposed to use the v1 API, but now is supposed to use the v2 API. Therefore it defaults to v2, and you can change it to v1 in case you have an existing CAT subscription and want Weblate to use that.

Ver también

DeepL, Traducción automática, Traducción automática

MT_DEEPL_KEY¶

API key for the DeepL API, you can register at https://www.deepl.com/pro.html

Ver también

DeepL, Traducción automática, Traducción automática

MT_GOOGLE_KEY¶

API key for Google Translate API v2, you can register at https://cloud.google.com/translate/docs

Ver también

Google Translate, Traducción automática, Traducción automática

MT_GOOGLE_CREDENTIALS¶

API v3 JSON credentials file obtained in the Google cloud console. Please provide a full OS path. Credentials are per service-account affiliated with certain project. Please check https://cloud.google.com/docs/authentication/getting-started for more details.

MT_GOOGLE_PROJECT¶

API v3 Google cloud project id with activated translation service and billing activated. Please check https://cloud.google.com/appengine/docs/standard/nodejs/building-app/creating-project for more details

MT_GOOGLE_LOCATION¶

API v3 Google Cloud Application Engine may be specific to a location. Change accordingly if the default global fallback does not work for you.

Please check https://cloud.google.com/appengine/docs/locations for more details

Ver también

Google Translate API V3 (Advanced)

MT_MICROSOFT_BASE_URL¶

Region base URL domain as defined in the «Base URLs» section.

Defaults to api.cognitive.microsofttranslator.com for Azure Global.

For Azure China, please use api.translator.azure.cn.

MT_MICROSOFT_COGNITIVE_KEY¶

Client key for the Microsoft Cognitive Services Translator API.

Ver también

Microsoft Cognitive Services Translator, Traducción automática, Traducción automática, Cognitive Services - Text Translation API, Microsoft Azure Portal

MT_MICROSOFT_REGION¶

Region prefix as defined in «Multi service subscription».

MT_MICROSOFT_ENDPOINT_URL¶

Region endpoint URL domain for access token as defined in the «Authenticating with an access token» section.

Defaults to api.cognitive.microsoft.com for Azure Global.

For Azure China, please use your endpoint from the Azure Portal.

MT_MODERNMT_KEY¶

Clave de API para el motor de traducciones automáticas ModernMT.

Ver también

ModernMT MT_MODERNMT_URL

MT_MODERNMT_URL¶

URL of ModernMT. It defaults to https://api.modernmt.com/ for the cloud service.

Ver también

ModernMT MT_MODERNMT_KEY

MT_MYMEMORY_EMAIL¶

MyMemory identification e-mail address. It permits 1000 requests per day.

Ver también

MyMemory, Traducción automática, Traducción automática, MyMemory: API technical specifications

MT_MYMEMORY_KEY¶

MyMemory access key for private translation memory, use it with MT_MYMEMORY_USER.

Ver también

MyMemory, Traducción automática, Traducción automática, MyMemory: API key generator

MT_MYMEMORY_USER¶

MyMemory user ID for private translation memory, use it with MT_MYMEMORY_KEY.

Ver también

MyMemory, Traducción automática, Traducción automática, MyMemory: API key generator

MT_NETEASE_KEY¶

App key for NetEase Sight API, you can register at https://sight.netease.com/

Ver también

NetEase Sight API machine translation, Traducción automática, Traducción automática

MT_NETEASE_SECRET¶

App secret for the NetEase Sight API, you can register at https://sight.netease.com/

Ver también

NetEase Sight API machine translation, Traducción automática, Traducción automática

MT_TMSERVER¶

URL where tmserver is running.

Ver también

tmserver, Traducción automática, Traducción automática, tmserver

MT_YANDEX_KEY¶

API key for the Yandex Translate API, you can register at https://tech.yandex.com/translate/

Ver también

Yandex Translate, Traducción automática, Traducción automática

MT_YOUDAO_ID¶

Client ID for the Youdao Zhiyun API, you can register at https://ai.youdao.com/product-fanyi-text.s.

Ver también

Youdao Zhiyun API machine translation, Traducción automática, Traducción automática

MT_YOUDAO_SECRET¶

Client secret for the Youdao Zhiyun API, you can register at https://ai.youdao.com/product-fanyi-text.s.

Ver también

Youdao Zhiyun API machine translation, Traducción automática, Traducción automática

MT_SAP_BASE_URL¶

API URL to the SAP Translation Hub service.

Ver también

SAP Translation Hub, Traducción automática, Traducción automática

MT_SAP_SANDBOX_APIKEY¶

API key for sandbox API usage

Ver también

SAP Translation Hub, Traducción automática, Traducción automática

MT_SAP_USERNAME¶

Your SAP username

Ver también

SAP Translation Hub, Traducción automática, Traducción automática

MT_SAP_PASSWORD¶

Your SAP password

Ver también

SAP Translation Hub, Traducción automática, Traducción automática

MT_SAP_USE_MT¶

Whether to also use machine translation services, in addition to the term database. Possible values: True or False

Ver también

SAP Translation Hub, Traducción automática, Traducción automática

NEARBY_MESSAGES¶

How many strings to show around the currently translated string. This is just a default value, users can adjust this in Perfil de usuario.

RATELIMIT_ATTEMPTS¶

Nuevo en la versión 3.2.

Maximum number of authentication attempts before rate limiting is applied.

Defaults to 5.

Ver también

Rate limiting, RATELIMIT_WINDOW, RATELIMIT_LOCKOUT

RATELIMIT_WINDOW¶

Nuevo en la versión 3.2.

How long authentication is accepted after rate limiting applies.

An amount of seconds defaulting to 300 (5 minutes).

Ver también

Rate limiting, RATELIMIT_ATTEMPTS, RATELIMIT_LOCKOUT

RATELIMIT_LOCKOUT¶

Nuevo en la versión 3.2.

How long authentication is locked after rate limiting applies.

An amount of seconds defaulting to 600 (10 minutes).

Ver también

Rate limiting, RATELIMIT_ATTEMPTS, RATELIMIT_WINDOW

REGISTRATION_ALLOW_BACKENDS¶

Nuevo en la versión 4.1.

List of authentication backends to allow registration from in case it is otherwise disabled by REGISTRATION_OPEN.

Ejemplo:

REGISTRATION_ALLOW_BACKENDS = ["azuread-oauth2", "azuread-tenant-oauth2"]

Consejo

The backend names match names used in URL for authentication.

Ver también

REGISTRATION_OPEN

REGISTRATION_CAPTCHA¶

A value of either True or False indicating whether registration of new accounts is protected by CAPTCHA. This setting is optional, and a default of True will be assumed if it is not supplied.

If turned on, a CAPTCHA is added to all pages where a users enters their e-mail address:

Registro de cuentas nuevas.
Recuperación de contraseñas.
Adding e-mail to an account.
Formulario de contacto para usuarios que no han accedido a su cuenta.

REGISTRATION_EMAIL_MATCH¶

Nuevo en la versión 2.17.

Le permite filtrar cuáles direcciones de correo pueden utilizarse para registrar una cuenta.

Defaults to .*, which allows any e-mail address to be registered.

Puede utilizarlo para restringir el registro de un dominio de correo electrónico:

REGISTRATION_EMAIL_MATCH = r'^.*@weblate\.org$'

REGISTRATION_OPEN¶

Whether registration of new accounts is currently permitted. This optional setting can remain the default True, or changed to False.

This setting affects built-in authentication by e-mail address or through the Python Social Auth (you can whitelist certain back-ends using REGISTRATION_ALLOW_BACKENDS).

Nota

Si se utilizan métodos de autenticación de terceros tales como LDAP authentication, tan solo oculta el formulario de registro, pero usuarios nuevos podrán aún acceder y crear cuentas.

Ver también

REGISTRATION_ALLOW_BACKENDS, REGISTRATION_EMAIL_MATCH

REPOSITORY_ALERT_THRESHOLD¶

Nuevo en la versión 4.0.2.

Threshold for triggering an alert for outdated repositories, or ones that contain too many changes. Defaults to 25.

Ver también

Translation component alerts

SENTRY_DSN¶

Nuevo en la versión 3.9.

Sentry DSN to use for Collecting error reports.

Ver también

Django integration for Sentry

SIMPLIFY_LANGUAGES¶

Use simple language codes for default language/country combinations. For example an fr_FR translation will use the fr language code. This is usually the desired behavior, as it simplifies listing languages for these default combinations.

Turn this off if you want to different translations for each variant.

SITE_DOMAIN¶

Configura el dominio del sitio. Es necesario para producir los URL absolutos correctos en distintos ámbitos (por ejemplo, en los mensajes de activación, las notificaciones o los suministros RSS).

Si Weblate se está ejecutando en algún puerto no estándar, inclúyalo aquí también.

Ejemplos:

# Production site with domain name
SITE_DOMAIN = "weblate.example.com"

# Local development with IP address and port
SITE_DOMAIN = "127.0.0.1:8000"

Nota

Esta configuración debe contener solo el nombre de dominio. Para configurar el protocolo (activar y exigir HTTPS, p. ej.), utilice ENABLE_HTTPS, y para cambiar el URL, utilice URL_PREFIX.

Consejo

En un contenedor Docker, el dominio del sitio se configura mediante WEBLATE_ALLOWED_HOSTS.

Ver también

Set correct site domain, Allowed hosts setup, Correctly configure HTTPS WEBLATE_SITE_DOMAIN, ENABLE_HTTPS

SITE_TITLE¶

El título que se utilizará en el sitio web y los mensajes de correo que se envíen.

SPECIAL_CHARS¶

Caracteres adicionales que incluir en el teclado visual; Visual keyboard.

El valor predeterminado es:

SPECIAL_CHARS = ('\t', '\n', '…')

SINGLE_PROJECT¶

Nuevo en la versión 3.8.

Redirects users directly to a project or component instead of showing the dashboard. You can either set it to True and in this case it only works in case there is actually only single project in Weblate. Alternatively set the project slug, and it will redirect unconditionally to this project.

Distinto en la versión 3.11: The setting now also accepts a project slug, to force displaying that single project.

Ejemplo:

SINGLE_PROJECT = "test"

STATUS_URL¶

The URL where your Weblate instance reports its status.

SUGGESTION_CLEANUP_DAYS¶

Nuevo en la versión 3.2.1.

Automatically deletes suggestions after a given number of days. Defaults to None, meaning no deletions.

URL_PREFIX¶

This setting allows you to run Weblate under some path (otherwise it relies on being run from the webserver root).

Nota

To use this setting, you also need to configure your server to strip this prefix. For example with WSGI, this can be achieved by setting WSGIScriptAlias.

Consejo

The prefix should start with a /.

Ejemplo:

URL_PREFIX = '/translations'

Nota

This setting does not work with Django’s built-in server, you would have to adjust urls.py to contain this prefix.

VCS_BACKENDS¶

Configuration of available VCS backends.

Nota

Weblate tries to use all supported back-ends you have the tools for.

Consejo

You can limit choices or add custom VCS back-ends by using this.

VCS_BACKENDS = (
   'weblate.vcs.git.GitRepository',
)

Ver también

Integración de control de versiones

VCS_CLONE_DEPTH¶

Nuevo en la versión 3.10.2.

Configures how deep cloning of repositories Weblate should do.

Nota

Currently this is only supported in Git. By default Weblate does shallow clones of the repositories to make cloning faster and save disk space. Depending on your usage (for example when using custom Complementos), you might want to increase the depth or turn off shallow clones completely by setting this to 0.

Consejo

In case you get fatal: protocol error: expected old/new/ref, got 'shallow <commit hash>' error when pushing from Weblate, turn off shallow clones completely by setting:

VCS_CLONE_DEPTH = 0

WEBLATE_ADDONS¶

List of addons available for use. To use them, they have to be enabled for a given translation component. By default this includes all built-in addons, when extending the list you will probably want to keep existing ones enabled, for example:

WEBLATE_ADDONS = (
    # Built-in addons
    "weblate.addons.gettext.GenerateMoAddon",
    "weblate.addons.gettext.UpdateLinguasAddon",
    "weblate.addons.gettext.UpdateConfigureAddon",
    "weblate.addons.gettext.MsgmergeAddon",
    "weblate.addons.gettext.GettextCustomizeAddon",
    "weblate.addons.gettext.GettextAuthorComments",
    "weblate.addons.cleanup.CleanupAddon",
    "weblate.addons.consistency.LangaugeConsistencyAddon",
    "weblate.addons.discovery.DiscoveryAddon",
    "weblate.addons.flags.SourceEditAddon",
    "weblate.addons.flags.TargetEditAddon",
    "weblate.addons.flags.SameEditAddon",
    "weblate.addons.flags.BulkEditAddon",
    "weblate.addons.generate.GenerateFileAddon",
    "weblate.addons.json.JSONCustomizeAddon",
    "weblate.addons.properties.PropertiesSortAddon",
    "weblate.addons.git.GitSquashAddon",
    "weblate.addons.removal.RemoveComments",
    "weblate.addons.removal.RemoveSuggestions",
    "weblate.addons.resx.ResxUpdateAddon",
    "weblate.addons.autotranslate.AutoTranslateAddon",
    "weblate.addons.yaml.YAMLCustomizeAddon",
    "weblate.addons.cdn.CDNJSAddon",

    # Addon you want to include
    "weblate.addons.example.ExampleAddon",
)

Ver también

Complementos

WEBLATE_EXPORTERS¶

Nuevo en la versión 4.2.

List of a available exporters offering downloading translations or glossaries in various file formats.

Ver también

Formatos de archivo admitidos

WEBLATE_FORMATS¶

Nuevo en la versión 3.0.

List of file formats available for use.

Nota

The default list already has the common formats.

Ver también

Formatos de archivo admitidos

WEBLATE_GPG_IDENTITY¶

Nuevo en la versión 3.1.

Identity used by Weblate to sign Git commits, for example:

WEBLATE_GPG_IDENTITY = 'Weblate <weblate@example.com>'

The Weblate GPG keyring is searched for a matching key (home/.gnupg under DATA_DIR). If not found, a key is generated, please check Signing Git commits with GnuPG for more details.

Ver también

Signing Git commits with GnuPG

Configuración de muestra¶

The following example is shipped as weblate/settings_example.py with Weblate:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


import os
import platform
from logging.handlers import SysLogHandler

#
# Django settings for Weblate project.
#

DEBUG = True

ADMINS = (
    # ("Your Name", "your_email@example.com"),
)

MANAGERS = ADMINS

DATABASES = {
    "default": {
        # Use "postgresql" or "mysql".
        "ENGINE": "django.db.backends.postgresql",
        # Database name.
        "NAME": "weblate",
        # Database user.
        "USER": "weblate",
        # Database password.
        "PASSWORD": "",
        # Set to empty string for localhost.
        "HOST": "127.0.0.1",
        # Set to empty string for default.
        "PORT": "",
        # Customizations for databases.
        "OPTIONS": {
            # In case of using an older MySQL server,
            # which has MyISAM as a default storage
            # "init_command": "SET storage_engine=INNODB",
            # Uncomment for MySQL older than 5.7:
            # "init_command": "SET sql_mode='STRICT_TRANS_TABLES'",
            # Set emoji capable charset for MySQL:
            # "charset": "utf8mb4",
            # Change connection timeout in case you get MySQL gone away error:
            # "connect_timeout": 28800,
        },
    }
}

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# Data directory
DATA_DIR = os.path.join(BASE_DIR, "data")

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# In a Windows environment this must be set to your system time zone.
TIME_ZONE = "UTC"

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = "en-us"

LANGUAGES = (
    ("ar", "العربية"),
    ("az", "Azərbaycan"),
    ("be", "Беларуская"),
    ("be@latin", "Biełaruskaja"),
    ("bg", "Български"),
    ("br", "Brezhoneg"),
    ("ca", "Català"),
    ("cs", "Čeština"),
    ("da", "Dansk"),
    ("de", "Deutsch"),
    ("en", "English"),
    ("el", "Ελληνικά"),
    ("en-gb", "English (United Kingdom)"),
    ("es", "Español"),
    ("fi", "Suomi"),
    ("fr", "Français"),
    ("gl", "Galego"),
    ("he", "עברית"),
    ("hu", "Magyar"),
    ("hr", "Hrvatski"),
    ("id", "Indonesia"),
    ("is", "Íslenska"),
    ("it", "Italiano"),
    ("ja", "日本語"),
    ("kab", "Taqbaylit"),
    ("kk", "Қазақ тілі"),
    ("ko", "한국어"),
    ("nb", "Norsk bokmål"),
    ("nl", "Nederlands"),
    ("pl", "Polski"),
    ("pt", "Português"),
    ("pt-br", "Português brasileiro"),
    ("ru", "Русский"),
    ("sk", "Slovenčina"),
    ("sl", "Slovenščina"),
    ("sq", "Shqip"),
    ("sr", "Српски"),
    ("sv", "Svenska"),
    ("tr", "Türkçe"),
    ("uk", "Українська"),
    ("zh-hans", "简体字"),
    ("zh-hant", "正體字"),
)

SITE_ID = 1

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True

# If you set this to False, Django will not format dates, numbers and
# calendars according to the current locale.
USE_L10N = True

# If you set this to False, Django will not use timezone-aware datetimes.
USE_TZ = True

# URL prefix to use, please see documentation for more details
URL_PREFIX = ""

# Absolute filesystem path to the directory that will hold user-uploaded files.
MEDIA_ROOT = os.path.join(DATA_DIR, "media")

# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash.
MEDIA_URL = f"{URL_PREFIX}/media/"

# Absolute path to the directory static files should be collected to.
# Don't put anything in this directory yourself; store your static files
# in apps' "static/" subdirectories and in STATICFILES_DIRS.
STATIC_ROOT = os.path.join(DATA_DIR, "static")

# URL prefix for static files.
STATIC_URL = f"{URL_PREFIX}/static/"

# Additional locations of static files
STATICFILES_DIRS = (
    # Put strings here, like "/home/html/static" or "C:/www/django/static".
    # Always use forward slashes, even on Windows.
    # Don't forget to use absolute paths, not relative paths.
)

# List of finder classes that know how to find static files in
# various locations.
STATICFILES_FINDERS = (
    "django.contrib.staticfiles.finders.FileSystemFinder",
    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
    "compressor.finders.CompressorFinder",
)

# Make this unique, and don't share it with anybody.
# You can generate it using weblate/examples/generate-secret-key
SECRET_KEY = ""

_TEMPLATE_LOADERS = [
    "django.template.loaders.filesystem.Loader",
    "django.template.loaders.app_directories.Loader",
]
if not DEBUG:
    _TEMPLATE_LOADERS = [("django.template.loaders.cached.Loader", _TEMPLATE_LOADERS)]
TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "OPTIONS": {
            "context_processors": [
                "django.contrib.auth.context_processors.auth",
                "django.template.context_processors.debug",
                "django.template.context_processors.i18n",
                "django.template.context_processors.request",
                "django.template.context_processors.csrf",
                "django.contrib.messages.context_processors.messages",
                "weblate.trans.context_processors.weblate_context",
            ],
            "loaders": _TEMPLATE_LOADERS,
        },
    }
]


# GitHub username for sending pull requests.
# Please see the documentation for more details.
GITHUB_USERNAME = None

# GitLab username for sending merge requests.
# Please see the documentation for more details.
GITLAB_USERNAME = None

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.email.EmailAuth",
    # "social_core.backends.google.GoogleOAuth2",
    # "social_core.backends.github.GithubOAuth2",
    # "social_core.backends.bitbucket.BitbucketOAuth",
    # "social_core.backends.suse.OpenSUSEOpenId",
    # "social_core.backends.ubuntu.UbuntuOpenId",
    # "social_core.backends.fedora.FedoraOpenId",
    # "social_core.backends.facebook.FacebookOAuth2",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Custom user model
AUTH_USER_MODEL = "weblate_auth.User"

# Social auth backends setup
SOCIAL_AUTH_GITHUB_KEY = ""
SOCIAL_AUTH_GITHUB_SECRET = ""
SOCIAL_AUTH_GITHUB_SCOPE = ["user:email"]

SOCIAL_AUTH_BITBUCKET_KEY = ""
SOCIAL_AUTH_BITBUCKET_SECRET = ""
SOCIAL_AUTH_BITBUCKET_VERIFIED_EMAILS_ONLY = True

SOCIAL_AUTH_FACEBOOK_KEY = ""
SOCIAL_AUTH_FACEBOOK_SECRET = ""
SOCIAL_AUTH_FACEBOOK_SCOPE = ["email", "public_profile"]
SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {"fields": "id,name,email"}
SOCIAL_AUTH_FACEBOOK_API_VERSION = "3.1"

SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = ""
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = ""

# Social auth settings
SOCIAL_AUTH_PIPELINE = (
    "social_core.pipeline.social_auth.social_details",
    "social_core.pipeline.social_auth.social_uid",
    "social_core.pipeline.social_auth.auth_allowed",
    "social_core.pipeline.social_auth.social_user",
    "weblate.accounts.pipeline.store_params",
    "weblate.accounts.pipeline.verify_open",
    "social_core.pipeline.user.get_username",
    "weblate.accounts.pipeline.require_email",
    "social_core.pipeline.mail.mail_validation",
    "weblate.accounts.pipeline.revoke_mail_code",
    "weblate.accounts.pipeline.ensure_valid",
    "weblate.accounts.pipeline.remove_account",
    "social_core.pipeline.social_auth.associate_by_email",
    "weblate.accounts.pipeline.reauthenticate",
    "weblate.accounts.pipeline.verify_username",
    "social_core.pipeline.user.create_user",
    "social_core.pipeline.social_auth.associate_user",
    "social_core.pipeline.social_auth.load_extra_data",
    "weblate.accounts.pipeline.cleanup_next",
    "weblate.accounts.pipeline.user_full_name",
    "weblate.accounts.pipeline.store_email",
    "weblate.accounts.pipeline.notify_connect",
    "weblate.accounts.pipeline.password_reset",
)
SOCIAL_AUTH_DISCONNECT_PIPELINE = (
    "social_core.pipeline.disconnect.allowed_to_disconnect",
    "social_core.pipeline.disconnect.get_entries",
    "social_core.pipeline.disconnect.revoke_tokens",
    "weblate.accounts.pipeline.cycle_session",
    "weblate.accounts.pipeline.adjust_primary_mail",
    "weblate.accounts.pipeline.notify_disconnect",
    "social_core.pipeline.disconnect.disconnect",
    "weblate.accounts.pipeline.cleanup_next",
)

# Custom authentication strategy
SOCIAL_AUTH_STRATEGY = "weblate.accounts.strategy.WeblateStrategy"

# Raise exceptions so that we can handle them later
SOCIAL_AUTH_RAISE_EXCEPTIONS = True

SOCIAL_AUTH_EMAIL_VALIDATION_FUNCTION = "weblate.accounts.pipeline.send_validation"
SOCIAL_AUTH_EMAIL_VALIDATION_URL = "{0}/accounts/email-sent/".format(URL_PREFIX)
SOCIAL_AUTH_LOGIN_ERROR_URL = "{0}/accounts/login/".format(URL_PREFIX)
SOCIAL_AUTH_EMAIL_FORM_URL = "{0}/accounts/email/".format(URL_PREFIX)
SOCIAL_AUTH_NEW_ASSOCIATION_REDIRECT_URL = "{0}/accounts/profile/#account".format(
    URL_PREFIX
)
SOCIAL_AUTH_PROTECTED_USER_FIELDS = ("email",)
SOCIAL_AUTH_SLUGIFY_USERNAMES = True
SOCIAL_AUTH_SLUGIFY_FUNCTION = "weblate.accounts.pipeline.slugify_username"

# Password validation configuration
AUTH_PASSWORD_VALIDATORS = [
    {
        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"  # noqa: E501, pylint: disable=line-too-long
    },
    {
        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
        "OPTIONS": {"min_length": 10},
    },
    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
    {"NAME": "weblate.accounts.password_validation.CharsPasswordValidator"},
    {"NAME": "weblate.accounts.password_validation.PastPasswordsValidator"},
    # Optional password strength validation by django-zxcvbn-password
    # {
    #     "NAME": "zxcvbn_password.ZXCVBNValidator",
    #     "OPTIONS": {
    #         "min_score": 3,
    #         "user_attributes": ("username", "email", "full_name")
    #     }
    # },
]

# Allow new user registrations
REGISTRATION_OPEN = True

# Shortcut for login required setting
REQUIRE_LOGIN = False

# Middleware
MIDDLEWARE = [
    "weblate.middleware.RedirectMiddleware",
    "weblate.middleware.ProxyMiddleware",
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "weblate.accounts.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "social_django.middleware.SocialAuthExceptionMiddleware",
    "weblate.accounts.middleware.RequireLoginMiddleware",
    "weblate.api.middleware.ThrottlingMiddleware",
    "weblate.middleware.SecurityMiddleware",
]

ROOT_URLCONF = "weblate.urls"

# Django and Weblate apps
INSTALLED_APPS = [
    # Weblate apps on top to override Django locales and templates
    "weblate.addons",
    "weblate.auth",
    "weblate.checks",
    "weblate.formats",
    "weblate.glossary",
    "weblate.machinery",
    "weblate.trans",
    "weblate.lang",
    "weblate.langdata",
    "weblate.memory",
    "weblate.screenshots",
    "weblate.fonts",
    "weblate.accounts",
    "weblate.utils",
    "weblate.vcs",
    "weblate.wladmin",
    "weblate",
    # Optional: Git exporter
    "weblate.gitexport",
    # Standard Django modules
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django.contrib.admin.apps.SimpleAdminConfig",
    "django.contrib.admindocs",
    "django.contrib.sitemaps",
    "django.contrib.humanize",
    # Third party Django modules
    "social_django",
    "crispy_forms",
    "compressor",
    "rest_framework",
    "rest_framework.authtoken",
    "django_filters",
]

# Custom exception reporter to include some details
DEFAULT_EXCEPTION_REPORTER_FILTER = "weblate.trans.debug.WeblateExceptionReporterFilter"

# Default logging of Weblate messages
# - to syslog in production (if available)
# - otherwise to console
# - you can also choose "logfile" to log into separate file
#   after configuring it below

# Detect if we can connect to syslog
HAVE_SYSLOG = False
if platform.system() != "Windows":
    try:
        handler = SysLogHandler(address="/dev/log", facility=SysLogHandler.LOG_LOCAL2)
        handler.close()
        HAVE_SYSLOG = True
    except IOError:
        HAVE_SYSLOG = False

if DEBUG or not HAVE_SYSLOG:
    DEFAULT_LOG = "console"
else:
    DEFAULT_LOG = "syslog"
DEFAULT_LOGLEVEL = "DEBUG" if DEBUG else "INFO"

# A sample logging configuration. The only tangible logging
# performed by this configuration is to send an email to
# the site admins on every HTTP 500 error when DEBUG=False.
# See http://docs.djangoproject.com/en/stable/topics/logging for
# more details on how to customize your logging configuration.
LOGGING = {
    "version": 1,
    "disable_existing_loggers": True,
    "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
    "formatters": {
        "syslog": {"format": "weblate[%(process)d]: %(levelname)s %(message)s"},
        "simple": {"format": "%(levelname)s %(message)s"},
        "logfile": {"format": "%(asctime)s %(levelname)s %(message)s"},
        "django.server": {
            "()": "django.utils.log.ServerFormatter",
            "format": "[%(server_time)s] %(message)s",
        },
    },
    "handlers": {
        "mail_admins": {
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
            "include_html": True,
        },
        "console": {
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "simple",
        },
        "django.server": {
            "level": "INFO",
            "class": "logging.StreamHandler",
            "formatter": "django.server",
        },
        "syslog": {
            "level": "DEBUG",
            "class": "logging.handlers.SysLogHandler",
            "formatter": "syslog",
            "address": "/dev/log",
            "facility": SysLogHandler.LOG_LOCAL2,
        },
        # Logging to a file
        # "logfile": {
        #     "level":"DEBUG",
        #     "class":"logging.handlers.RotatingFileHandler",
        #     "filename": "/var/log/weblate/weblate.log",
        #     "maxBytes": 100000,
        #     "backupCount": 3,
        #     "formatter": "logfile",
        # },
    },
    "loggers": {
        "django.request": {
            "handlers": ["mail_admins", DEFAULT_LOG],
            "level": "ERROR",
            "propagate": True,
        },
        "django.server": {
            "handlers": ["django.server"],
            "level": "INFO",
            "propagate": False,
        },
        # Logging database queries
        # "django.db.backends": {
        #     "handlers": [DEFAULT_LOG],
        #     "level": "DEBUG",
        # },
        "weblate": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Logging VCS operations
        "weblate.vcs": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Python Social Auth
        "social": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Django Authentication Using LDAP
        "django_auth_ldap": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
    },
}

# Remove syslog setup if it's not present
if not HAVE_SYSLOG:
    del LOGGING["handlers"]["syslog"]

# List of machine translations
MT_SERVICES = (
    #     "weblate.machinery.apertium.ApertiumAPYTranslation",
    #     "weblate.machinery.baidu.BaiduTranslation",
    #     "weblate.machinery.deepl.DeepLTranslation",
    #     "weblate.machinery.glosbe.GlosbeTranslation",
    #     "weblate.machinery.google.GoogleTranslation",
    #     "weblate.machinery.googlev3.GoogleV3Translation",
    #     "weblate.machinery.microsoft.MicrosoftCognitiveTranslation",
    #     "weblate.machinery.microsoftterminology.MicrosoftTerminologyService",
    #     "weblate.machinery.modernmt.ModernMTTranslation",
    #     "weblate.machinery.mymemory.MyMemoryTranslation",
    #     "weblate.machinery.netease.NeteaseSightTranslation",
    #     "weblate.machinery.tmserver.AmagamaTranslation",
    #     "weblate.machinery.tmserver.TMServerTranslation",
    #     "weblate.machinery.yandex.YandexTranslation",
    #     "weblate.machinery.saptranslationhub.SAPTranslationHub",
    #     "weblate.machinery.youdao.YoudaoTranslation",
    "weblate.machinery.weblatetm.WeblateTranslation",
    "weblate.memory.machine.WeblateMemory",
)

# Machine translation API keys

# URL of the Apertium APy server
MT_APERTIUM_APY = None

# DeepL API key
MT_DEEPL_KEY = None

# Microsoft Cognitive Services Translator API, register at
# https://portal.azure.com/
MT_MICROSOFT_COGNITIVE_KEY = None
MT_MICROSOFT_REGION = None

# ModernMT
MT_MODERNMT_KEY = None

# MyMemory identification email, see
# https://mymemory.translated.net/doc/spec.php
MT_MYMEMORY_EMAIL = None

# Optional MyMemory credentials to access private translation memory
MT_MYMEMORY_USER = None
MT_MYMEMORY_KEY = None

# Google API key for Google Translate API v2
MT_GOOGLE_KEY = None

# Google Translate API3 credentials and project id
MT_GOOGLE_CREDENTIALS = None
MT_GOOGLE_PROJECT = None

# Baidu app key and secret
MT_BAIDU_ID = None
MT_BAIDU_SECRET = None

# Youdao Zhiyun app key and secret
MT_YOUDAO_ID = None
MT_YOUDAO_SECRET = None

# Netease Sight (Jianwai) app key and secret
MT_NETEASE_KEY = None
MT_NETEASE_SECRET = None

# API key for Yandex Translate API
MT_YANDEX_KEY = None

# tmserver URL
MT_TMSERVER = None

# SAP Translation Hub
MT_SAP_BASE_URL = None
MT_SAP_SANDBOX_APIKEY = None
MT_SAP_USERNAME = None
MT_SAP_PASSWORD = None
MT_SAP_USE_MT = True

# Title of site to use
SITE_TITLE = "Weblate"

# Site domain
SITE_DOMAIN = ""

# Whether site uses https
ENABLE_HTTPS = False

# Use HTTPS when creating redirect URLs for social authentication, see
# documentation for more details:
# https://python-social-auth-docs.readthedocs.io/en/latest/configuration/settings.html#processing-redirects-and-urlopen
SOCIAL_AUTH_REDIRECT_IS_HTTPS = ENABLE_HTTPS

# Make CSRF cookie HttpOnly, see documentation for more details:
# https://docs.djangoproject.com/en/1.11/ref/settings/#csrf-cookie-httponly
CSRF_COOKIE_HTTPONLY = True
CSRF_COOKIE_SECURE = ENABLE_HTTPS
# Store CSRF token in session
CSRF_USE_SESSIONS = True
# Customize CSRF failure view
CSRF_FAILURE_VIEW = "weblate.trans.views.error.csrf_failure"
SESSION_COOKIE_SECURE = ENABLE_HTTPS
SESSION_COOKIE_HTTPONLY = True
# SSL redirect
SECURE_SSL_REDIRECT = ENABLE_HTTPS
# Sent referrrer only for same origin links
SECURE_REFERRER_POLICY = "same-origin"
# SSL redirect URL exemption list
SECURE_REDIRECT_EXEMPT = (r"healthz/$",)  # Allowing HTTP access to health check
# Session cookie age (in seconds)
SESSION_COOKIE_AGE = 1209600
# Increase allowed upload size
DATA_UPLOAD_MAX_MEMORY_SIZE = 50000000

# Apply session coookie settings to language cookie as ewll
LANGUAGE_COOKIE_SECURE = SESSION_COOKIE_SECURE
LANGUAGE_COOKIE_HTTPONLY = SESSION_COOKIE_HTTPONLY
LANGUAGE_COOKIE_AGE = SESSION_COOKIE_AGE * 10

# Some security headers
SECURE_BROWSER_XSS_FILTER = True
X_FRAME_OPTIONS = "DENY"
SECURE_CONTENT_TYPE_NOSNIFF = True

# Optionally enable HSTS
SECURE_HSTS_SECONDS = 31536000 if ENABLE_HTTPS else 0
SECURE_HSTS_PRELOAD = ENABLE_HTTPS
SECURE_HSTS_INCLUDE_SUBDOMAINS = ENABLE_HTTPS

# HTTPS detection behind reverse proxy
SECURE_PROXY_SSL_HEADER = None

# URL of login
LOGIN_URL = "{0}/accounts/login/".format(URL_PREFIX)

# URL of logout
LOGOUT_URL = "{0}/accounts/logout/".format(URL_PREFIX)

# Default location for login
LOGIN_REDIRECT_URL = "{0}/".format(URL_PREFIX)

# Anonymous user name
ANONYMOUS_USER_NAME = "anonymous"

# Reverse proxy settings
IP_PROXY_HEADER = "HTTP_X_FORWARDED_FOR"
IP_BEHIND_REVERSE_PROXY = False
IP_PROXY_OFFSET = 0

# Sending HTML in mails
EMAIL_SEND_HTML = True

# Subject of emails includes site title
EMAIL_SUBJECT_PREFIX = "[{0}] ".format(SITE_TITLE)

# Enable remote hooks
ENABLE_HOOKS = True

# By default the length of a given translation is limited to the length of
# the source string * 10 characters. Set this option to False to allow longer
# translations (up to 10.000 characters)
LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH = True

# Use simple language codes for default language/country combinations
SIMPLIFY_LANGUAGES = True

# Render forms using bootstrap
CRISPY_TEMPLATE_PACK = "bootstrap3"

# List of quality checks
# CHECK_LIST = (
#     "weblate.checks.same.SameCheck",
#     "weblate.checks.chars.BeginNewlineCheck",
#     "weblate.checks.chars.EndNewlineCheck",
#     "weblate.checks.chars.BeginSpaceCheck",
#     "weblate.checks.chars.EndSpaceCheck",
#     "weblate.checks.chars.DoubleSpaceCheck",
#     "weblate.checks.chars.EndStopCheck",
#     "weblate.checks.chars.EndColonCheck",
#     "weblate.checks.chars.EndQuestionCheck",
#     "weblate.checks.chars.EndExclamationCheck",
#     "weblate.checks.chars.EndEllipsisCheck",
#     "weblate.checks.chars.EndSemicolonCheck",
#     "weblate.checks.chars.MaxLengthCheck",
#     "weblate.checks.chars.KashidaCheck",
#     "weblate.checks.chars.PuctuationSpacingCheck",
#     "weblate.checks.format.PythonFormatCheck",
#     "weblate.checks.format.PythonBraceFormatCheck",
#     "weblate.checks.format.PHPFormatCheck",
#     "weblate.checks.format.CFormatCheck",
#     "weblate.checks.format.PerlFormatCheck",
#     "weblate.checks.format.JavaScriptFormatCheck",
#     "weblate.checks.format.CSharpFormatCheck",
#     "weblate.checks.format.JavaFormatCheck",
#     "weblate.checks.format.JavaMessageFormatCheck",
#     "weblate.checks.format.PercentPlaceholdersCheck",
#     "weblate.checks.format.I18NextInterpolationCheck",
#     "weblate.checks.format.ESTemplateLiteralsCheck",
#     "weblate.checks.angularjs.AngularJSInterpolationCheck",
#     "weblate.checks.qt.QtFormatCheck",
#     "weblate.checks.qt.QtPluralCheck",
#     "weblate.checks.ruby.RubyFormatCheck",
#     "weblate.checks.consistency.PluralsCheck",
#     "weblate.checks.consistency.SamePluralsCheck",
#     "weblate.checks.consistency.ConsistencyCheck",
#     "weblate.checks.consistency.TranslatedCheck",
#     "weblate.checks.chars.EscapedNewlineCountingCheck",
#     "weblate.checks.chars.NewLineCountCheck",
#     "weblate.checks.markup.BBCodeCheck",
#     "weblate.checks.chars.ZeroWidthSpaceCheck",
#     "weblate.checks.render.MaxSizeCheck",
#     "weblate.checks.markup.XMLValidityCheck",
#     "weblate.checks.markup.XMLTagsCheck",
#     "weblate.checks.markup.MarkdownRefLinkCheck",
#     "weblate.checks.markup.MarkdownLinkCheck",
#     "weblate.checks.markup.MarkdownSyntaxCheck",
#     "weblate.checks.markup.URLCheck",
#     "weblate.checks.markup.SafeHTMLCheck",
#     "weblate.checks.placeholders.PlaceholderCheck",
#     "weblate.checks.placeholders.RegexCheck",
#     "weblate.checks.duplicate.DuplicateCheck",
#     "weblate.checks.source.OptionalPluralCheck",
#     "weblate.checks.source.EllipsisCheck",
#     "weblate.checks.source.MultipleFailingCheck",
#     "weblate.checks.source.LongUntranslatedCheck",
#     "weblate.checks.format.MultipleUnnamedFormatsCheck",
# )

# List of automatic fixups
# AUTOFIX_LIST = (
#     "weblate.trans.autofixes.whitespace.SameBookendingWhitespace",
#     "weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis",
#     "weblate.trans.autofixes.chars.RemoveZeroSpace",
#     "weblate.trans.autofixes.chars.RemoveControlChars",
# )

# List of enabled addons
# WEBLATE_ADDONS = (
#     "weblate.addons.gettext.GenerateMoAddon",
#     "weblate.addons.gettext.UpdateLinguasAddon",
#     "weblate.addons.gettext.UpdateConfigureAddon",
#     "weblate.addons.gettext.MsgmergeAddon",
#     "weblate.addons.gettext.GettextCustomizeAddon",
#     "weblate.addons.gettext.GettextAuthorComments",
#     "weblate.addons.cleanup.CleanupAddon",
#     "weblate.addons.consistency.LangaugeConsistencyAddon",
#     "weblate.addons.discovery.DiscoveryAddon",
#     "weblate.addons.flags.SourceEditAddon",
#     "weblate.addons.flags.TargetEditAddon",
#     "weblate.addons.flags.SameEditAddon",
#     "weblate.addons.flags.BulkEditAddon",
#     "weblate.addons.generate.GenerateFileAddon",
#     "weblate.addons.json.JSONCustomizeAddon",
#     "weblate.addons.properties.PropertiesSortAddon",
#     "weblate.addons.git.GitSquashAddon",
#     "weblate.addons.removal.RemoveComments",
#     "weblate.addons.removal.RemoveSuggestions",
#     "weblate.addons.resx.ResxUpdateAddon",
#     "weblate.addons.yaml.YAMLCustomizeAddon",
#     "weblate.addons.cdn.CDNJSAddon",
#     "weblate.addons.autotranslate.AutoTranslateAddon",
# )

# E-mail address that error messages come from.
SERVER_EMAIL = "noreply@example.com"

# Default email address to use for various automated correspondence from
# the site managers. Used for registration emails.
DEFAULT_FROM_EMAIL = "noreply@example.com"

# List of URLs your site is supposed to serve
ALLOWED_HOSTS = [SITE_DOMAIN]

# Configuration for caching
CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        # If redis is running on same host as Weblate, you might
        # want to use unix sockets instead:
        # "LOCATION": "unix:///var/run/redis/redis.sock?db=1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            "PARSER_CLASS": "redis.connection.HiredisParser",
            "PASSWORD": None,
            "CONNECTION_POOL_KWARGS": {},
        },
        "KEY_PREFIX": "weblate",
    },
    "avatar": {
        "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
        "LOCATION": os.path.join(DATA_DIR, "avatar-cache"),
        "TIMEOUT": 86400,
        "OPTIONS": {"MAX_ENTRIES": 1000},
    },
}

# Store sessions in cache
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
# Store messages in session
MESSAGE_STORAGE = "django.contrib.messages.storage.session.SessionStorage"

# REST framework settings for API
REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    "DEFAULT_PERMISSION_CLASSES": [
        # Require authentication for login required sites
        "rest_framework.permissions.IsAuthenticated"
        if REQUIRE_LOGIN
        else "rest_framework.permissions.IsAuthenticatedOrReadOnly"
    ],
    "DEFAULT_AUTHENTICATION_CLASSES": (
        "rest_framework.authentication.TokenAuthentication",
        "weblate.api.authentication.BearerAuthentication",
        "rest_framework.authentication.SessionAuthentication",
    ),
    "DEFAULT_THROTTLE_CLASSES": (
        "weblate.api.throttling.UserRateThrottle",
        "weblate.api.throttling.AnonRateThrottle",
    ),
    "DEFAULT_THROTTLE_RATES": {"anon": "100/day", "user": "5000/hour"},
    "DEFAULT_PAGINATION_CLASS": ("rest_framework.pagination.PageNumberPagination"),
    "PAGE_SIZE": 20,
    "VIEW_DESCRIPTION_FUNCTION": "weblate.api.views.get_view_description",
    "UNAUTHENTICATED_USER": "weblate.auth.models.get_anonymous",
}

# Fonts CDN URL
FONTS_CDN_URL = None

# Django compressor offline mode
COMPRESS_OFFLINE = False
COMPRESS_OFFLINE_CONTEXT = [
    {"fonts_cdn_url": FONTS_CDN_URL, "STATIC_URL": STATIC_URL, "LANGUAGE_BIDI": True},
    {"fonts_cdn_url": FONTS_CDN_URL, "STATIC_URL": STATIC_URL, "LANGUAGE_BIDI": False},
]

# Require login for all URLs
if REQUIRE_LOGIN:
    LOGIN_REQUIRED_URLS = (r"/(.*)$",)

# In such case you will want to include some of the exceptions
# LOGIN_REQUIRED_URLS_EXCEPTIONS = (
#    rf"{URL_PREFIX}/accounts/(.*)$",  # Required for login
#    rf"{URL_PREFIX}/admin/login/(.*)$",  # Required for admin login
#    rf"{URL_PREFIX}/static/(.*)$",  # Required for development mode
#    rf"{URL_PREFIX}/widgets/(.*)$",  # Allowing public access to widgets
#    rf"{URL_PREFIX}/data/(.*)$",  # Allowing public access to data exports
#    rf"{URL_PREFIX}/hooks/(.*)$",  # Allowing public access to notification hooks
#    rf"{URL_PREFIX}/healthz/$",  # Allowing public access to health check
#    rf"{URL_PREFIX}/api/(.*)$",  # Allowing access to API
#    rf"{URL_PREFIX}/js/i18n/$",  # JavaScript localization
#    rf"{URL_PREFIX}/contact/$",  # Optional for contact form
#    rf"{URL_PREFIX}/legal/(.*)$",  # Optional for legal app
# )

# Silence some of the Django system checks
SILENCED_SYSTEM_CHECKS = [
    # We have modified django.contrib.auth.middleware.AuthenticationMiddleware
    # as weblate.accounts.middleware.AuthenticationMiddleware
    "admin.E408"
]

# Celery worker configuration for testing
# CELERY_TASK_ALWAYS_EAGER = True
# CELERY_BROKER_URL = "memory://"
# CELERY_TASK_EAGER_PROPAGATES = True
# Celery worker configuration for production
CELERY_TASK_ALWAYS_EAGER = False
CELERY_BROKER_URL = "redis://localhost:6379"
CELERY_RESULT_BACKEND = CELERY_BROKER_URL

# Celery settings, it is not recommended to change these
CELERY_WORKER_MAX_MEMORY_PER_CHILD = 200000
CELERY_BEAT_SCHEDULE_FILENAME = os.path.join(DATA_DIR, "celery", "beat-schedule")
CELERY_TASK_ROUTES = {
    "weblate.trans.tasks.auto_translate": {"queue": "translate"},
    "weblate.accounts.tasks.notify_*": {"queue": "notify"},
    "weblate.accounts.tasks.send_mails": {"queue": "notify"},
    "weblate.utils.tasks.settings_backup": {"queue": "backup"},
    "weblate.utils.tasks.database_backup": {"queue": "backup"},
    "weblate.wladmin.tasks.backup": {"queue": "backup"},
    "weblate.wladmin.tasks.backup_service": {"queue": "backup"},
}

# Enable plain database backups
DATABASE_BACKUP = "plain"

# Enable auto updating
AUTO_UPDATE = False

# PGP commits signing
WEBLATE_GPG_IDENTITY = None

# Third party services integration
MATOMO_SITE_ID = None
MATOMO_URL = None
GOOGLE_ANALYTICS_ID = None
SENTRY_DSN = None
AKISMET_API_KEY = None

Órdenes de gestión¶

Nota

Running management commands under a different user than the one running your webserver can result in files getting wrong permissions, please check Permisos del sistema de archivos for more details.

You will find basic management commands (available as ./manage.py in the Django sources, or as an extended set in a script called weblate installable atop Weblate).

Invocar órdenes de gestión¶

Como ya se mencionó, la invocación dependerá de cómo instaló Weblate.

If using virtualenv for Weblate, you can either specify the full path to weblate, or activate the virtualenv prior to invoking it:

# Direct invocation
~/weblate-env/bin/weblate

# Activating virtualenv adds it to search path
. ~/weblate-env/bin/activate
weblate

If you are using source code directly (either from a tarball or Git checkout), the management script is ./manage.py available in the Weblate sources. To run it:

python ./manage.py list_versions

If you’ve installed Weblate using the pip or pip3 installer, or by using the ./setup.py script, the weblate is installed to your path (or virtualenv path), from where you can use it to control Weblate:

weblate list_versions

For the Docker image, the script is installed like above, and you can run it using docker exec:

docker exec --user weblate <container> weblate list_versions

For docker-compose the process is similar, you just have to use docker-compose exec:

docker-compose exec --user weblate weblate weblate list_versions

In case you need to pass it a file, you can temporary add a volume:

docker-compose exec --user weblate /tmp:/tmp weblate weblate importusers /tmp/users.json

Ver también

Instalar con Docker, Instalar en Debian y Ubuntu, Instalar en SUSE y openSUSE, Instalar en Red Hat, Fedora y CentOS

Installing from sources, recommended for development.

add_suggestions¶

weblate add_suggestions <project> <component> <language> <file>¶

Nuevo en la versión 2.5.

Imports a translation from the file to use as a suggestion for the given translation. It skips duplicated translations; only different ones are added.

--author USER@EXAMPLE.COM¶: E-mail of author for the suggestions. This user has to exist prior to importing (you can create one in the admin interface if needed).

Ejemplo:

weblate --author michal@cihar.com add_suggestions weblate application cs /tmp/suggestions-cs.po

auto_translate¶

weblate auto_translate <project> <component> <language>¶

Nuevo en la versión 2.5.

Realiza traducciones automáticas basadas en las traducciones de otros componentes.

--source PROJECT/COMPONENT¶: Specifies the component to use as source available for translation. If not specified all components in the project are used.

--user USERNAME¶: Specify username listed as author of the translations. «Anonymous user» is used if not specified.

--overwrite¶: Whether to overwrite existing translations.

--inconsistent¶: Whether to overwrite existing translations that are inconsistent (see Incoherente).

--add¶: Automatically add language if a given translation does not exist.

--mt MT¶: Use machine translation instead of other components as machine translations.

--threshold THRESHOLD¶: Similarity threshold for machine translation, defaults to 80.

Ejemplo:

weblate auto_translate --user nijel --inconsistent --source weblate/application weblate website cs

Ver también

Traducción automática

celery_queues¶

weblate celery_queues¶

Nuevo en la versión 3.7.

Displays length of Celery task queues.

checkgit¶

weblate checkgit <project|project/component>¶

Prints current state of the back-end Git repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

commitgit¶

weblate commitgit <project|project/component>¶

Commits any possible pending changes to the back-end Git repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

commit_pending¶

weblate commit_pending <project|project/component>¶

Commits pending changes older than a given age.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

--age HOURS¶: Age in hours for committing. If not specified the value configured in Configuración de componentes is used.

Nota

This is automatically performed in the background by Weblate, so there no real need to invoke this manually, besides forcing an earlier commit than specified by Configuración de componentes.

Ver también

Efectuar tareas de mantenimiento, COMMIT_PENDING_HOURS

cleanuptrans¶

weblate cleanuptrans¶

Cleans up orphaned checks and translation suggestions. There is normally no need to run this manually, as the cleanups happen automatically in the background.

Ver también

Efectuar tareas de mantenimiento

createadmin¶

weblate createadmin¶

Creates an admin account with a random password, unless it is specified.

--password PASSWORD¶: Permite proporcionar una contraseña mediante la línea de órdenes, de modo que no se genere una aleatoria.

--no-password¶: Do not set password, this can be useful with –update.

--username USERNAME¶: Use the given name instead of admin.

--email USER@EXAMPLE.COM¶: Specify the admin e-mail address.

--name¶: Specify the admin name (visible).

--update¶: Update the existing user (you can use this to change passwords).

Distinto en la versión 2.9: Added parameters --username, --email, --name and --update.

dump_memory¶

weblate dump_memory¶

Nuevo en la versión 2.20.

Export a JSON file containing Weblate Translation Memory content.

Ver también

Memoria de traducción, Weblate Translation Memory Schema

dumpuserdata¶

weblate dumpuserdata <file.json>¶

Dumps userdata to a file for later use by importuserdata

Consejo

Esto resulta útil cuando hay que migrar o fusionar instalaciones de Weblate.

import_demo¶

weblate import_demo¶

Nuevo en la versión 4.1.

Creates a demo project with components based on <https://github.com/WeblateOrg/demo>.

Puede ser de utilidad si está desarrollando Weblate.

import_json¶

weblate import_json <json-file>¶

Nuevo en la versión 2.7.

Batch import of components based on JSON data.

The imported JSON file structure pretty much corresponds to the component object (see GET /api/components/(string:project)/(string:component)/). You have to include the name and filemask fields.

--project PROJECT¶: Specifies where the components will be imported from.

--main-component COMPONENT¶: Use the given VCS repository from this component for all of them.

--ignore¶: Skip (already) imported components.

--update¶: Update (already) imported components.

Distinto en la versión 2.9: The parameters --ignore and --update are there to deal with already imported components.

Ejemplo de archivo JSON:

[
  {
    "slug": "po",
    "name": "Gettext PO",
    "file_format": "po",
    "filemask": "po/*.po",
    "new_lang": "none"
  },
  {
    "name": "Android",
    "filemask": "android/values-*/strings.xml",
    "template": "android/values/strings.xml",
    "repo": "weblate://test/test",
    "file_format": "aresource"
  }
]

Ver también

import_memory

import_memory¶

weblate import_memory <file>¶

Nuevo en la versión 2.20.

Importa un archivo TMX o JSON en la memoria de traducción de Weblate.

--language-map LANGMAP¶

Allows mapping languages in the TMX to the Weblate translation memory. The language codes are mapped after normalization usually done by Weblate.

--language-map en_US:en will for example import all en_US strings as en ones.

This can be useful in case your TMX file locales happen not to match what you use in Weblate.

Ver también

Memoria de traducción, Weblate Translation Memory Schema

import_project¶

weblate import_project <project> <gitrepo> <branch> <filemask>¶

Distinto en la versión 3.0: The import_project command is now based on the Descubrimiento de componentes addon, leading to some changes in behavior and what parameters are accepted.

Batch imports components into project based on filemask.

<project> names an existing project, into which the components are to be imported.

The <gitrepo> defines the Git repository URL to use, and <branch> signifies the Git branch. To import additional translation components from an existing Weblate component, use a weblate://<project>/<component> URL for the <gitrepo>.

The <filemask> defines file discovery for the repository. It can be either be made simple using wildcards, or it can use the full power of regular expressions.

The simple matching uses ** for component name and * for language, for example: **/*.po

The regular expression has to contain groups named component and language. For example: (?P<language>[^/]*)/(?P<component>[^-/]*)\.po

The import matches existing components based on files and adds the ones that do not exist. It does not change already existing ones.

--name-template TEMPLATE¶

Customize the name of a component using Django template syntax.

For example: Documentation: {{ component }}

--base-file-template TEMPLATE¶

Customize the base file for monolingual translations.

For example: {{ component }}/res/values/string.xml

--new-base-template TEMPLATE¶

Customize the base file for addition of new translations.

For example: {{ component }}/ts/en.ts

--file-format FORMAT¶: You can also specify the file format to use (see Formatos de archivo admitidos), the default is auto-detection.

--language-regex REGEX¶: You can specify language filtering (see Configuración de componentes) with this parameter. It has to be a valid regular expression.

--main-component¶: You can specify which component will be chosen as the main one—the one actually containing the VCS repository.

--license NAME¶: Specify the overall, project or component translation license.

--license-url URL¶: Specify the URL where the translation license is to be found.

--vcs NAME¶: In case you need to specify which version control system to use, you can do it here. The default version control is Git.

To give you some examples, let’s try importing two projects.

First The Debian Handbook translations, where each language has separate a folder with the translations of each chapter:

weblate import_project \
    debian-handbook \
    git://anonscm.debian.org/debian-handbook/debian-handbook.git \
    squeeze/master \
    '*/**.po'

Then the Tanaguru tool, where the file format needs be specified, along with the base file template, and how all components and translations are located in single folder:

weblate import_project \
    --file-format=properties \
    --base-file-template=web-app/tgol-web-app/src/main/resources/i18n/%s-I18N.properties \
    tanaguru \
    https://github.com/Tanaguru/Tanaguru \
    master \
    web-app/tgol-web-app/src/main/resources/i18n/**-I18N_*.properties

More complex example of parsing of filenames to get the correct component and language out of a filename like src/security/Numerous_security_holes_in_0.10.1.de.po:

weblate import_project \
    tails \
    git://git.tails.boum.org/tails master \
    'wiki/src/security/(?P<component>.*)\.(?P<language>[^.]*)\.po$'

Filtering only translations in a chosen language:

./manage import_project \
    --language-regex '^(cs|sk)$' \
    weblate \
    https://github.com/WeblateOrg/weblate.git \
    'weblate/locale/*/LC_MESSAGES/**.po'

Importing Sphinx documentation split to multiple files:

$ weblate import_project --name-template 'Documentation: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/**.po'

Importing Sphinx documentation split to multiple files and directories:

$ weblate import_project --name-template 'Directory 1: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/dir1/**.po'
$ weblate import_project --name-template 'Directory 2: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/dir2/**.po'

Ver también

More detailed examples can be found in the Starting with internationalization chapter, alternatively you might want to use import_json.

importuserdata¶

weblate importuserdata <file.json>¶

Imports user data from a file created by dumpuserdata

importusers¶

weblate importusers --check <file.json>¶

Imports users from JSON dump of the Django auth_users database.

--check¶: With this option it will just check whether a given file can be imported and report possible conflicts arising from usernames or e-mails.

You can dump users from the existing Django installation using:

weblate dumpdata auth.User > users.json

install_addon¶

Nuevo en la versión 3.2.

weblate install_addon --addon ADDON <project|project/component>¶

Installs an addon to a set of components.

--addon ADDON¶: Name of the addon to install. For example weblate.gettext.customize.

--configuration CONFIG¶: JSON encoded configuration of an addon.

--update¶: Update the existing addon configuration.

You can either define which project or component to install the addon in (for example weblate/application), or use --all to include all existing components.

To install Personalizar la salida de gettext for all components:

weblate install_addon --addon weblate.gettext.customize --config '{"width": -1}' --update --all

Ver también

Complementos

list_languages¶

weblate list_languages <locale>¶

Lists supported languages in MediaWiki markup - language codes, English names and localized names.

This is used to generate <https://wiki.l10n.cz/Jazyky>.

list_translators¶

weblate list_translators <project|project/component>¶

Lists translators by contributed language for the given project:

[French]
Jean Dupont <jean.dupont@example.com>
[English]
John Doe <jd@example.com>

--language-code¶: List names by language code instead of language name.

You can either define which project or component to use (for example weblate/application), or use --all to list translators from all existing components.

list_versions¶

weblate list_versions¶

Lists all Weblate dependencies and their versions.

loadpo¶

weblate loadpo <project|project/component>¶

Reloads translations from disk (for example in case you have done some updates in the VCS repository).

--force¶: Force update, even if the files should be up-to-date.

--lang LANGUAGE¶: Limit processing to a single language.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

Nota

You seldom need to invoke this, Weblate will automatically load changed files for every VCS update. This is needed in case you manually changed an underlying Weblate VCS repository or in some special cases following an upgrade.

lock_translation¶

weblate lock_translation <project|project/component>¶

Prevents further translation of a component.

Consejo

Useful in case you want to do some maintenance on the underlying repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

Ver también

unlock_translation

move_language¶

weblate move_language source target¶

Nuevo en la versión 3.0.

Allows you to merge language content. This is useful when updating to a new version which contains aliases for previously unknown languages that have been created with the (generated) suffix. It moves all content from the source language to the target one.

Ejemplo:

weblate move_language cze cs

After moving the content, you should check whether there is anything left (this is subject to race conditions when somebody updates the repository meanwhile) and remove the (generated) language.

pushgit¶

weblate pushgit <project|project/component>¶

Pushes committed changes to the upstream VCS repository.

--force-commit¶: Force commits any pending changes, prior to pushing.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

Nota

Weblate pushes changes automatically if Push on commit in Configuración de componentes is turned on, which is the default.

unlock_translation¶

weblate unlock_translation <project|project/component>¶

Unlocks a given component, making it available for translation.

Consejo

Useful in case you want to do some maintenance on the underlying repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

Ver también

lock_translation

setupgroups¶

weblate setupgroups¶

Configures default groups and optionally assigns all users to that default group.

--no-privs-update¶: Turns off automatic updating of existing groups (only adds new ones).

--no-projects-update¶: Prevents automatic updates of groups for existing projects. This allows adding newly added groups to existing projects, see Control de acceso por proyecto.

Ver también

Control de acceso

setuplang¶

weblate setuplang¶

Updates list of defined languages in Weblate.

--no-update¶: Turns off automatic updates of existing languages (only adds new ones).

updatechecks¶

weblate updatechecks <project|project/component>¶

Updates all checks for all strings.

Consejo

Useful for upgrades which do major changes to checks.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

updategit¶

weblate updategit <project|project/component>¶

Fetches remote VCS repositories and updates the internal cache.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

Nota

Usually it is better to configure hooks in the repository to trigger Actuadores de notificaciones, instead of regular polling by updategit.

Anuncios¶

Distinto en la versión 4.0: En versiones anteriores, esta prestación se denominaba «mensajes en pizarra».

Provide info to your translators by posting announcements, site-wide, per project, component, or language.

Announce the purpose, deadlines, status, or specify targets for translation.

Los usuarios recibirán una notificación por cada anuncio en los proyectos a los que se han suscrito (salvo que decidan no recibirlas).

This can be useful for various things from announcing the purpose of the website to specifying targets for translations.

The announcements can posted on each level in the Manage menu, using Post announcement:

Image showing a message that reads: "Translations will be used only if they reach 60%" atop the dashboard view.

It can be also added using the admin interface:

The announcements are then shown based on their specified context:

No context specified

Shown on dashboard (landing page).

Project specified

Shown within the project, including all its components and translations.

Component specified

Shown for a given component and all its translations.

Language specified

Shown on the language overview and all translations in that language.

This is how it looks on the language overview page:

Image showing a message that reads: "Czech translators rock!" atop the Czech language overview.

Listas de componentes¶

Specify multiple lists of components to appear as options on the user dashboard, from which users can pick one as their default view. See Cuadro de mando to learn more.

Distinto en la versión 2.20: A status will be presented for each component list presented on the dashboard.

The names and content of component lists can be specified in the admin interface, in Component lists section. Each component list must have a name that is displayed to the user, and a slug representing it in the URL.

Distinto en la versión 2.13: Change dashboard settings for anonymous users from the admin interface, altering what dashboard is presented to unauthenticated users.

Listas de componentes automáticas¶

Nuevo en la versión 2.13.

Add components to the list automatically based on their slug by creating Automatic component list assignment rules.

Useful for maintaining component lists for large installations, or in case you want to have one component list with all components on your Weblate installation.

Consejo

Make a component list containing all the components of your Weblate installation.

1. Define Automatic component list assignment with ^.*$ as regular expression in both the project and the component fields, as shown on this image:

Image showing the Weblate aministration panel with the above configuration filled in.

Módulos opcionales de Weblate¶

Several optional modules are available for your setup.

Git exporter¶

Nuevo en la versión 2.10.

Provides you read-only access to the underlying Git repository using HTTP(S).

Instalación¶

Add weblate.gitexport to installed apps in settings.py:

INSTALLED_APPS += (
    'weblate.gitexport',
)

Export existing repositories by migrating your database after installation:

weblate migrate

Usage¶

The module automatically hooks into Weblate and sets the exported repository URL in the Configuración de componentes. The repositories are accessible under the /git/ part of the Weblate URL, for example https://example.org/git/weblate/master/:

git clone 'https://example.org/git/weblate/master/'

Repositories are available anonymously unless Control de acceso por proyecto is turned on. This requires authenticate using your API token (it can be obtained in your Perfil de usuario):

git clone 'https://user:KEY@example.org/git/weblate/master/'

Facturación¶

Nuevo en la versión 2.4.

This is used on Hosted Weblate to define billing plans, track invoices and usage limits.

Instalación¶

1. Add weblate.billing to installed apps in settings.py:

INSTALLED_APPS += (
    'weblate.billing',
)

Run the database migration to optionally install additional database structures for the module:

weblate migrate

Usage¶

After installation you can control billing in the admin interface. Users with billing enabled will get new Billing tab in their Perfil de usuario.

The billing module additionally allows project admins to create new projects and components without being superusers (see Añadir proyectos y componentes de traducción). This is possible when following conditions are met:

The billing is in its configured limits (any overusage results in blocking of project/component creation) and paid (if its price is non zero)
The user is admin of existing project with billing or user is owner of billing (the latter is necessary when creating new billing for users to be able to import new projects).

Upon project creation user is able to choose which billing should be charged for the project in case he has access to more of them.

Información legal¶

Nuevo en la versión 2.15.

This is used on Hosted Weblate to provide required legal documents. It comes provided with blank documents, and you are expected to fill out the following templates in the documents:

legal/documents/tos.html: Terms of service document
legal/documents/privacy.html: Privacy policy document
legal/documents/summary.html: Short overview of the terms of service and privacy policy

Nota

Legal documents for the Hosted Weblate service is available in this Git repository <https://github.com/WeblateOrg/hosted/tree/master/wlhosted/legal/templates/legal/documents>.

Most likely these will not be directly usable to you, but might come in handy as a starting point if adjusted to meet your needs.

Instalación¶

1. Add weblate.legal to installed apps in settings.py:

INSTALLED_APPS += (
    'weblate.legal',
)

# Optional:

# Social auth pipeline to confirm TOS upon registration/subsequent login
SOCIAL_AUTH_PIPELINE += (
    'weblate.legal.pipeline.tos_confirm',
)

# Middleware to enforce TOS confirmation of signed in users
MIDDLEWARE += [
    'weblate.legal.middleware.RequireTOSMiddleware',
]

Run the database migration to optionally install additional database structures for the module:

weblate migrate

Edit the legal documents in the weblate/legal/templates/legal/ folder to match your service.

Usage¶

After installation and editing, the legal documents are shown in the Weblate UI.

Avatars¶

Avatars are downloaded and cached server-side to reduce information leaks to the sites serving them by default. The built-in support for fetching avatars from e-mails addresses configured for it can be turned off using ENABLE_AVATARS.

Weblate currently supports:

Gravatar

Ver también

Caché de avatars, AVATAR_URL_PREFIX, ENABLE_AVATARS

Spam protection¶

You can protect against suggestion spamming by unauthenticated users by using the akismet.com service.

Install the akismet Python module
Configure the Akismet API key.

Nota

This (among other things) relies on IP address of the client, please see Running behind reverse proxy for properly configuring that.

Ver también

Running behind reverse proxy, AKISMET_API_KEY

Signing Git commits with GnuPG¶

Nuevo en la versión 3.1.

All commits can be signed by the GnuPG key of the Weblate instance.

1. Turn on WEBLATE_GPG_IDENTITY. (Weblate will generate a GnuPG key when needed and will use it to sign all translation commits.)

This feature needs GnuPG 2.1 or newer installed.

You can find the key in the DATA_DIR and the public key is shown on the «About» page:

2. Alternatively you can also import existing keys into Weblate, just set HOME=$DATA_DIR/home when invoking gpg.

Ver también

WEBLATE_GPG_IDENTITY

Rate limiting¶

Distinto en la versión 3.2: The rate limiting now accepts more fine-grained configuration.

Several operations in Weblate are rate limited. At most RATELIMIT_ATTEMPTS attempts are allowed within RATELIMIT_WINDOW seconds. The user is then blocked for RATELIMIT_LOCKOUT. There are also settings specific to scopes, for example RATELIMIT_CONTACT_ATTEMPTS or RATELIMIT_TRANSLATE_ATTEMPTS. The table below is a full list of available scopes.

The following operations are subject to rate limiting:

Nombre	Alcance	Intentos permitidos	Oportunidad del límite de velocidad	Período de bloqueo
Registro	`REGISTRATION`	5	300	600
Enviar un mensaje a los administradores	`MESSAGE`	5	300	600
Autenticación por contraseña al acceder	`LOGIN`	5	300	600
Búsqueda en todo el sitio	`SEARCH`	6	60	60
Traducción	`TRANSLATE`	30	60	600
Adición al glosario	`GLOSSARY`	30	60	600

If a user fails to log in AUTH_LOCK_ATTEMPTS times, password authentication will be turned off on the account until having gone through the process of having its password reset.

Ver también

Rate limiting, Running behind reverse proxy

Personalizar Weblate¶

Extend and customize using Django and Python. Contribute your changes upstream so that everybody can benefit. This reduces your maintenance costs; code in Weblate is taken care of when changing internal interfaces or refactoring the code.

Advertencia

Neither internal interfaces nor templates are considered a stable API. Please review your own customizations for every upgrade, the interfaces or their semantics might change without notice.

Ver también

Contributing to Weblate

Crear un módulo Python¶

If you are not familiar with Python, you might want to look into Python For Beginners, explaining the basics and pointing to further tutorials.

To write some custom Python code (called a module), a place to store it is needed, either in the system path (usually something like /usr/lib/python3.7/site-packages/) or in the Weblate directory, which is also added to the interpreter search path.

Better yet, turn your customization into a proper Python package:

Create a folder for your package (we will use weblate_customization).

within it, create a setup.py file to describe the package:

from setuptools import setup

setup(
    name = "weblate_customization",
    version = "0.0.1",
    author = "Your name",
    author_email = "yourname@example.com",
    description = "Sample Custom check for Weblate.",
    license = "GPLv3+",
    keywords = "Weblate check example",
    packages=['weblate_customization'],
)

Create a folder for the Python module (also called weblate_customization) for the customization code.
Within it, create a __init__.py file to make sure Python can import the module.
This package can now be installed using pip install -e. More info to be found in “Editable” Installs.
Once installed, the module can be used in the Weblate configuration (for example weblate_customization.checks.FooCheck).

La estructura de su módulo debería lucir similar a esta:

weblate_customization
├── setup.py
└── weblate_customization
    ├── __init__.py
    ├── addons.py
    └── checks.py

You can find an example of customizing Weblate at <https://github.com/WeblateOrg/customize-example>, it covers all the topics described below.

Cambiar el logo¶

1. Create a simple Django app containing the static files you want to overwrite (see Crear un módulo Python).

Add it to INSTALLED_APPS:

INSTALLED_APPS = (
   # Add your customization as first
   'weblate_customization',

   # Weblate apps are here…
)

Branding appears in the following files:

icons/weblate.svg: Logo mostrado en la barra de navegación.
logo-*.png: Web icons depending on screen resolution and web-browser.
favicon.ico: Icono web empleado por navegadores obsoletos.
weblate-*.png: Avatars for bots or anonymous users. Some web-browsers use these as shortcut icons.
email-logo.png: Used in notifications e-mails.

Run weblate collectstatic --noinput, to collect static files served to clients.

Ver también

Managing static files (e.g. images, JavaScript, CSS), Serving static files

Comprobaciones de calidad, complementos y correcciones automáticas personalizadas¶

To install your code for Custom automatic fixups, Writing own checks or Writing addon and in Weblate:

Place the files in your Python module containing the Weblate customization (see Crear un módulo Python).
Add its fully-qualified path to the Python class in the dedicated settings (WEBLATE_ADDONS, CHECK_LIST or AUTOFIX_LIST):

# Checks
CHECK_LIST += (
    'weblate_customization.checks.FooCheck',
)

# Autofixes
AUTOFIX_LIST += (
  'weblate_customization.autofix.FooFixer',
)

# Addons
WEBLATE_ADDONS += (
  'weblate_customization.addons.ExamplePreAddon',
)

Ver también

Custom automatic fixups:, Writing own checks, Writing addon, Executing scripts from addon

Interfaz de gestión¶

The management interface offer administration settings under the /management/ URL. It is available for users signed in with admin privileges, accessible by using the wrench icon top right:

La interfaz administrativa de Django¶

Advertencia

Will be removed in the future, as its use is discouraged—most features can be managed directly in Weblate.

Aquí puede gestionar los objetos almacenados en la base de datos, tales como usuarios, traducciones y determinadas configuraciones:

In the Reports section, you can check the status of your site, tweak it for Production setup, or manage SSH keys used to access Accessing repositories.

Manage database objects under any of the sections. The most interesting one is probably Weblate translations, where you can manage translatable projects, see Configuración de proyectos and Configuración de componentes.

Weblate languages holds language definitions, explained further in Language definitions.

Añadir un proyecto¶

Adding a project serves as container for all components. Usually you create one project for one piece of software, or book (See Configuración de proyectos for info on individual parameters):

Ver también

Configuración de proyectos

Componentes bilingües¶

Once you have added a project, translation components can be added to it. (See Configuración de componentes for info regarding individual parameters):

Ver también

Configuración de componentes, Formatos bilingües y monolingües

Componentes monolingües¶

For easier translation of these, provide a template file containing the mapping of message IDs to its respective source language (usually English). (See Configuración de componentes for info regarding individual parameters):

Ver también

Configuración de componentes, Formatos bilingües y monolingües

Obtener ayuda con Weblate¶

Weblate es software libre, de licencia copyleft, con asistencia comunitaria. Los suscriptores reciben asistencia prioritaria sin ningún costo adicional. Hay paquetes de ayuda prepagados disponibles para todos. Hallará más información relativa a las opciones de asistencia actuales en <https://weblate.org/es/support/>.

Integrating support¶

Nuevo en la versión 3.8.

Purchased support packages can optionally be integrated into your Weblate subscription management interface, from where you will find a link to it. Basic instance details about your installation are also reported back to Weblate this way.

Data submitted to the Weblate¶

URL en la que se ha configurado su instalación de Weblate
El título de su sitio
La versión de Weblate que ejecuta
Tallies of some objects in your Weblate database (projects, components, languages, source strings and users)
La clave pública de SSH de su instalación

No se envía ningún otro dato.

Integration services¶

See if your support package is still valid
Using Weblate provisioned backup storage

Consejo

Purchased support packages are already activated upon purchase, and can be used without integrating them.

Legal documents¶

Nota

Herein you will find various legal information you might need to operate Weblate in certain legal jurisdictions. It is provided as a means of guidance, without any warranty of accuracy or correctness. It is ultimately your responsibility to ensure that your use of Weblate complies with all applicable laws and regulations.

ITAR and other export controls¶

Weblate can be run within your own datacenter or virtual private cloud. As such, it can be used to store ITAR or other export-controlled information, however, end users are responsible for ensuring such compliance.

The Hosted Weblate service has not been audited for compliance with ITAR or other export controls, and does not currently offer the ability to restrict translations access by country.

US encryption controls¶

Weblate does not contain any cryptographic code, but might be subject export controls as it uses third party components utilizing cryptography for authentication, data-integrity and -confidentiality.

Most likely Weblate would be classified as ECCN 5D002 or 5D992 and, as publicly available libre software, it should not be subject to EAR (see Encryption items NOT Subject to the EAR).

Software components used by Weblate (listing only components related to cryptographic function):

Python: See https://wiki.python.org/moin/PythonSoftwareFoundationLicenseFaq#Is_Python_subject_to_export_laws.3F
GnuPG: Optionally used by Weblate
Git: Optionally used by Weblate
curl: Used by Git
OpenSSL: Used by Python and cURL

The strength of encryption keys depend on the configuration of Weblate and the third party components it interacts with, but in any decent setup it will include all export restricted cryptographic functions:

In excess of 56 bits for a symmetric algorithm
Factorisation of integers in excess of 512 bits for an asymmetric algorithm
Computation of discrete logarithms in a multiplicative group of a finite field of size greater than 512 bits for an asymmetric algorithm
Discrete logarithms in a group different than above in excess of 112 bits for an asymmetric algorithm

Weblate doesn’t have any cryptographic activation feature, but it can be configured in a way where no cryptography code would be involved. The cryptographic features include:

Accessing remote servers using secure protocols (HTTPS)
Generating signatures for code commits (PGP)

Ver también

Export Controls (EAR) on Open Source Software

Contributing to Weblate¶

There are dozens of ways to contribute in Weblate. Any help is welcomed, be it coding, graphics design, documentation or sponsorship:

Translating Weblate¶

Weblate is being translated using Weblate itself, feel free to take part in the effort of making Weblate available in as many human languages as possible.

Funding Weblate development¶

You can fund further Weblate development on the donate page. Funds collected there are used to fund gratis hosting for libre software projects, and further development of Weblate. Please check the donate page for details, such as funding goals and rewards you can get for being a funder.

Backers who have funded Weblate¶

List of Weblate supporters:

Yashiro Ccs
Cheng-Chia Tseng
Timon Reinhard
Cassidy James
Loic Dachary
Marozed
https://freedombox.org/es/
GNU Solidario (GNU Health)

Do you want to be in the list? Please see options on the Donate to Weblate.

Starting contributing code to Weblate¶

To understand Weblate source code, please first look into Weblate source code, Weblate frontend and Weblate por dentro.

Starting with our codebase¶

If looking for some bugs to familiarize yourself with the Weblate codebase, look for ones labelled good first issue.

Coding Weblate with PyCharm¶

PyCharm es un conocido EID para Python. A continuación le ofrecemos algunas recomendaciones para configurar Weblate en este programa.

Considering you have just cloned the Github repository, just open the folder in which you cloned it in PyCharm. Once the IDE is open, the first step is to specify the interpreter you want:

You can either chose to let PyCharm create the virtualenv for you, or select an already existing one:

Don’t forget to install the dependencies once the interpreter is set: you can do it, either through the console (the console from the IDE will directly use your virtualenv by default), or through the interface when you get a warning about missing dependencies.

The second step is to set the right information to use natively Django inside PyCharm: the idea is to be able to immediately trigger the unit tests in the IDE. For that you need to specify the root path of Django and the path of one setting:

Be careful, the Django project root is the root of the repository, not the weblate sub-directory. About the settings, I personally use the settings_test from the repository, but you could create your own setting and set it there.

Last step is to be able to run the server and to put breakpoints on the code to be able to debug it. This is done by creating a new Django Server configuration:

Be careful to properly checked «No reload»: you won’t get anymore the server live reload if you modify some files, but the debugger will be stopped on the breakpoint you set.

Running Weblate locally¶

The most comfortable approach to get started with Weblate development is to follow Installing from sources. It will get you a virtual env with editable Weblate sources.

To install all dependencies useful for development, do:

pip install -r requirements-dev.txt

To start a development server run:

weblate runserver

Depending on your configuration you might also want to start Celery workers:

./weblate/examples/celery start

Running Weblate locally in Docker¶

If you have Docker and docker-compose installed, you can spin up the development environment simply by running:

./rundev.sh

It will create development Docker image and start it. Weblate is running on <http://127.0.0.1:8080/> and you can sign in with admin user and admin password. The new installation is empty, so you might want to continue with Añadir proyectos y componentes de traducción.

The Dockerfile and docker-compose.yml for this are located in dev-docker directory.

The script also accepts some parameters, to execute tests run it with test parameter and then specify any test parameters, for example:

./rundev.sh test --failfast weblate.trans

Be careful that your Docker containers are up and running before running the tests. You can check that by running the docker ps command.

To stop the background containers run:

./rundev.sh stop

Running the script without args will recreate Docker container and restart it.

Nota

This is not suitable setup for production, it includes several hacks which are insecure, but make development easier.

Bootstraping your devel instance¶

You might want to use import_demo to create demo translations and createadmin to create admin user.

Weblate source code¶

Weblate is developed on GitHub. You are welcome to fork the code and open pull requests. Patches in any other form are welcome too.

Ver también

Check out Weblate por dentro to see how Weblate looks from inside.

Security by Design Principles¶

Any code for Weblate should be written with Security by Design Principles in mind.

Coding standard¶

The code should follow PEP-8 coding guidelines and should be formatted using black code formatter.

To check the code quality, you can use flake8, the recommended plugins are listed in .pre-commit-config.yaml and it’s configuration is placed in setup.cfg.

The easiest approach to enforce all this is to install pre-commit. Weblate repository contains configuration for it to verify the committed files are sane. After installing it (it is already included in the requirements-lint.txt) turn it on by running pre-commit install in Weblate checkout. This way all your changes will be automatically checked.

You can also trigger check manually, to check all files run:

pre-commit run --all

Debugging Weblate¶

Bugs can behave as application crashes or as misbehavior. You are welcome to collect info on any such issue and submit it to the issue tracker.

Modo de depuración¶

Turning on debug mode will make the exceptions show in the browser. This is useful to debug issues in the web interface, but not suitable for production environment as it has performance consequences and might leak private data.

Ver también

Desactivar el modo de depuración

Weblate logs¶

Weblate can produce detailed logs of what is going in the background. In the default configuration it uses syslog and that makes the log appear either in /var/log/messages or /var/log/syslog (depending on your syslog daemon configuration).

Docker containers log to their output (as usual in the Docker world), so you can look at the logs using docker-compose logs.

Ver también

Configuración de muestra contains LOGGING configuration.

Analyzing application crashes¶

In case the application crashes, it is useful to collect as much info about the crash as possible. The easiest way to achieve this is by using third-party services which can collect such info automatically. You can find info on how to set this up in Collecting error reports.

Silent failures¶

Lots of tasks are offloaded to Celery for background processing. Failures are not shown in the user interface, but appear in the Celery logs. Configuring Collecting error reports helps you to notice such failures easier.

Performance issues¶

In case Weblate performs badly in some situation, please collect the relevant logs showing the issue, and anything that might help figuring out where the code might be improved.

In case some requests take too long without any indication, you might want to install dogslow <https://pypi.org/project/dogslow/> along with Collecting error reports and get pinpointed and detailed tracebacks in the error collection tool.

Weblate por dentro¶

Nota

This chapter will give you basic overview of Weblate internals.

Weblate derives most of its code structure from, and is based on Django.

Directory structure¶

Quick overview of directory structure of Weblate main repository:

docs: Source code for this documentation, built using Sphinx.
dev-docker: Docker code to run development server, see Running Weblate locally in Docker.
weblate: Source code of Weblate as a Django application, see Weblate por dentro.
weblate/static: Client files (CSS, Javascript and images), see Weblate frontend.

Módulos¶

Weblate se compone de varias aplicaciones de Django (algunas son opcionales; vea Módulos opcionales de Weblate):

accounts

Cuenta de usuario, perfiles y notificaciones.

addons

Addons to tweak Weblate behavior, see Complementos.

api

API based on Django REST framework.

auth

Authentication and permissions.

billing

The optional Facturación module.

checks

Translation string Quality checks module.

fonts

Font rendering checks module.

formats

File format abstraction layer based on translate-toolkit.

gitexport

The optional Git exporter module.

lang

Módulo que define los idiomas y los modelos de pluralización.

langdata

Definiciones de datos lingüísticos.

legal

El módulo facultativo Información legal.

machinery

Integración de servicios de traducción automática.

memory

Built in translation memory, see Memoria de traducción.

screenshots

Gestión de capturas de pantalla y módulo de OCR.

trans

Módulo principal que manipula las traducciones.

utils

Diversas utilidades auxiliares.

vcs

Abstracción del sistema de control de versiones.

wladmin

Personalización de la interfaz administrativa de Django.

Weblate frontend¶

The frontend is currently built using Bootstrap, jQuery and few third party libraries.

Dependency management¶

The yarn package manager is used to update third party libraries. The configuration lives in scripts/yarn and there is a wrapper script scripts/yarn-update to upgrade the libraries, build them and copy to correct locations in weblate/static/vendor, where all third partly frontend code is located.

Coding style¶

Weblate relies on Prettier for the code formatting for both JavaScript and CSS files.

We also use ESLint to check the JavaScript code.

Regionalización¶

Should you need any user visible text in the frontend code, it should be localizable. In most cases all you need is to wrap your text inside gettext function, but there are more complex features available:

document.write(gettext('this is to be translated'));

var object_count = 1 // or 0, or 2, or 3, ...
s = ngettext('literal for the singular case',
        'literal for the plural case', object_count);

fmts = ngettext('There is %s object. Remaining: %s',
        'There are %s objects. Remaining: %s', 11);
s = interpolate(fmts, [11, 20]);
// s is 'There are 11 objects. Remaining: 20'

Ver también

Translation topic in the Django documentation

Icons¶

Weblate currently uses material design icons, in case you are looking for new one, check <https://materialdesignicons.com/>.

Additionally, there is scripts/optimize-svg to reduce size of the SVG as most of the icons are embedded inside the HTML to allow styling of the paths.

Informar de problemas en Weblate¶

Our issue tracker is hosted at GitHub:

Feel welcome to report any issues with, or suggest improvement of Weblate there. If what you have found is a security issue in Weblate, please consult the «Security issues» section below.

Problemas de seguridad¶

In order to give the community time to respond and upgrade your are strongly urged to report all security issues privately. HackerOne is used to handle security issues, and can be reported directly at HackerOne.

Alternatively, report to security@weblate.org, which ends up on HackerOne as well.

If you don’t want to use HackerOne, for whatever reason, you can send the report by e-mail to michal@cihar.com. You can choose to encrypt it using this PGP key 3CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D.

Nota

Weblate depends on third party components for many things. In case you find a vulnerability affecting one of those components in general, please report it directly to the respective project.

Some of these are:

Weblate testsuite and continuous integration¶

Testsuites exist for most of the current code, increase coverage by adding testcases for any new functionality, and verify that it works.

Continuous integration¶

Current test results can be found on GitHub Actions and coverage is reported on Codecov.

There are several jobs to verify different aspects:

Unit tests
Documentation build and external links
Migration testing from all supported releases
Code linting
Setup verification (ensures that generated dist files do not miss anything and can be tested)

The configuration for the CI is in .github/workflows directory. It heavily uses helper scripts stored in ci directory. The scripts can be also executed manually, but they require several environment variables, mostly defining Django settings file to use and database connection. The example definition of that is in scripts/test-database:

# Simple way to configure test database from environment

# Database backend to use postgresql / mysql / mariadb
export CI_DATABASE=postgresql

# Database server configuration
export CI_DB_USER=weblate
export CI_DB_PASSWORD=weblate
export CI_DB_HOST=127.0.0.1

# Django settings module to use
export DJANGO_SETTINGS_MODULE=weblate.settings_test

The simple execution can look like:

. scripts/test-database
./ci/run-migrate
./ci/run-test
./ci/run-docs
./ci/run-setup

Local testing¶

To run a testsuite locally, use:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test

Consejo

You will need a database (PostgreSQL) server to be used for tests. By default Django creates separate database to run tests with test_ prefix, so in case your settings is configured to use weblate, the tests will use test_weblate database. See Configuración de base de datos para Weblate for setup instructions.

The weblate/settings_test.py is used in CI environment as well (see Continuous integration) and can be tuned using environment variables:

# Simple way to configure test database from environment

# Database backend to use postgresql / mysql / mariadb
export CI_DATABASE=postgresql

# Database server configuration
export CI_DB_USER=weblate
export CI_DB_PASSWORD=weblate
export CI_DB_HOST=127.0.0.1

# Django settings module to use
export DJANGO_SETTINGS_MODULE=weblate.settings_test

Prior to running tests you should collect static files as some tests rely on them being present:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py collectstatic

You can also specify individual tests to run:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test weblate.gitexport

Consejo

The tests can also be executed inside developer docker container, see Running Weblate locally in Docker.

Ver también

See Testing in Django for more info on running and writing tests for Django.

Data schemas¶

Weblate uses JSON Schema to define layout of external JSON files.

Weblate Translation Memory Schema¶

type	array
items
	The Translation Memory Item
	type	object
	properties
	category	The String Category
		1 is global, 2 is shared, 10000000+ are project specific, 20000000+ are user specific
		type	integer
		examples	1
		minimum	0
		default	1
	origin	The String Origin
		Filename or component name
		type	string
		examples	test
		pattern	^(.*)$
		default
	source	The Source String
		type	string
		examples	Hello
		pattern	^(.+)$
		default
	source_language	The Source Language
		ISO 639-1 / ISO 639-2 / IETF BCP 47
		type	string
		examples	en
		pattern	^([^ ]+)$
		default
	target	The Target String
		type	string
		examples	Ahoj
		pattern	^(.+)$
		default
	target_language	The Target Language
		ISO 639-1 / ISO 639-2 / IETF BCP 47
		type	string
		examples	cs
		pattern	^([^ ]+)$
		default
	additionalProperties	False
definitions

Ver también

Memoria de traducción, dump_memory, import_memory

Weblate user data export¶

type	object
properties
basic	Basic
	type	object
	properties
	username	Username
		type	string
		examples	admin
		pattern	^.*$
		default
	full_name	Full name
		type	string
		examples	Weblate Admin
		pattern	^.*$
		default
	email	E-mail
		type	string
		examples	noreply@example.com
		pattern	^.*$
		default
	date_joined	Date joined
		type	string
		examples	2019-11-18T18:53:54.862Z
		pattern	^.*$
		default
profile	Profile
	type	object
	properties
	language	Language
		type	string
		examples	cs
		pattern	^.*$
		default
	suggested	Number of sugested strings
		type	integer
		examples	1
		default	0
	translated	Number of translated strings
		type	integer
		examples	24
		default	0
	uploaded	Number of uploaded screenshots
		type	integer
		examples	1
		default	0
	hide_completed	Hide completed translations on the dashboard
		type	boolean
		examples	False
		default	True
	secondary_in_zen	Show secondary translations in the Zen mode
		type	boolean
		examples	True
		default	True
	hide_source_secondary	Hide source if a secondary translation exists
		type	boolean
		examples	False
		default	True
	editor_link	Editor link
		type	string
		examples
		pattern	^.*$
		default
	translate_mode	Translation editor mode
		type	integer
		examples	0
		default	0
	zen_mode	Zen editor mode
		type	integer
		examples	0
		default	0
	special_chars	Special characters
		type	string
		examples
		pattern	^.*$
		default
	dashboard_view	Default dashboard view
		type	integer
		examples	1
		default	0
	dashboard_component_list	Default component list
		default	None
		anyOf		type	null
				type	integer
	languages	Translated languages
		type	array
		default	[]
		items
			Language code
			type	string
examples			cs
pattern			^.*$
default
secondary_languages	Secondary languages
	type	array
	default	[]
	items
		Language code
		type	string
		examples	sk
		pattern	^.*$
		default
watched	Watched projects
	type	array
	default	[]
	items
		Project slug
		type	string
		examples	weblate
		pattern	^.*$
		default
auditlog	Audit log
	type	array
	default	[]
	items
		Items
		type	object
		properties
		address	IP address
			type	string
			examples	127.0.0.1
			pattern	^.*$
			default
		user_agent	User agent
			type	string
			examples	PC / Linux / Firefox 70.0
			pattern	^.*$
			default
		timestamp	Timestamp
			type	string
			examples	2019-11-18T18:58:30.845Z
			pattern	^.*$
			default
		activity	Activity
			type	string
			examples	login
			pattern	^.*$
			default
definitions

Ver también

Perfil de usuario, dumpuserdata

Releasing Weblate¶

Things to check prior to release:

Check newly translated languages by ./scripts/list-translated-languages.
Set final version by ./scripts/prepare-release.
Make sure screenshots are up to date make -C docs update-screenshots

Perform the release:

Create a release ./scripts/create-release --tag (see below for requirements)

Post release manual steps:

Update Docker image.
Close GitHub milestone.
Once the Docker image is tested, add a tag and push it.
Update Helm chart to new version.
Include new version in .github/workflows/migrations.yml to cover it in migration testing.
Increase version in the repository by ./scripts/set-version.

To create tags using the ./scripts/create-release script you will need following:

GnuPG with private key used to sign the release
Push access to Weblate git repositories (it pushes tags)
Configured hub tool and access to create releases on the Weblate repo
SSH access to Weblate download server (the Website downloads are copied there)

Acerca de Weblate¶

Project goals¶

Web-based continuous localization tool with tight Integración de control de versiones supporting a wide range of Formatos de archivo admitidos, making it easy for translators to contribute.

Nombre del proyecto¶

«Weblate» is a portmanteau of the words «web» and «translate».

Sitio web del proyecto¶

The landing page is <https://weblate.org/> and a cloud hosted service at <https://hosted.weblate.org/>. This documentation can be found on <https://docs.weblate.org/>.

Project logos¶

The project logos and other graphics is available in <https://github.com/WeblateOrg/graphics/> repository.

Leadership¶

This project is maintained by Michal Čihař <michal@cihar.com>.

Authors¶

Weblate was started by Michal Čihař <michal@cihar.com>. Since its inception in 2012, thousands of people have contributed.

Licencia¶

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Weblate 4.2.1¶

Released on August 21st 2020.

Fixed saving plurals for some locales in Android resources.
Fixed crash in the cleanup addon for some XLIFF files.
Allow to configure localization CDN in Docker image.

Weblate 4.2¶

Released on August 18th 2020.

Páginas de usuario mejoradas y adición de listados de usuarios.
Dropped support for migrating from 3.x releases, migrate through 4.1 or 4.0.
Added exports into several monolingual formats.
Se remozaron los gráficos de actividad.
Es posible configurar el número de cadenas cercanas mostradas.
Added support for locking components experiencing repository errors.
Se simplificó la navegación principal (se sustituyeron los botones por iconos).
Improved language code handling in Google Translate integration.
The Git squash addon can generate Co-authored-by: trailers.
Improved query search parser.
Improved user feedback from format strings checks.
Improved performance of bulk state changes.
Added compatibility redirects after project or component renaming.
Added notifications for strings approval, component locking and license change.
Se añadió compatibilidad con ModernMT.
Allow to avoid overwriting approved translations on file upload.
Dropped support for some compatibility URL redirects.
Added check for ECMAScript template literals.
Added option to watch a component.
Removed leading dot from JSON unit keys.
Removed separate Celery queue for translation memory.
Allow translating all components a language at once.
Allow to configure Content-Security-Policy HTTP headers.
Added support for aliasing languages at project level.
New addon to help with HTML or JavaScript localization, see CDN de regionalización de JavaScript.
El dominio de Weblate se establece ahora en la configuración; vea SITE_DOMAIN.
Add support for searching by component and project.

Weblate 4.1.1¶

Publicada el 19 de junio de 2020.

Fixed changing autofix or addons configuration in Docker.
Fixed possible crash in «About» page.
Improved installation of byte-compiled locale files.
Fixed adding words to glossary.
Fixed keyboard shortcuts for machinery.
Removed debugging output causing discarding log events in some setups.
Fixed lock indication on project listing.
Fixed listing GPG keys in some setups.
Added option for which DeepL API version to use.
Added support for acting as SAML Service Provider, see Autenticación por SAML.

Weblate 4.1¶

Publicada el 15 de junio de 2020.

Pueden crearse traducciones nuevas con código de país.
Es posible buscar cadenas de origen con captura de pantalla.
Extended info available in the stats insights.
Improved search editing on «Translate» pages.
Improve handling of concurrent repository updates.
Se incluye el idioma de origen en el formulario de creación de proyecto.
Se incluye el recuento de cambios en los créditos.
Se arregló la selección del idioma de interfaz en casos puntuales.
Allow to whitelist registration methods with registrations closed.
Se mejoró la búsqueda de términos relacionados en el glosario.
Improved translation memory matches.
Se agrupan los resultados idénticos en la automatización.
Se añadió un enlace directo para editar capturas de pantalla desde la página de traducción.
Se mejoró el cuadro de diálogo de confirmación ante eliminaciones.
Se incluyen las plantillas en las descargas ZIP.
Se permite la utilización de Markdown y la configuración de notificaciones en los anuncios.
Detalles ampliados en los listados de comprobaciones.
Se añadió compatibilidad con formatos de archivo nuevos: Cadenas PHP de Laravel, Archivos HTML, Formato OpenDocument, Formato IDML, Archivos RC de Windows, INI translations, Traducciones de INI de Inno Setup, GWT properties, Archivos JSON de go-i18n, Archivo ARB.
Consistently use dismissed as state of dismissed checks.
Add support for configuring default addons to enable.
Se reparó el atajo de teclado en el editor para pasar por alto las comprobaciones.
Improved machine translation of strings with placeholders.
Show ghost translation for user languages to ease starting them.
Se mejoró el procesamiento de los códigos de idioma.
Se muestran en primer lugar las traducciones en los idiomas del usuario.
Se cambió el nombre de las «formas» a «variantes», una denominación más general.
Se añadieron comprobaciones de calidad nuevas: Varias variables sin nombre, Largamente no traducida y Palabras consecutivas duplicadas.
Se reintrodujo la posibilidad de vaciar la memoria de traducción.
Se reparó la opción para ignorar las comprobaciones en las cadenas de origen.
Se añadió compatibilidad para configurar una rama diferente a la que enviar cambios.
La API ahora informa del estado de limitación de velocidad en las cabeceras HTTP.
Se incorporó la versión 3 (avanzada) de la API de Google Translate.
Se añadió la capacidad de restringir el acceso a nivel de componente.
Added support for whitespace and other special chars in translation flags, see Customizing behavior.
Always show rendered text check if enabled.
API now supports filtering of changes.
Added support for sharing glossaries between projects.

Weblate 4.0.4¶

Publicada el 7 de mayo de 2020.

Fixed testsuite execution on some Python 3.8 environments.
Typo fixes in the documentation.
Fixed creating components using API in some cases.
Fixed JavaScript errors breaking mobile navigation.
Fixed crash on displaying some checks.
Fixed screenshots listing.
Fixed monthly digest notifications.
Fixed intermediate translation behavior with units non existing in translation.

Weblate 4.0.3¶

Publicada el 2 de mayo de 2020.

Fixed possible crash in reports.
User mentions in comments are now case insensitive.
Fixed PostgreSQL migration for non superusers.
Fixed changing the repository URL while creating component.
Fixed crash when upstream repository is gone.

Weblate 4.0.2¶

Publicada el 27 de abril de 2020.

Improved performance of translation stats.
Improved performance of changing labels.
Improved bulk edit performance.
Improved translation memory performance.
Fixed possible crash on component deletion.
Fixed displaying of translation changes in some corner cases.
Improved warning about too long celery queue.
Fixed possible false positives in the consistency check.
Fixed deadlock when changing linked component repository.
Included edit distance in changes listing and CSV and reports.
Avoid false positives of punctuation spacing check for Canadian French.
Fixed XLIFF export with placeholders.
Fixed false positive with zero width check.
Improved reporting of configuration errors.
Fixed bilingual source upload.
Automatically detect supported languages for DeepL machine translation.
Fixed progress bar display in some corner cases.
Fixed some checks triggering on non translated strings.

Weblate 4.0.1¶

Publicada el 16 de abril de 2020.

Se arregló la instalación del paquete desde PyPI.

Weblate 4.0¶

Publicada el 16 de abril de 2020.

Weblate ahora requiere Python 3.6 o una versión más reciente.
Added management overview of component alerts.
Added component alert for broken repository browser URLs.
Se mejoraron las páginas de alta y acceso.
Project access control and workflow configuration integrated to project settings.
Added check and highlighter for i18next interpolation and nesting.
Added check and highlighter for percent placeholders.
Display suggestions failing checks.
Record source string changes in history.
Upgraded Microsoft Translator to version 3 API.
Reimplemented translation memory backend.
Added support for several is: lookups in Búsquedas.
Allow to make Traducción no modificada avoid internal blacklist.
Improved comments extraction from monolingual po files.
Se cambió el nombre de la función de mensajes en pizarra a «Anuncios».
Fixed occasional problems with registration mails.
Improved LINGUAS update addon to handle more syntax variants.
Fixed editing monolingual XLIFF source file.
Added support for exact matching in Búsquedas.
Extended API to cover screenshots, users, groups, componentlists and extended creating projects.
Add support for source upload on bilingual translations.
Added support for intermediate language from developers.
Added support for source strings review.
Extended download options for platform wide translation memory.

Serie 3.x de Weblate¶

Weblate 3.11.3¶

Publicada el 11 de marzo de 2020.

Se corrigió la búsqueda de campos con una determinada prioridad.
Se corrigió la consulta predefinida para cadenas añadidas recientemente.
Se solucionó la duplicación de resultados en la búsqueda.
Se reparó la representación gráfica de las notificaciones en Gmail.
Se corrigió la reversión de cambios desde el historial.
Se añadieron enlaces a sucesos en las notificaciones de resumen.
Se corrigió la dirección de correo en la confirmación de eliminación de cuenta.
Se permite la autenticación con Slack en contenedores Docker.
Se evita enviar notificaciones para idiomas a los que no se ha suscrito.
Se incluyen las colas de Celery en la vista de conjunto del rendimiento.
Se repararon los enlaces a la documentación de los complementos.
Reduced false negatives for unchanged translation check.
Se incrementó la dependencia a bleach para solucionar la vulnerabilidad CVE-2020-6802.
Fixed listing project level changes in history.
Fixed stats invalidation in some corner cases.
Se solucionó la búsqueda de determinados estados de cadenas.
Improved format string checks behavior on missing percent.
Se reparó la autenticación a través de determinados proveedores de terceros.

Weblate 3.11.2¶

Publicada el 22 de febrero de 2020.

Se corrigió la representación gráfica de las sugerencias.
Se corrigió un problema por el cual algunas cadenas incorrectamente informaban que no contenían ninguna palabra.

Weblate 3.11.1¶

Publicada el 20 de febrero de 2020.

Se documentaron modificaciones a la configuración de Celery.
Se mejoró la validación de nombres de archivo al crear componentes.
Se corrigieron las versiones mínimas de algunas dependencias.
Se reparó la adición de grupos con algunas versiones de Django.
Fixed manual pushing to upstream repository.
Se mejoró el relacionamiento del glosario.

Weblate 3.11¶

Publicada el 17 de febrero de 2020.

Allow using VCS push URL during component creation via API.
Rendered width check now shows image with the render.
Se repararon los enlaces en los mensajes de notificación por correo electrónico.
Se mejoró el aspecto de los mensajes de correo de texto sencillo.
Se muestran permanentemente las comprobaciones ignoradas para permitir activarlas nuevamente.
Se muestran las claves cercanas en las traducciones monolingües.
Added support for grouping string shapings.
Se recomienda actualizar Weblate en las comprobaciones del sistema.
Provide more detailed analysis for duplicate language alert.
Se detalló la información sobre licencias en las páginas de proyecto.
Automatically unshallow local copies if needed.
Se arregló la descarga de cadenas pendientes de intervención.
New alert to warn about using the same filemask twice.
Improve XML placeables extraction.
The SINGLE_PROJECT can now enforce redirection to chosen project.
Se añadió una opción para marcar comentarios como resueltos.
Added bulk editing of flags.
Added support for Etiquetas de cadena.
Added bulk edit addon.
Added option for Enforcing checks.
Se incrementó la validez predeterminada de los enlaces de confirmación.
Se mejoró la integración con Matomo.
Fixed Ha sido traducido to correctly handle source string change.
Extended automatic updates configuration by AUTO_UPDATE.
LINGUAS addons now do full sync of translations in Weblate.

Weblate 3.10.3¶

Publicada el 18 de abril de 2020.

Compatibilidad con translate-toolkit 2.5.0.

Weblate 3.10.2¶

Publicada el 18 de abril de 2020.

Se añadió un indicador de bloqueo para los proyectos.
Se arregló un defecto en el CSS que provocaba parpadeos en determinados navegadores web.
Se repararon las búsquedas en sistemas con configuraciones regionales distintas del inglés.
Improved repository matching for GitHub and Bitbucket hooks.
Se corrigió la migración de datos en algunas instalaciones con Python 2.7.
Allow configuration of Git shallow cloning.
Se mejoró el procesamiento en segundo plano de las notificaciones.
Fixed broken form submission when navigating back in web browser.
Complemento nuevo para configurar el formato de YAML.
Fixed same plurals check to not fire on single plural form languages.
Se arregló la búsqueda por expresiones regulares en algunos campos.

Weblate 3.10.1¶

Publicada el 9 de enero de 2020.

Extended API with translation creation.
Fixed several corner cases in data migrations.
Compatibilidad con Django 3.0.
Se mejoró el desempeño de la limpieza de datos.
Se permite personalizar el archivo security.txt.
Improved breadcrumbs in changelog.
Improved translations listing on dashboard.
Improved HTTP responses for webhooks.
Added support for GitLab merge requests in Docker container.

Weblate 3.10¶

Publicada el 20 de diciembre de 2019.

Se perfeccionó la interfaz de usuario de la aplicación.
Se añadió una comprobación de espacios dobles.
Se arregló la creación de idiomas nuevos.
Avoid sending auditlog notifications to deleted e-mails.
Added support for read only strings.
Se permite el uso de Markdown en los comentarios.
Allow placing translation instruction text in project info.
Se añadió el botón «Copiar en el portapapeles» para los idiomas secundarios.
Se mejoró la compatibilidad con Mercurial.
Se mejoró el desempeño al recuperar repositorios Git.
Se añadió una opción de búsqueda de cadenas por antigüedad.
Se muestra el idioma de origen para todas las traducciones.
Se muestra el contexto de las cadenas cercanas.
Added support for notifications on repository operations.
Improved translation listings.
Extended search capabilities.
Added support for automatic translation strings marked for editing.
Avoid sending duplicate notifications for linked component alerts.
Improve default merge request message.
Better indicate string state in Zen mode.
Added support for more languages in Yandex Translate.
Improved look of notification e-mails.
Provide choice for translation license.

Weblate 3.9.1¶

Publicada el 28 de octubre de 2019.

Remove some unneeded files from backups.
Fixed potential crash in reports.
Fixed cross database migration failure.
Added support for force pushing Git repositories.
Reduced risk of registration token invalidation.
Fixed account removal hitting rate limiter.
Added search based on priority.
Fixed possible crash on adding strings to JSON file.
Safe HTML check and fixup now honor source string markup.
Avoid sending notifications to invited and deleted users.
Fix SSL connection to redis in Celery in Docker container.

Weblate 3.9¶

Publicada el 15 de octubre de 2019.

Include Weblate metadata in downloaded files.
Improved UI for failing checks.
Indicate missing strings in format checks.
Separate check for French punctuation spacing.
Add support for fixing some of quality checks errors.
Add separate permission to create new projects.
Extend stats for char counts.
Improve support for Java style language codes.
Added new generic check for placeholders.
Added support for WebExtension JSON placeholders.
Added support for flat XML format.
Extended API with project, component and translation removal and creation.
Added support for Gitea and Gitee webhooks.
Added new custom regex based check.
Allow to configure contributing to shared translation memory.
Added ZIP download for more translation files.
Make XLIFF standard compliant parsing of maxwidth and font.
Added new check and fixer for safe HTML markup for translating web applications.
Add component alert on unsupported configuration.
Added automatic translation addon to bootstrap translations.
Extend automatic translation to add suggestions.
Display addon parameters on overview.
Sentry is now supported through modern Sentry SDK instead of Raven.
Changed example settings to be better fit for production environment.
Added automated backups using BorgBackup.
Split cleanup addon for RESX to avoid unwanted file updates.
Added advanced search capabilities.
Allow users to download their own reports.
Added localization guide to help configuring components.
Added support for GitLab merge requests.
Improved display of repository status.
Perform automated translation in the background.

Weblate 3.8¶

Publicada el 15 de agosto de 2019.

Added support for simplified creating of similar components.
Added support for parsing translation flags from the XML based file formats.
Log exceptions into Celery log.
Improve performance of repository scoped addons.
Improved look of notification e-mails.
Fixed password reset behavior.
Improved performance on most of translation pages.
Fixed listing of languages not known to Weblate.
Add support for cloning addons to discovered components.
Add support for replacing file content with uploaded.
Add support for translating non VCS based content.
Added OpenGraph widget image to use on social networks.
Added support for animated screenshots.
Improved handling of monolingual XLIFF files.
Avoid sending multiple notifications for single event.
Add support for filtering changes.
Extended predefined periods for reporting.
Added webhook support for Azure Repos.
New opt-in notifications on pending suggestions or untranslated strings.
Add one click unsubscribe link to notification e-mails.
Fixed false positives with Has been translated check.
New management interface for admins.
String priority can now be specified using flags.
Added language management views.
Add checks for Qt library and Ruby format strings.
Added configuration to better fit single project installations.
Notify about new string on source string change on monolingual translations.
Added separate view for translation memory with search capability.

Weblate 3.7.1¶

Publicada el 28 de junio de 2019.

Documentation updates.
Fixed some requirements constraints.
Updated language database.
Localization updates.
Various user interface tweaks.
Improved handling of unsupported but discovered translation files.
More verbosely report missing file format requirements.

Weblate 3.7¶

Publicada el 21 de junio de 2019.

Added separate Celery queue for notifications.
Use consistent look with application for API browsing.
Include approved stats in the reports.
Report progress when updating translation component.
Allow to abort running background component update.
Extend template language for filename manipulations.
Use templates for editor link and repository browser URL.
Indicate max length and current characters count when editing translation.
Improved handling of abbreviations in unchanged translation check.
Refreshed landing page for new contributors.
Add support for configuring msgmerge addon.
Delay opening SMTP connection when sending notifications.
Improved error logging.
Allow custom location in MO generating addon.
Added addons to cleanup old suggestions or comments.
Added option to enable horizontal mode in the Zen editor.
Improved import performance with many linked components.
Fixed examples installation in some cases.
Improved rendering of alerts in changes.
Added new horizontal stats widget.
Improved format strings check on plurals.
Added font management tool.
New check for rendered text dimensions.
Added support for subtitle formats.
Include overall completion stats for languages.
Added reporting at project and global scope.
Improved user interface when showing translation status.
New Weblate logo and color scheme.
New look of bitmap badges.

Weblate 3.6.1¶

Publicada el 26 de abril de 2019.

Improved handling of monolingual XLIFF files.
Fixed digest notifications in some corner cases.
Fixed addon script error alert.
Fixed generating MO file for monolingual PO files.
Fixed display of uninstalled checks.
Indicate administered projects on project listing.
Allow update to recover from missing VCS repository.

Weblate 3.6¶

Publicada el 20 de abril de 2019.

Add support for downloading user data.
Addons are now automatically triggered upon installation.
Improved instructions for resolving merge conflicts.
Cleanup addon is now compatible with app store metadata translations.
Configurable language code syntax when adding new translations.
Warn about using Python 2 with planned termination of support in April 2020.
Extract special characters from the source string for visual keyboard.
Extended contributor stats to reflect both source and target counts.
Admins and consistency addons can now add translations even if disabled for users.
Fixed description of toggle disabling Language-Team header manipulation.
Notify users mentioned in comments.
Removed file format autodetection from component setup.
Fixed generating MO file for monolingual PO files.
Added digest notifications.
Added support for muting component notifications.
Se añadieron notificaciones al haber nuevas alertas, mensajes en pizarra o componentes.
Notifications for administered projects can now be configured.
Improved handling of three letter language codes.

Weblate 3.5.1¶

Publicada el 10 de marzo de 2019.

Fixed Celery systemd unit example.
Fixed notifications from HTTP repositories with login.
Fixed race condition in editing source string for monolingual translations.
Include output of failed addon execution in the logs.
Improved validation of choices for adding new language.
Se permite editar el formato de archivo en la configuración del componente.
Se actualizaron las instrucciones de instalación para preferir Python 3.
Mejoras de rendimiento y coherencia durante la carga de traducciones.
El servicio de terminología de Microsoft se hizo compatible con las versiones actuales de Zeep.
Localization updates.

Weblate 3.5¶

Publicada el 3 de marzo de 2019.

Se mejoró el rendimiento de la memoria de traducción incorporada.
Se añadió una interfaz para gestionar la memoria de traducción global.
Improved alerting on bad component state.
Se añadió una interfaz para gestionar los mensajes de pizarra.
Ahora puede configurarse el mensaje de consigna de complemento.
Reduce number of commits when updating upstream repository.
Fixed possible metadata loss when moving component between projects.
Se perfeccionó la navegación en el modo zen.
Se sumaron varias comprobaciones de calidad nuevas (relativas a Markdown y URL).
Se añadió compatibilidad para archivos de metadatos de tiendas de aplicaciones.
Es posible ahora activar o desactivar las integraciones con GitHub y Gerrit.
Se añadió una comprobación de caracteres «kashida».
Added option to squash commits based on authors.
Se mejoró la compatibilidad con el formato de archivo XLSX.
Compatibilidad con Tesseract 4.0.
Billing addon now removes projects for unpaid billings after 45 days.

Weblate 3.4¶

Publicada el 22 de enero de 2019.

Added support for XLIFF placeholders.
Celery ahora puede utilizar varias colas de tareas.
Ahora es posible cambiar el nombre y mover proyectos y componentes.
Se incluye el recuento de caracteres en los informes.
Added guided adding of translation components with automatic detection of translation files.
Pueden personalizarse los mensajes de consigna de fusión para Git.
Se añadió una indicación visual de alertas de componente en la navegación.
Se mejoró el rendimiento al cargar los archivos de traducción.
New addon to squash commits prior to push.
Se mejoró la visualización de los cambios a la traducción.
Changed default merge style to rebase and made that configurable.
Better handle private use subtags in language code.
Improved performance of fulltext index updates.
Extended file upload API to support more parameters.

Weblate 3.3¶

Publicada el 30 de noviembre de 2018.

Added support for component and project removal.
Improved performance for some monolingual translations.
Added translation component alerts to highlight problems with a translation.
Expose XLIFF string resname as context when available.
Added support for XLIFF states.
Added check for non writable files in DATA_DIR.
Improved CSV export for changes.

Weblate 3.2.2¶

Publicada el 20 de octubre de 2018.

Remove no longer needed Babel dependency.
Updated language definitions.
Improve documentation for addons, LDAP and Celery.
Fixed enabling new dos-eol and auto-java-messageformat flags.
Fixed running setup.py test from PyPI package.
Improved plurals handling.
Fixed translation upload API failure in some corner cases.
Fixed updating Git configuration in case it was changed manually.

Weblate 3.2.1¶

Publicada el 10 de octubre de 2018.

Document dependency on backports.csv on Python 2.7.
Fix running tests under root.
Improved error handling in gitexport module.
Fixed progress reporting for newly added languages.
Correctly report Celery worker errors to Sentry.
Fixed creating new translations with Qt Linguist.
Fixed occasional fulltext index update failures.
Improved validation when creating new components.
Added support for cleanup of old suggestions.

Weblate 3.2¶

Publicada el 6 de octubre de 2018.

Add install_addon management command for automated addon installation.
Allow more fine grained ratelimit settings.
Added support for export and import of Excel files.
Improve component cleanup in case of multiple component discovery addons.
Rewritten Microsoft Terminology machine translation backend.
Weblate now uses Celery to offload some processing.
Improved search capabilities and added regular expression search.
Added support for Youdao Zhiyun API machine translation.
Added support for Baidu API machine translation.
Integrated maintenance and cleanup tasks using Celery.
Improved performance of loading translations by almost 25%.
Removed support for merging headers on upload.
Removed support for custom commit messages.
Configurable editing mode (zen/full).
Added support for error reporting to Sentry.
Added support for automated daily update of repositories.
Added support for creating projects and components by users.
Built in translation memory now automatically stores translations done.
Users and projects can import their existing translation memories.
Better management of related strings for screenshots.
Added support for checking Java MessageFormat.

See 3.2 milestone on GitHub for detailed list of addressed issues.

Weblate 3.1.1¶

Publicada el 27 de julio de 2018.

Fix testsuite failure on some setups.

Weblate 3.1¶

Publicada el 27 de julio de 2018.

Upgrades from older version than 3.0.1 are not supported.
Allow to override default commit messages from settings.
Improve webhooks compatibility with self hosted environments.
Added support for Amazon Translate.
Compatibility with Django 2.1.
Django system checks are now used to diagnose problems with installation.
Removed support for soon shutdown libravatar service.
New addon to mark unchanged translations as needing edit.
Add support for jumping to specific location while translating.
Downloaded translations can now be customized.
Improved calculation of string similarity in translation memory matches.
Added support by signing Git commits by GnuPG.

Weblate 3.0.1¶

Publicada el 10 de junio de 2018.

Fixed possible migration issue from 2.20.
Localization updates.
Removed obsolete hook examples.
Improved caching documentation.
Fixed displaying of admin documentation.
Improved handling of long language names.

Weblate 3.0¶

Publicada el 1.º de junio de 2018.

Rewritten access control.
Several code cleanups that lead to moved and renamed modules.
New addon for automatic component discovery.
The import_project management command has now slightly different parameters.
Added basic support for Windows RC files.
New addon to store contributor names in PO file headers.
The per component hook scripts are removed, use addons instead.
Add support for collecting contributor agreements.
Access control changes are now tracked in history.
New addon to ensure all components in a project have same translations.
Support for more variables in commit message templates.
Add support for providing additional textual context.

Serie 2.x de Weblate¶

Weblate 2.20¶

Publicada el 4 de abril de 2018.

Improved speed of cloning subversion repositories.
Changed repository locking to use third party library.
Added support for downloading only strings needing action.
Se permite efectuar búsquedas en varios idiomas a la vez.
New addon to configure gettext output wrapping.
New addon to configure JSON formatting.
Added support for authentication in API using RFC 6750 compatible Bearer authentication.
Added support for automatic translation using machine translation services.
Se admite código HTML en los mensajes de la pizarra.
Added support for mass changing state of strings.
Translate-toolkit at least 2.3.0 is now required, older versions are no longer supported.
Added built in translation memory.
Added componentlists overview to dashboard and per component list overview pages.
Added support for DeepL machine translation service.
Machine translation results are now cached inside Weblate.
Se añadió la funcionalidad de reordenar los cambios consignados.

Weblate 2.19.1¶

Publicada el 20 de febrero de 2018.

Fixed migration issue on upgrade from 2.18.
Improved file upload API validation.

Weblate 2.19¶

Publicada el 15 de febrero de 2018.

Fixed imports across some file formats.
Display human friendly browser information in audit log.
Added TMX exporter for files.
Various performance improvements for loading translation files.
Added option to disable access management in Weblate in favor of Django one.
Improved glossary lookup speed for large strings.
Compatibility with django_auth_ldap 1.3.0.
Configuration errors are now stored and reported persistently.
Honor ignore flags in whitespace autofixer.
Improved compatibility with some Subversion setups.
Improved built in machine translation service.
Added support for SAP Translation Hub service.
Added support for Microsoft Terminology service.
Removed support for advertisement in notification e-mails.
Improved translation progress reporting at language level.
Improved support for different plural formulas.
Added support for Subversion repositories not using stdlayout.
Added addons to customize translation workflows.

Weblate 2.18¶

Publicada el 15 de diciembre de 2017.

Extended contributor stats.
Improved configuration of special characters virtual keyboard.
Added support for DTD file format.
Changed keyboard shortcuts to less likely collide with browser/system ones.
Improved support for approved flag in XLIFF files.
Added support for not wrapping long strings in gettext PO files.
Added button to copy permalink for current translation.
Dropped support for Django 1.10 and added support for Django 2.0.
Removed locking of translations while translating.
Added support for adding new strings to monolingual translations.
Added support for translation workflows with dedicated reviewers.

Weblate 2.17.1¶

Publicada el 13 de octubre de 2017.

Fixed running testsuite in some specific situations.
Locales updates.

Weblate 2.17¶

Publicada el 13 de octubre de 2017.

Weblate by default does shallow Git clones now.
Improved performance when updating large translation files.
Added support for blocking certain e-mails from registration.
Users can now delete their own comments.
Added preview step to search and replace feature.
Client side persistence of settings in search and upload forms.
Extended search capabilities.
More fine grained per project ACL configuration.
Default value of BASE_DIR has been changed.
Added two step account removal to prevent accidental removal.
Project access control settings is now editable.
Added optional spam protection for suggestions using Akismet.

Weblate 2.16¶

Publicada el 11 de agosto de 2017.

Various performance improvements.
Added support for nested JSON format.
Added support for WebExtension JSON format.
Fixed git exporter authentication.
Improved CSV import in certain situations.
Improved look of Other translations widget.
The max-length checks is now enforcing length of text in form.
Make the commit_pending age configurable per component.
Various user interface cleanups.
Fixed component/project/site wide search for translations.

Weblate 2.15¶

Publicada el 30 de junio de 2017.

Show more related translations in other translations.
Add option to see translations of current string to other languages.
Use 4 plural forms for Lithuanian by default.
Fixed upload for monolingual files of different format.
Improved error messages on failed authentication.
Keep page state when removing word from glossary.
Added direct link to edit secondary language translation.
Added Perl format quality check.
Added support for rejecting reused passwords.
Extended toolbar for editing RTL languages.

Weblate 2.14.1¶

Publicada el 24 de mayo de 2017.

Fixed possible error when paginating search results.
Fixed migrations from older versions in some corner cases.
Fixed possible CSRF on project watch and unwatch.
The password reset no longer authenticates user.
Fixed possible CAPTCHA bypass on forgotten password.

Weblate 2.14¶

Publicada el 17 de mayo de 2017.

Add glossary entries using AJAX.
The logout now uses POST to avoid CSRF.
The API key token reset now uses POST to avoid CSRF.
Weblate sets Content-Security-Policy by default.
The local editor URL is validated to avoid self-XSS.
The password is now validated against common flaws by default.
Notify users about important activity with their account such as password change.
The CSV exports now escape potential formulas.
Various minor improvements in security.
The authentication attempts are now rate limited.
Suggestion content is stored in the history.
Store important account activity in audit log.
Ask for password confirmation when removing account or adding new associations.
Show time when suggestion has been made.
There is new quality check for trailing semicolon.
Ensure that search links can be shared.
Included source string information and screenshots in the API.
Allow to overwrite translations through API upload.

Weblate 2.13.1¶

Publicada el 12 de abril de 2017.

Fixed listing of managed projects in profile.
Fixed migration issue where some permissions were missing.
Fixed listing of current file format in translation download.
Return HTTP 404 when trying to access project where user lacks privileges.

Weblate 2.13¶

Publicada el 12 de abril de 2017.

Fixed quality checks on translation templates.
Se añadió una comprobación de calidad que se desencadena al perder traducciones.
Se añadió una opción para ver las sugerencias pendientes de un usuario.
Se añadió una opción para crear listas de componentes automáticamente.
Es posible configurar el cuadro de mando que ven de manera predeterminada los usuarios no autenticados.
Se añadió una opción para examinar 25 cadenas al azar para su revisión.
El historial ahora incluye los cambios a las cadenas.
Better error reporting when adding new translation.
Added per language search within project.
Group ACLs can now be limited to certain permissions.
The per project ALCs are now implemented using Group ACL.
Added more fine grained privileges control.
Various minor UI improvements.

Weblate 2.12¶

Publicada el 3 de marzo de 2017.

Improved admin interface for groups.
Added support for Yandex Translate API.
Improved speed of site wide search.
Added project and component wide search.
Added project and component wide search and replace.
Improved rendering of inconsistent translations.
Added support for opening source files in local editor.
Added support for configuring visual keyboard with special characters.
Improved screenshot management with OCR support for matching source strings.
Default commit message now includes translation information and URL.
Added support for Joomla translation format.
Improved reliability of import across file formats.

Weblate 2.11¶

Publicada el 31 de enero de 2017.

Include language detailed information on language page.
Mercurial backend improvements.
Added option to specify translation component priority.
More consistent usage of Group ACL even with less used permissions.
Added WL_BRANCH variable to hook scripts.
Improved developer documentation.
Better compatibility with various Git versions in Git exporter addon.
Included per project and component stats.
Added language code mapping for better support of Microsoft Translate API.
Moved fulltext cleanup to background job to make translation removal faster.
Fixed displaying of plural source for languages with single plural form.
Improved error handling in import_project.
Various performance improvements.

Weblate 2.10.1¶

Publicada el 20 de enero de 2017.

Do not leak account existence on password reset form (CVE-2017-5537).

Weblate 2.10¶

Publicada el 15 de diciembre de 2016.

Added quality check to check whether plurals are translated differently.
Fixed GitHub hooks for repositories with authentication.
Added optional Git exporter module.
Support for Microsoft Cognitive Services Translator API.
Simplified project and component user interface.
Added automatic fix to remove control characters.
Added per language overview to project.
Added support for CSV export.
Added CSV download for stats.
Added matrix view for quick overview of all translations
Added basic API for changes and strings.
Added support for Apertium APy server for machine translations.

Weblate 2.9¶

Publicada el 4 de noviembre de 2016.

Extended parameters for createadmin management command.
Extended import_json to be able to handle with existing components.
Added support for YAML files.
Project owners can now configure translation component and project details.
Use «Watched» instead of «Subscribed» projects.
Projects can be watched directly from project page.
Added multi language status widget.
Highlight secondary language if not showing source.
Record suggestion deletion in history.
Improved UX of languages selection in profile.
Se arregló la visualización de los mensajes de pizarra en los componentes.
Keep preferences tab selected after saving.
Show source string comment more prominently.
Automatically install Gettext PO merge driver for Git repositories.
Added search and replace feature.
Added support for uploading visual context (screenshots) for translations.

Weblate 2.8¶

Publicada el 31 de agosto de 2016.

Documentation improvements.
Translations.
Updated bundled javascript libraries.
Added list_translators management command.
Django 1.8 is no longer supported.
Fixed compatibility with Django 1.10.
Added Subversion support.
Separated XML validity check from XML mismatched tags.
Fixed API to honor HIDE_REPO_CREDENTIALS settings.
Show source change in Zen mode.
Alt+PageUp/PageDown/Home/End now works in Zen mode as well.
Add tooltip showing exact time of changes.
Add option to select filters and search from translation page.
Added UI for translation removal.
Improved behavior when inserting placeables.
Fixed auto locking issues in Zen mode.

Weblate 2.7¶

Publicada el 10 de julio de 2016.

Removed Google web translate machine translation.
Improved commit message when adding translation.
Fixed Google Translate API for Hebrew language.
Compatibility with Mercurial 3.8.
Added import_json management command.
Correct ordering of listed translations.
Show full suggestion text, not only a diff.
Extend API (detailed repository status, statistics, …).
Testsuite no longer requires network access to test repositories.

Weblate 2.6¶

Publicada el 28 de abril de 2016.

Fixed validation of components with language filter.
Improved support for XLIFF files.
Fixed machine translation for non English sources.
Added REST API.
Django 1.10 compatibility.
Se añadieron categorías a los mensajes de pizarra.

Weblate 2.5¶

Publicada el 10 de marzo de 2016.

Fixed automatic translation for project owners.
Improved performance of commit and push operations.
New management command to add suggestions from command line.
Added support for merging comments on file upload.
Added support for some GNU extensions to C printf format.
Documentation improvements.
Added support for generating translator credits.
Added support for generating contributor stats.
Site wide search can search only in one language.
Improve quality checks for Armenian.
Support for starting translation components without existing translations.
Support for adding new translations in Qt TS.
Improved support for translating PHP files.
Mejoras de rendimiento para las comprobaciones de calidad.
Se arregló la búsqueda en todo el sitio de comprobaciones fallidas.
Se añadió una opción para especificar el idioma de origen.
Improved support for XLIFF files.
Se amplió la lista de opciones disponibles para import_project.
Improved targeting for whiteboard messages.
Es posible efectuar traducciones automáticas en diversos proyectos a la vez.
Se optimizó la indización de la búsqueda de texto completo.
Se añadió una orden de gestión para traducciones automáticas.
Added placeables highlighting.
Added keyboard shortcuts for placeables, checks and machine translations.
Improved translation locking.
Added quality check for AngularJS interpolation.
Added extensive group based ACLs.
Clarified terminology on strings needing review (formerly fuzzy).
Clarified terminology on strings needing action and not translated strings.
Se admite Python 3.
Ya no se admite Django 1.7.
Dropped dependency on msginit for creating new gettext PO files.
Added configurable dashboard views.
Improved notifications on parse errors.
Added option to import components with duplicate name to import_project.
Improved support for translating PHP files
Added XLIFF export for dictionary.
Added XLIFF and gettext PO export for all translations.
Documentation improvements.
Added support for configurable automatic group assignments.
Improved adding of new translations.

Weblate 2.4¶

Publicada el 20 de septiembre de 2015.

Improved support for PHP files.
Ability to add ACL to anonymous user.
Improved configurability of import_project command.
Added CSV dump of history.
Avoid copy/paste errors with whitespace characters.
Added support for Bitbucket webhooks.
Tighter control on fuzzy strings on translation upload.
Several URLs have changed, you might have to update your bookmarks.
Hook scripts are executed with VCS root as current directory.
Hook scripts are executed with environment variables describing current component.
Add management command to optimize fulltext index.
Added support for error reporting to Rollbar.
Projects now can have multiple owners.
Project owners can manage themselves.
Added support for javascript-format used in gettext PO.
Support for adding new translations in XLIFF.
Improved file format autodetection.
Extended keyboard shortcuts.
Improved dictionary matching for several languages.
Improved layout of most of pages.
Support for adding words to dictionary while translating.
Added support for filtering languages to be managed by Weblate.
Added support for translating and importing CSV files.
Rewritten handling of static files.
Direct login/registration links to third-party service if that’s the only one.
Commit pending changes on account removal.
Add management command to change site name.
Add option to configure default committer.
Add hook after adding new translation.
Add option to specify multiple files to add to commit.

Weblate 2.3¶

Publicada el 22 de mayo de 2015.

Dropped support for Django 1.6 and South migrations.
Support for adding new translations when using Java Property files
Allow to accept suggestion without editing.
Improved support for Google OAuth 2.0
Added support for Microsoft .resx files.
Tuned default robots.txt to disallow big crawling of translations.
Simplified workflow for accepting suggestions.
Added project owners who always receive important notifications.
Allow to disable editing of monolingual template.
More detailed repository status view.
Direct link for editing template when changing translation.
Allow to add more permissions to project owners.
Allow to show secondary language in Zen mode.
Support for hiding source string in favor of secondary language.

Weblate 2.2¶

Publicada el 19 de febrero de 2015.

Performance improvements.
Fulltext search on location and comments fields.
New SVG/javascript based activity charts.
Support for Django 1.8.
Support for deleting comments.
Added own SVG badge.
Added support for Google Analytics.
Improved handling of translation filenames.
Added support for monolingual JSON translations.
Record component locking in a history.
Support for editing source (template) language for monolingual translations.
Added basic support for Gerrit.

Weblate 2.1¶

Publicada el 5 de diciembre de 2014.

Added support for Mercurial repositories.
Replaced Glyphicon font by Awesome.
Added icons for social authentication services.
Better consistency of button colors and icons.
Documentation improvements.
Varias correcciones de defectos.
Automatic hiding of columns in translation listing for small screens.
Changed configuration of filesystem paths.
Improved SSH keys handling and storage.
Improved repository locking.
Customizable quality checks per source string.
Allow to hide completed translations from dashboard.

Weblate 2.0¶

Publicada el 6 de noviembre de 2014.

New responsive UI using Bootstrap.
Rewritten VCS backend.
Documentation improvements.
Added whiteboard for site wide messages.
Configurable strings priority.
Added support for JSON file format.
Fixed generating mo files in certain cases.
Added support for GitLab notifications.
Added support for disabling translation suggestions.
Django 1.7 support.
ACL projects now have user management.
Extended search possibilities.
Give more hints to translators about plurals.
Fixed Git repository locking.
Compatibility with older Git versions.
Improved ACL support.
Added buttons for per language quotes and other special characters.
Support for exporting stats as JSONP.

Serie 1.x de Weblate¶

Weblate 1.9¶

Publicada el 6 de mayo de 2014.

Django 1.6 compatibility.
No longer maintained compatibility with Django 1.4.
Management commands for locking/unlocking translations.
Improved support for Qt TS files.
Users can now delete their account.
Avatars can be disabled.
Merged first and last name attributes.
Avatars are now fetched and cached server side.
Added support for shields.io badge.

Weblate 1.8¶

Publicada el 7 de noviembre de 2013.

Please check manual for upgrade instructions.
Nicer listing of project summary.
Better visible options for sharing.
More control over anonymous users privileges.
Supports login using third party services, check manual for more details.
Los usuarios pueden acceder proporcionando su correo electrónico en lugar de su nombre de usuario.
Documentation improvements.
Improved source strings review.
Searching across all strings.
Better tracking of source strings.
Captcha protection for registration.

Weblate 1.7¶

Publicada el 7 de octubre de 2013.

Please check manual for upgrade instructions.
Support for checking Python brace format string.
Per component customization of quality checks.
Detailed per translation stats.
Changed way of linking suggestions, checks and comments to strings.
Users can now add text to commit message.
Support for subscribing on new language requests.
Support for adding new translations.
Widgets and charts are now rendered using Pillow instead of Pango + Cairo.
Add status badge widget.
Dropped invalid text direction check.
Los cambios realizados a los diccionarios ahora figuran en el historial.
Performance improvements for translating view.

Weblate 1.6¶

Publicada el 25 de julio de 2013.

Nicer error handling on registration.
Browsing of changes.
Fixed sorting of machine translation suggestions.
Improved support for MyMemory machine translation.
Added support for Amagama machine translation.
Various optimizations on frequently used pages.
Highlights searched phrase in search results.
Support for automatic fixups while saving the message.
Tracking of translation history and option to revert it.
Added support for Google Translate API.
Added support for managing SSH host keys.
Various form validation improvements.
Various quality checks improvements.
Performance improvements for import.
Added support for voting on suggestions.
Cleanup of admin interface.

Weblate 1.5¶

Publicada el 16 de abril de 2013.

Please check manual for upgrade instructions.
Added public user pages.
Better naming of plural forms.
Added support for TBX export of glossary.
Added support for Bitbucket notifications.
Activity charts are now available for each translation, language or user.
Extended options of import_project admin command.
Compatible with Django 1.5.
Avatars are now shown using libravatar.
Added possibility to pretty print JSON export.
Various performance improvements.
Indicate failing checks or fuzzy strings in progress bars for projects or languages as well.
Added support for custom pre-commit hooks and committing additional files.
Rewritten search for better performance and user experience.
New interface for machine translations.
Added support for monolingual po files.
Extend amount of cached metadata to improve speed of various searches.
Now shows word counts as well.

Weblate 1.4¶

Publicada el 23 de enero de 2013.

Fixed deleting of checks/comments on string deletion.
Added option to disable automatic propagation of translations.
Added option to subscribe for merge failures.
Correctly import on projects which needs custom ttkit loader.
Added sitemaps to allow easier access by crawlers.
Provide direct links to string in notification e-mails or feeds.
Various improvements to admin interface.
Provide hints for production setup in admin interface.
Added per language widgets and engage page.
Improved translation locking handling.
Show code snippets for widgets in more variants.
Indicate failing checks or fuzzy strings in progress bars.
More options for formatting commit message.
Fixed error handling with machine translation services.
Improved automatic translation locking behaviour.
Support for showing changes from previous source string.
Added support for substring search.
Various quality checks improvements.
Support for per project ACL.
Basic string tests coverage.

Weblate 1.3¶

Publicada el 16 de noviembre de 2012.

Compatibility with PostgreSQL database backend.
Removes languages removed in upstream git repository.
Improved quality checks processing.
Added new checks (BB code, XML markup and newlines).
Support for optional rebasing instead of merge.
Possibility to relocate Weblate (for example to run it under /weblate path).
Support for manually choosing file type in case autodetection fails.
Better support for Android resources.
Support for generating SSH key from web interface.
More visible data exports.
New buttons to enter some special characters.
Support for exporting dictionary.
Support for locking down whole Weblate installation.
Checks for source strings and support for source strings review.
Support for user comments for both translations and source strings.
Better changes log tracking.
Changes can now be monitored using RSS.
Improved support for RTL languages.

Weblate 1.2¶

Publicada el 14 de agosto de 2012.

Weblate ahora se sirve de South para la migración de la base de datos; eche un vistazo a las instrucciones de actualización si está por actualizar.
Fixed minor issues with linked git repos.
New introduction page for engaging people with translating using Weblate.
Added widgets which can be used for promoting translation projects.
Added option to reset repository to origin (for privileged users).
Project or component can now be locked for translations.
Possibility to disable some translations.
Configurable options for adding new translations.
Configuration of git commits per project.
Simple antispam protection.
Better layout of main page.
Support for automatically pushing changes on every commit.
Support for e-mail notifications of translators.
List only used languages in preferences.
Improved handling of not known languages when importing project.
Support for locking translation by translator.
Optionally maintain Language-Team header in po file.
Include some statistics in about page.
Supports (and requires) django-registration 0.8.
Caching of counted strings with failing checks.
Checking of requirements during setup.
Documentation improvements.

Weblate 1.1¶

Publicada el 4 de julio de 2012.

Improved several translations.
Better validation while creating component.
Added support for shared git repositories across components.
Do not necessary commit on every attempt to pull remote repo.
Added support for offloading indexing.

Weblate 1.0¶

Publicada el 10 de mayo de 2012.

Improved validation while adding/saving component.
Experimental support for Android component files (needs patched ttkit).
Las actualizaciones de los actuadores se ejecutan en segundo plano.
Se mejoraron las instrucciones de instalación.
Se mejoró la navegación en el área de diccionarios.

Serie 0.x de Weblate¶

Weblate 0.9¶

Publicada el 18 de abril de 2012.

Se arregló la importación de idiomas desconocidos.
Improved listing of nearby messages.
Improved several checks.
Documentation updates.
Added definition for several more languages.
Various code cleanups.
Documentation improvements.
Changed file layout.
Update helper scripts to Django 1.4.
Improved navigation while translating.
Better handling of po file renames.
Better validation while creating component.
Integrated full setup into syncdb.
Added list of recent changes to all translation pages.
Check for not translated strings ignores format string only messages.

Weblate 0.8¶

Publicada el 3 de abril de 2012.

Replaced own full text search with Whoosh.
Various fixes and improvements to checks.
New command updatechecks.
Lot of translation updates.
Added dictionary for storing most frequently used terms.
Added /admin/report/ for overview of repositories status.
Machine translation services no longer block page loading.
Management interface now contains also useful actions to update data.
Records log of changes made by users.
Ability to postpone commit to Git to generate less commits from single user.
Possibility to browse failing checks.
Automatic translation using already translated strings.
New about page showing used versions.
Django 1.4 compatibility.
Ability to push changes to remote repo from web interface.
Added review of translations done by others.

Weblate 0.7¶

Publicada el 16 de febrero de 2012.

Direct support for GitHub notifications.
Added support for cleaning up orphaned checks and translations.
Displays nearby strings while translating.
Displays similar strings while translating.
Improved searching for string.

Weblate 0.6¶

Publicada el 14 de febrero de 2012.

Added various checks for translated messages.
Tunable access control.
Improved handling of translations with new lines.
Added client side sorting of tables.
Please check upgrading instructions in case you are upgrading.

Weblate 0.5¶

Publicada el 12 de febrero de 2012.

Support for machine translation using following online services:
- Apertium
- Microsoft Translator
- MyMemory
Several new translations.
Improved merging of upstream changes.
Better handle concurrent git pull and translation.
Propagating works for fuzzy changes as well.
Propagating works also for file upload.
Fixed file downloads while using FastCGI (and possibly others).

Weblate 0.4¶

Publicada el 8 de febrero de 2012.

Added usage guide to documentation.
Fixed API hooks not to require CSRF protection.

Weblate 0.3¶

Publicada el 8 de febrero de 2012.

Better display of source for plural translations.
New documentation in Sphinx format.
Displays secondary languages while translating.
Improved error page to give list of existing projects.
New per language stats.

Weblate 0.2¶

Publicada el 7 de febrero de 2012.

Mejor validación de determinados formularios.
Warn users on profile upgrade.
Remember URL for login.
Naming of text areas while entering plural forms.
Automatic expanding of translation area.

Weblate 0.1¶

Publicada el 6 de febrero de 2012.

Versión inicial.