API:Localisation/tr

Bu, MediaWiki eylem API'sinin 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ı 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.



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. ile eklenen modüller için bu, bu dizide kullanılan anahtarla aynı olurken,, veya  ile eklenen modüller için, "query+" önekine sahip anahtar olacaktır.


 * 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  mesajı ve modül düzeyinde ek belgeler içeren bir  . Bunlar, karşılık gelen yöntemlerle geçersiz kılınabilir, ancak bunun gerekli olduğu durumlar nadirdir. These may be overridden with corresponding methods, but cases where that is needed are rare.
 * 1.30'dan önce bir  mesajı kullanıldı. Bu, $1 yöntemi uygulanarak geçersiz kılındı, ancak bunun gerekli olduğu durumlar nadirdi. This was be overridden by implementing the [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage] method, but cases where that was needed were rare.
 * 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  (burada , [//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   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.
 * uygulayarak CSRF anahtarını kullanan modüllerin token 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.
 * dizisi olan parametreler, her değerin ayrı ayrı belgelendiğini belirtmek için  kullanabilir. Bu iletiler varsayılan olarak   şeklindedir. İletiler varsayılana göre adlandırılmışsa, iletileri   dizisindeki değerlerle eşleştirmeye gerek yoktur (yine de var olması gerekir, ancak boş bırakılabilir). These messages are by default  . If the messages are named according to the default, there is no need to map messages to values in the  array (it still has to exist but can be left empty).
 * Tüm örneklerde açıklayıcı bir metin bulunmalıdır. Mesaj adları  satırları boyunca olmalıdır. Message names should be along the lines of.



Mesaj belgesi
içindeki mesajları belgelendirirken aşağıdaki şablonları kullanın:


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



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 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.
 * API çıkışındaki anahtarlardan veya değerlerden bahsetmek için.
 * Bilgisayar kodu olan herhangi bir şey için, ör. " üstbilgisi" veya " 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 " " 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  çağrılarak ortaya çıkar ve mesaj her zamanki gibi yerelleştirilebilir. Aynı şekilde  ile yapılan uyarılar için. Ayrıntılar için sayfasına bakın.

Genellikle API hata mesajlarında  ile başlayan mesaj anahtarları ve   ile uyarı bulunur. Mesaj belgelerinde doc-apierror kullanabilirsiniz.



API yanıtlarındaki metin
ApiBase ve dolayısıyla tüm API modülleri de bağlam kaynaklarıdır. İletilere genellikle 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:


 * MediaWiki eylem API'si
 * API özellik kullanımı



Ayrıca bakınız

 * – Eski API modüllerini mevcut sisteme dönüştürmek için bilgi içeren 2014 tarihli taslak belge.