Help:Extension:Translate/Translation aids/cs

Překladatelská nápověda (angl. Translation aids) je soubor modulů, které v průběhu překladu nabízejí překladateli další informace ke zprávě. Jako jsou návrhy na překlad zprávy, ze strojového překladu nebo překladové paměti. Dokumentace ke zprávě, nebo i tak základní věc, jakou je definice zprávy - textu, který se má přeložit.

Mezi informacemi, které jsou součástí souboru zpráv a těmi, které poskytuje překladatelská nápověda je určitý přesah, ale v podstatě se dá říct, že v souboru zpráv jsou uloženy pouze informace, které jsou nezbytně nutné pro zpracování dobrého překladu: definice zpráv, jejich překlady, informace o stavu překladu a záznam o posledním překladateli (protože revidovat můžete pouze zprávy, které překládal někdo jiný) atd.

Rozšíření Translate obsahuje několik tříd, které během překladu dodávají pomocné informace. Každá z nich je samostatný modul třídy TranslationAid (třída co se stará o překladatelskou nápovědu), který má implementovanou metodu s názvem, vracející vyžádaná data ve strukturovaném formátu (vnořená pole). Moduly lze volat přímo z PHP kódu, nebo přes WebAPI.

Jak použít překladatelskou nápovědu v MediaWiki
Toto je jednoduchý příklad, jak lze získat dokumentaci ke zprávě, je-li dostupná.

Jak volat překladatelskou nápovědu přes API
Jak bylo zmíněno výše, překladatelskou nápovědu lze volat rovněž přes webové API MediaWiki. Pro získání nápovědy, stačí udělat HTTP GET na URL http://translatewiki.net/w/api.php?action=translationaids&title=MediaWiki%3AJan%2Fde. V URL můžete upřesnit formát, ve kterém se má vrátit výsledek. Nejčastěji se využívá JSON a XML. Přístup přes API nevyžaduje autentizaci, ale některé části překladatelské nápovědy, jako je například "inotherlanguages", pracují s uživatelsky zvolenou preferencí jazyka. Chcete-li použít tuto nápovědu, pak se musíte nejdřív přihlásit do API, jak je popsáno v dokumentaci k WebAPI MediaWiki.

Data, která se vrátí mohou vypadat takto (formát json, upravený do čitelnější podoby): Každý dotaz na překladatelskou nápovědu musí obsahovat klíč (bez něj se vrátí jen oznámení o chybě), to lze na straně PHP kódu ošetřit výjimkou. JavaScript to má ošetřeno tak, že používá jako výchozí hodnotou klíče používá řetězec "error". Ve výše uvedeném ukázkovém výpisu si toho můžete povšimnout tohoto indexu u pole, kde zpráva pod tímto klíčem oznamuje, že rozdílový soubor není k dispozici, protože v definici zprávy nenastaly od posledního překladu žádné změny.

Příklad použití v JavaScriptu
Následující kód dělá totéž, ale přes JavaScript. Není-li řečeno jinak, vrací API veškerý dostupný obsah překladatelské nápovědy. Parametrem  si však můžeme vybrat jen tu, která nás zajímá. V následujícím příkladu se používá jsonp, abychom přes něj obešli omezení na přecházení mezi portály. Přes jsonp nelze zapisovat, takže pokud budete chtít pracovat s API přes JavaScript, musíte buď: použít proxy; spouštět JavaScript skript na stejném hostiteli jako běží API; nebo použít mimo něj na straně cílové stránky pomocnou aplikaci, která však v tomto případě není implementovaná.

Pravidla pojmenování a návratové hodnoty
Každá překladatelská nápověda používá svůj jedinečný identifikátor, kterým je alfanumerický řetězec. Ten nesmí obsahovat diakritiku, speciální znaky, ani znaky  a.

Pole, které vrací každá ze tříd překladatelské nápovědy, zpracovává vývojář, mělo by však splňovat následující obecná doporučení.

Je-li návratovou hodnotou pouze jeden textový řetězec, můžete použít rovnou jako index řetězec. Kód jazyka je pod indexem. Na základě těchto údajů již lze zajistit, aby byl text řádně označkován, ve správném jazyce a také ve správném směru (informace o směrovosti textu je daná jazykem, proto není součástí návratové hodnoty). Obsahuje-li návratové pole také kód v HTML, bude dostupný pod indexem. Může to být kupř. dokumentace k překládané zprávě, nebo kód s informací o rozdílech.

U navrhovaných překladů, ať už pochází ze strojového překladu, nebo překladové paměti, lze použít tyto indexy:


 * ,  a   (kód jazyka do kterého se překládá v poli pod indexem  )
 * : identifikátor použité služby
 * : hodnota v rozmezí [0,1], čím vyšší, tím lepší je kvalita navrhovaného překladu.

Poznámka: Je-li návratovou hodnotou pole, pak je pod indexem ** uloženo jméno příslušného elementu. U zpráv, které pochází ze strojového překladu, nebo překladové paměti je to. To je dáno API MediaWiki. Jméno elementu je jinak vidět pouze u výstupu v XML formátu, v JSON formátu se vypíše pouze seznam zpráv.

Seznam standardních modulů překladatelské nápovědy
[index] Znamená, že návratovou hodnotou indexované buňky je pole. V PHP to je pole buněk s numerickými indexy a jedním řetězcovým indexem ; viz výše.