API:Localisation/cs

Dokumentuje věci specifické pro lokalizaci API akce MediaWiki. Obecné komentáře k lokalizaci MediaWiki najdete na stránce Localisation.



Soubory zpráv
Lokalizační zprávy pro jádro MediaWiki jsou umístěny pod.

U rozšíření pro zprávy, které se používají pouze pro dokumentaci API a které většina koncových uživatelů nevidí, měly být v samostatném souboru s použitím běžných mechanismů pro více souborů. Viz lokalizační dokumentace o přidávání nových zpráv.



Pojmenování
Zprávy nápovědy pro moduly API mají jmenný prostor pomocí "cesty k modulu", což je řetězec používaný pro parametr "modules" action=help. Pro moduly přidané do bude stejný jako klíč použitý v tomto poli, zatímco pro moduly přidané do,  nebo  to bude klíč s předponou "query+".


 * Popisová zpráva, dříve vracená metodou [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 getDescription], byla rozdělena do dvou: Zpráva  s jednořádkovým shrnutím modulu a   obsahující jakoukoli další dokumentaci na úrovni modulu. Ty mohou být potlačeny odpovídajícími metodami, ale případy, kdy je to potřeba, jsou vzácné.
 * Před 1.30 se používala zpráva . To bylo potlačeno implementací metody [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage], ale případy, kdy to bylo potřeba, byly vzácné.
 * Zprávy s popisem parametrů, které dříve vracela metoda [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription], jsou  (kde   je klíč z [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]). To lze přepsat nastavením hodnoty   v datové struktuře vrácené z [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams].
 * Parametry s popisem podobným jako "Když jsou k dispozici další výsledky, pokračujte pomocí tohoto" by měly místo předefinování duplicitní zprávy používat api-help-param-continue.
 * Parametry řazení nabývající hodnot "newer" (novější) a "older" (starší) (se souvisejícími parametry "start" (začátek) a "end" (konec)) by měly místo předefinování duplicitní zprávy používat api-help-param-direction.
 * Moduly využívající tokeny CSRF implementací  nemusí dokumentovat parametr token . Toto je automaticky řešeno ApiBase.
 * V [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams] je k dispozici několik dalších konstant. Podrobnosti viz ApiBase.
 * Parametry s polem pro  mohou použít   k určení, že každá hodnota je zdokumentována samostatně. Tyto zprávy jsou ve výchozím nastavení  . Pokud jsou zprávy pojmenovány podle výchozího nastavení, není třeba zprávy mapovat na hodnoty v poli  (stále musí existovat, ale může zůstat prázdné).
 * Všechny příklady musí mít popisný text. Názvy zpráv by měly být v souladu s.



Dokumentace zprávy
Při dokumentování zpráv v použijte následující šablony:


 * doc-apihelp-summary
 * doc-apihelp-description
 * doc-apihelp-extended-description
 * doc-apihelp-param
 * doc-apihelp-paramvalue
 * doc-apihelp-paraminfo
 * doc-apihelp-example

Message formatting
All messages should end with a period, and be grammatical sentences. For parameters passed to the messages by default, see the templates linked from #Message documentation.

Use semantic wikitext markup in messages:


 * for mention of parameter keys, and also references to variables like $wgMiserMode.
 * for the possible values of parameters, mention of parameters with values (including references to other modules), and the mention of the input values in example docs.
 * for mention of keys or values in the API output.
 * for anything else that's computer code, e.g. "the  header" or "the page ".
 * You don't need additional quotation marks when using semantic markup.

If you need to reference other API modules, pipe a link to Special:ApiHelp and the help formatter will do the right thing. For example, " " is used in the documentation for various token parameters. The Special:ApiHelp link properly renders as an in-page anchored link if it's on the same help page (example). Similarly, reference to MediaWiki configuration variables such as $wgMiserMode should link to the documentation on mediawiki.org.

Pages referenced in examples should generally not be linked, as these links are unlikely to exist on many wikis.

Errors and warnings
Errors are raised by calling  and the message can be localized in the usual way. Likewise for warnings with. See for details.

Customarily API error messages have message keys starting with  and warnings with. You can use doc-apierror in the message documentation.

Text in API responses
ApiBase, and thus all API modules, are also context sources. Messages should generally be accessed using, and the API module itself should generally be passed when an IContextSource is needed.

Messages should not be arbitrarily included in the output because a client might find it useful.

Improving localisations on translatewiki
You can add and improve API help message translations on translatewiki.net, in the same manner as other core MediaWiki messages. The relevant message groups include


 * MediaWiki action API
 * API feature usage