API:Yerelleştirme

Bu sayfa MediaWiki Eylem API'si belgelerinin bir parçasıdır.

MediaWiki sürümü:

≥ 1.25

Gerrit change 160798

Bu, MediaWiki eylem API'sinin (api.php) yerelleştirilmesine özgü şeyleri belgeler.

MediaWiki yerelleştirmesi hakkında genel yorumlar için Yerelleştirme sayfasına bakın.

Mesaj dosyaları

MediaWiki çekirdeği için yerelleştirme mesajları includes/api/i18n altında bulunur.

Uzantılar için, yalnızca API belgesi için kullanılan ve çoğu son kullanıcı tarafından görülmeyen mesajlar birden fazla dosya için normal mekanizmalar kullanılarak ayrı bir dosyada olmalıdır. Yeni mesaj eklemeyle ilgili yerelleştirme belgelerine bakın.

Yardım mesajları

Adlandırma

API modülleri için yardım mesajları, action=help “modules” parametresi için kullanılan dize olan "module path" kullanılarak adlandırılır. $wgAPIModules ile eklenen modüller için bu, bu dizide kullanılan anahtarla aynı olurken, $wgAPIPropModules , $wgAPIListModules veya $wgAPIMetaModules ile eklenen modüller için, "query+" önekine sahip anahtar olacaktır.

Daha önce getDescription() yöntemi tarafından döndürülen açıklama iletisi ikiye bölünmüştür: modülün tek satırlık özetini içeren bir apihelp-$path-summary mesajı ve modül düzeyinde ek belgeler içeren bir apihelp-$path-extended-description. Bunlar, karşılık gelen yöntemlerle geçersiz kılınabilir, ancak bunun gerekli olduğu durumlar nadirdir.
- 1.30'dan önce bir apihelp-$path-description mesajı kullanıldı. Bu, getDescriptionMessage() yöntemi uygulanarak geçersiz kılındı, ancak bunun gerekli olduğu durumlar nadirdi.
Daha önce getParamDescription() yöntemi tarafından döndürülen parametre açıklama iletileri apihelp-$path-param-$name (burada $name, getAllowedParams() öğesinin anahtarıdır). Bu, getAllowedParams() üzerinden döndürülen veri yapısında ApiBase::PARAM_HELP_MSG için bir değer ayarlanarak geçersiz kılınabilir.
- "Daha fazla sonuç olduğunda, devam etmek için bunu kullanın" benzeri bir açıklamaya sahip parametreler, yinelenen bir iletiyi yeniden tanımlamak yerine api-help-param-continue kullanmalıdır.
- "newer" ve "older" (ilgili "start" ve "end" parametreleriyle) değerleri alan parametreleri sıralamak, yinelenen bir iletiyi yeniden tanımlamak yerine api-help-param-direction kullanmalıdır.
- needsToken() uygulayarak CSRF anahtarını kullanan modüllerin token parametresini belgelemeleri gerekmez; bu ApiBase tarafından otomatik olarak yapılır.
- Birkaç ek sabit getAllowedParams() olarak kullanılabilir; ayrıntılar için ApiBase bakın.
ApiBase::PARAM_TYPE dizisi olan parametreler, her değerin ayrı ayrı belgelendiğini belirtmek için $ 2 kullanabilir. Bu iletiler varsayılan olarak apihelp-$path-paramvalue-$name-$value şeklindedir. İletiler varsayılana göre adlandırılmışsa, iletileri ApiBase::PARAM_HELP_MSG_PER_VALUE dizisindeki değerlerle eşleştirmeye gerek yoktur (yine de var olması gerekir, ancak boş bırakılabilir).
Tüm örneklerde açıklayıcı bir metin bulunmalıdır. Mesaj adları apihelp-$path-example-$arbitrarySuffix satırları boyunca olmalıdır.

Mesaj belgesi

qqq.json içindeki mesajları belgelendirirken aşağıdaki şablonları kullanın:

{{doc-apihelp-summary|modül yolu}}
{{doc-apihelp-extended-description|modül yolu}}
{{doc-apihelp-param|modül yolu|parametre adı}}
{{doc-apihelp-paramvalue|modül yolu|parametre adı|parametre değeri}}
{{doc-apihelp-example|modül yolu}}

Mesaj biçimlendirme

Tüm mesajlar bir nokta ile bitmeli ve gramer cümleleri olmalıdır. Varsayılan olarak iletilere iletilen parametreler için #Mesaj belgesi'nden bağlanan şablonlara bakın.

İletilerde anlamsal vikimetin işaretlemesi kullanın:

Parametre anahtarları için ‎<var> ve ayrıca $wgMiserMode gibi değişkenlere kaynakçası.
Parametrelerin olası değerleri, değerlere sahip parametrelerden bahsedilmesi (diğer modüllere kaynakça dahil) ve örnek belgelerdeki giriş değerlerinden bahsedilmesi için ‎<kbd>.
API çıkışındaki anahtarlardan veya değerlerden bahsetmek için ‎<samp>.
‎<code> for anything else that's computer code, e.g. "the max-age header" or "the page ‎<head>".
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, "[[Special:ApiHelp/query+tokens|action=query&meta=tokens]]" 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.

Hata ve uyarılar

Errors are raised by calling $this->dieWithError( $messageObjectOrKey ); and the message can be localized in the usual way. Likewise for warnings with $this->addWarning( $messageObjectOrKey );. See API:Errors and warnings for details.

Customarily API error messages have message keys starting with apierror- and warnings with apiwarn-.

Text in API responses

ApiBase, and thus all API modules, are also context sources. Messages should generally be accessed using $this->msg(), 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