API:Localisation/tr: Difference between revisions

Browse history interactively

← Older edit Newer edit →

Content deleted Content added

VisualWikitext

Inline

Revision as of 03:51, 29 May 2021

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 ApiBase::PARAM_HELP_MSG_PER_VALUE 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>.
Bilgisayar kodu olan herhangi bir şey için ‎<code>, ör. "max-age üstbilgisi" veya "‎<head> sayfası".
Anlamsal işaretleme kullanırken ek tırnak işaretlerine ihtiyacınız yoktur.

Diğer API modüllerine kaynağınız gerekiyorsa, bağlantıyı Special:ApiHelp ile bağlayın ve yardım biçimlendiricisi doğru olanı yapacaktır. Örneğin, belgelerde çeşitli token parametreleri için "[[Special:ApiHelp/query+tokens|action=query&meta=tokens]]" kullanılır. Special:ApiHelp bağlantısı, aynı yardım sayfasındaysa, sayfaya bağlı bir bağlantı olarak düzgün bir şekilde görüntülenir (örnek). Benzer şekilde, $wgMiserMode gibi MediaWiki yapılandırma değişkenlerine yapılan kaynaklar, mediawiki.org'daki belgelere bağlanmalıdır.

Örneklerde atıfta bulunulan sayfalar genellikle bağlantılı olmamalıdır, çünkü bu bağlantıların pek çok vikide bulunması olası değildir.

Hata ve uyarılar

Hatalar $this->dieWithError( $messageObjectOrKey ); çağrılarak ortaya çıkar ve mesaj her zamanki gibi yerelleştirilebilir. Aynı şekilde $this->addWarning( $messageObjectOrKey ); ile yapılan uyarılar için. Ayrıntılar için API:Errors and warnings sayfasına bakın.

Genellikle API hata mesajlarında apierror- ile başlayan mesaj anahtarları ve apiwarn- ile uyarı bulunur.

API yanıtlarındaki metin

ApiBase ve dolayısıyla tüm API modülleri de bağlam kaynaklarıdır. İletilere genellikle $this->msg() kullanılarak erişilmeli ve API modülünün kendisine genellikle bir IContextSource gerektiğinde iletilmelidir.

Bir istemci yararlı bulabileceğinden, iletiler keyfi olarak çıkışa dahil edilmemelidir.

Translatewiki'deki yerelleştirmeleri geliştirme

translatewiki.net adresindeki API yardım mesajı çevirilerini diğer temel MediaWiki iletilerinde olduğu gibi ekleyebilir ve geliştirebilirsiniz. İlgili mesaj grupları şunları içerir:

Ayrıca bakınız

API/Architecture_work/i18n – Eski API modüllerini yeni sisteme dönüştürme bilgileri içeren belge taslağı.

@@ Line 20: / Line 20: @@
 * Daha önce [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 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 <code>apihelp-''$path''-summary</code> mesajı ve modül düzeyinde ek belgeler içeren bir <code>apihelp-''$path''-extended-description</code>. Bunlar, karşılık gelen yöntemlerle geçersiz kılınabilir, ancak bunun gerekli olduğu durumlar nadirdir.
 ** 1.30'dan önce bir <code>apihelp-''$path''-description</code> mesajı kullanıldı. Bu, [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage()] yöntemi uygulanarak geçersiz kılındı, ancak bunun gerekli olduğu durumlar nadirdi.
-* Daha önce [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription()] yöntemi tarafından döndürülen parametre açıklama iletileri <code>apihelp-''$path''-param-''$name''</code> (burada <code>''$name''</code>, [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()] öğesinin anahtarıdır). Bu, [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()] üzerinden döndürülen veri yapısında [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#ab3a6e8b6e7cfbaf4f8bf4339a13d76c5 <code>ApiBase::PARAM_HELP_MSG</code>] için bir değer ayarlanarak geçersiz kılınabilir.
+* Daha önce [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription()] yöntemi tarafından döndürülen parametre açıklama iletileri <code>apihelp-''$path''-param-''$name''</code> (burada <code>''$name''</code>, [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()] öğesinin anahtarıdır). Bu, [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()] üzerinden döndürülen veri yapısında <code>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#ab3a6e8b6e7cfbaf4f8bf4339a13d76c5 ApiBase::PARAM_HELP_MSG]</code> 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 [[MediaWiki:api-help-param-continue|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 [[MediaWiki:api-help-param-direction|api-help-param-direction]] kullanmalıdır.
-** [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a9bd9dd747c20665d94b5939373b3f40c <code>needsToken()</code>] uygulayarak CSRF anahtarını kullanan modüllerin <var>token</var> parametresini belgelemeleri gerekmez; bu ApiBase tarafından otomatik olarak yapılır.
+** <code>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a9bd9dd747c20665d94b5939373b3f40c needsToken()]</code> uygulayarak CSRF anahtarını kullanan modüllerin <var>token</var> parametresini belgelemeleri gerekmez; bu ApiBase tarafından otomatik olarak yapılır.
 ** Birkaç ek sabit [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()] olarak kullanılabilir; ayrıntılar için ApiBase bakın.
-* [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a345d7963199abd8893bd88015f7d4ed6 <code>ApiBase::PARAM_TYPE</code>] dizisi olan parametreler, her değerin ayrı ayrı belgelendiğini belirtmek için [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a5a023b82d4aa17a44e33c1e8e2abdd6b <code>ApiBase::PARAM_HELP_MSG_PER_VALUE</code>] kullanabilir. Bu iletiler varsayılan olarak <code>apihelp-''$path''-paramvalue-''$name''-''$value''</code> şeklindedir. İletiler varsayılana göre adlandırılmışsa, iletileri <code>ApiBase::PARAM_HELP_MSG_PER_VALUE</code> dizisindeki değerlerle eşleştirmeye gerek yoktur (yine de var olması gerekir, ancak boş bırakılabilir).
+* <code>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a345d7963199abd8893bd88015f7d4ed6 ApiBase::PARAM_TYPE]</code> dizisi olan parametreler, her değerin ayrı ayrı belgelendiğini belirtmek için <code>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a5a023b82d4aa17a44e33c1e8e2abdd6b ApiBase::PARAM_HELP_MSG_PER_VALUE]</code> kullanabilir. Bu iletiler varsayılan olarak <code>apihelp-''$path''-paramvalue-''$name''-''$value''</code> şeklindedir. İletiler varsayılana göre adlandırılmışsa, iletileri <code>ApiBase::PARAM_HELP_MSG_PER_VALUE</code> 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ı <code>apihelp-''$path''-example-''$arbitrarySuffix''</code> satırları boyunca olmalıdır.

FuzzyBot (talk | contribs)