Help:Extension:Translate/Translation aids/pt-br

Auxiliares de tradução (ou ajudantes de tradução) são módulos que fornecem informações úteis e necessárias para o tradutor ao efetuar uma tradução. Diferentes auxiliares podem fornecer sugestões de memória de tradução e tradução automática, documentação sobre a mensagem ou até mesmo uma coisa tão básica como a definição da mensagem - o texto que precisa ser traduzido.

Há alguma sobreposição entre os dados fornecidos pela coleção de mensagens bem como os auxiliares, mas a regra geral é que a coleção de mensagem só fornece informações que são absolutamente necessárias para apresentar a lista de mensagens: definição, tradução, estado de tradução, último tradutor (porque é possível apenas revisar traduções feitas por outra pessoa), etc.

A extensão Translate vem com muitas classes de auxiliares. Cada classe que estende a classe TranslationAid só precisa implementar um método chamado. Ele deve retornar as informações em formato estruturado (arrays aninhados). Estes módulos podem ser chamados diretamente do PHP ou através do WebAPI.

Como usar auxiliares de tradução dentro do MediaWiki
Exemplo simples para obter a documentação de uma mensagem, se disponível.

Como usar a API dos auxiliares de tradução
As already seen above, translation aids are available via a WebAPI, which is using the MediaWiki WebAPI framework. Getting translation aids is as simple as doing HTTP GET for the URL http://translatewiki.net/w/api.php?action=translationaids&title=MediaWiki%3AJan%2Fde. It provides various different formats, but JSON and XML are the most popular ones. This API does not need authentication, but some translation aids like "inotherlanguages" uses user preferences to determine which languages to use. To use that aid you should log in first, as described in the MediaWiki WebAPI documentation.

The returned data should look like this (shown in pretty json format): Every requested aid is guaranteed to have a key here (until the request fails miserably), but while we use exceptions in the PHP side, in the JavaScript side each aid may have the key "error" set with the error message set as value. You can see an example of this above with. It signals that it cannot display a diff, because there have been no changes to the definition since last translation.

Exemplo de JavaScript
Here is the same thing for JavaScript. By default the API returns all aids, but you can request specific ones with the  param. In the example we are using jsonp to work around cross site request limitations. Be aware that you cannot execute any write actions with jsonp, so if you are using this API from JavaScript you will need: to have a proxy; to run the script on the same host; or to load a little helper (not yet implemented) from the target site.

Naming conventions and return values
Each translation aid has a unique string identifier. Identifiers should avoid special characters, especially those which are not valid in JavaScript identifiers, like  and.

The array that is returned by each translation aid is up to the developer, but should follow some general recommendations.

If only one text value is returned, it should use  as the key of the field. Language should be provided in field. Users of this data should ensure that in HTML and elsewhere the text is tagged properly with the provided language and directionality (not provided here). If there is HTML output, it should be available with key. Examples of this are message documentation and diffs.

Various kinds of translation suggestions like machine translation and translation memories should use these keys when they make sense:


 * ,  and   (target language is implicitly the same as the language of the translation)
 * : identifier of the service used
 * : value in range [0,1], higher value means that the quality of the suggestions is very good.

Note: When returning arrays, you must set the  field to contain an element name. For machine translation and translation memory this is. This is mandated by the MediaWiki WebAPI framework. It is visible in the XML format, but in JSON format the output is just a list.

Lista de ajudas padrão
[field] Means that the return value is a list. In PHP that means array with numerical indexes + one with key ; see above why this is needed.