Jump to content

API:Localisation/tr: Difference between revisions

From mediawiki.org
Content deleted Content added
FuzzyBot (talk | contribs)
Updating to match new version of source page
FuzzyBot (talk | contribs)
Updating to match new version of source page
 
(78 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{API}}
{{API}}
{{MW version|version=1.25|comment=and after|gerrit change=160798}}This documents things specific to localisation of the MediaWiki action API (<tt>api.php</tt>).
{{MW version|version=1.25|comment=and after|gerrit change=160798}}
Bu, MediaWiki eylem API'sinin (<code>api.php</code>) yerelleştirilmesine özgü şeyleri belgeler.
See [[Special:MyLanguage/Localisation|Localisation]] for general comments on MediaWiki localisation.
See {{ll|API:REST_API/Extensions/Modules}} for the REST API.
MediaWiki yerelleştirmesi hakkında genel yorumlar için [[Special:MyLanguage/Localisation|Yerelleştirme]] sayfasına bakın.


<span id="Message_files"></span>
== Mesaj dosyaları ==
== Mesaj dosyaları ==


Localisation messages for MediaWiki core are located under {{git file|project=mediawiki/core|file=includes/api/i18n|action=tree}}.
MediaWiki çekirdeği için yerelleştirme mesajları {{git file|project=mediawiki/core|file=includes/api/i18n|action=tree}} 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 [[Special:MyLanguage/Manual:$wgMessagesDirs|birden fazla dosya]] için normal mekanizmalar kullanılarak ayrı bir dosyada olmalıdır.
For extensions, the messages that are only used for API documentation and aren't seen by most end users should be in a separate file using the normal mechanisms for having [[Special:MyLanguage/Manual:$wgMessagesDirs|multiple files]].
See the [[Special:MyLanguage/Localisation#Adding_new_messages|localisation documentation about adding new messages]].
[[Special:MyLanguage/Localisation#Adding_new_messages|Yeni mesaj eklemeyle ilgili yerelleştirme belgelerine]] bakın.


<span id="Help_messages"></span>
== Yardım mesajları ==
== Yardım mesajları ==


<span id="Naming"></span>
=== Adlandırma ===
=== Adlandırma ===
API modülleri için yardım mesajları, [[Special:ApiHelp/help|action=help]] “modules” parametresi için kullanılan dize olan "module path" kullanılarak adlandırılır.
{{ll|Manual:$wgAPIModules|$wgAPIModules}} ile eklenen modüller için bu, bu dizide kullanılan anahtarla aynı olurken, {{ll|Manual:$wgAPIPropModules|$wgAPIPropModules}}, {{ll|Manual:$wgAPIListModules|$wgAPIListModules}} veya {{ll|Manual:$wgAPIMetaModules|$wgAPIMetaModules}} 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 <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.
The help messages for API modules are namespaced using the "module path", which is the string used for [[Special:ApiHelp/help|action=help]]'s "modules" parameter.
** <span class="mw-translate-fuzzy">1.30'dan önce bir <code>apihelp-''$path''-description</code> mesajı kullanıldı. Bu, $1 yöntemi uygulanarak geçersiz kılındı, ancak bunun gerekli olduğu durumlar nadirdi.</span> <span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
For modules added to {{ll|Manual:$wgAPIModules|$wgAPIModules}} this is going to be the same as the key used in that array, while for modules added to {{ll|Manual:$wgAPIPropModules|$wgAPIPropModules}}, {{ll|Manual:$wgAPIListModules|$wgAPIListModules}}, or {{ll|Manual:$wgAPIMetaModules|$wgAPIMetaModules}} it will be that key prefixed with "query+".
* 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.
** <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.
* <span class="mw-translate-fuzzy"><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).</span> <span lang="en" dir="ltr" class="mw-content-ltr">These messages are by default <code>apihelp-''$path''-paramvalue-''$name''-''$value''</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If the messages are named according to the default, there is no need to map messages to values in the {{phpi|ApiBase::PARAM_HELP_MSG_PER_VALUE}} array (it still has to exist but can be left empty).</span>
* <span class="mw-translate-fuzzy">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.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Message names should be along the lines of <code>apihelp-''$path''-example-''$arbitrarySuffix''</code>.</span>


<span id="Message_documentation"></span>
* The description message, formerly returned by the [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 getDescription()] method, has been split into two: a <code>apihelp-''$path''-summary</code> message with a one-line summary of the module and a <code>apihelp-''$path''-extended-description</code> containing any additional module-level documentation. These may be overridden with corresponding methods, but cases where that is needed are rare.
=== Mesaj belgesi ===
** Prior to 1.30, a <code>apihelp-''$path''-description</code> message was used. 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.
* The parameter description messages, formerly returned by the [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription()] method, are <code>apihelp-''$path''-param-''$name''</code> (where <code>''$name''</code> is the key from [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()]). This may be overridden by setting a value for [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#ab3a6e8b6e7cfbaf4f8bf4339a13d76c5 <code>ApiBase::PARAM_HELP_MSG</code>] in the data structure returned from [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()].
** Parameters with a description similar to "When more results are available, use this to continue" should use [[MediaWiki:api-help-param-continue|api-help-param-continue]] instead of redefining a duplicate message.
** Sorting parameters taking values "newer" and "older" (with related "start" and "end" parameters) should use [[MediaWiki:api-help-param-direction|api-help-param-direction]] instead of redefining a duplicate message.
** Modules using CSRF tokens by implementing [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a9bd9dd747c20665d94b5939373b3f40c <code>needsToken()</code>] do not need to document the <var>token</var> parameter; this is automatically handled by ApiBase.
** Several additional constants are available for use in [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams()]; see ApiBase for details.
* Parameters with an array for [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a345d7963199abd8893bd88015f7d4ed6 <code>ApiBase::PARAM_TYPE</code>] may use [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a5a023b82d4aa17a44e33c1e8e2abdd6b <code>ApiBase::PARAM_HELP_MSG_PER_VALUE</code>] to specify that each value is individually documented. These messages are by default <code>apihelp-''$path''-paramvalue-''$name''-''$value''</code>. If the messages are named according to the default, there is no need to map messages to values in the <code>ApiBase::PARAM_HELP_MSG_PER_VALUE</code> array (it still has to exist but can be left empty).
* All examples must have a descriptive text. Message names should be along the lines of <code>apihelp-''$path''-example-''$arbitrarySuffix''</code>.


{{git file|file=includes/Api/i18n/qqq.json|text=qqq.json}} içindeki mesajları belgelendirirken aşağıdaki şablonları kullanın:
{{anchor|Message documentation}}
=== Message documentation ===


* {{tl2|doc-apihelp-summary|sister=translatewiki|2=''modül yolu''}}
When documenting the messages in {{git file|file=includes/api/i18n/qqq.json|text=qqq.json}}, use the following templates:
* {{tl2|doc-apihelp-description|sister=translatewiki|2=''<span lang="en" dir="ltr" class="mw-content-ltr">module path</span>''}}
* <code>{{[[translatewiki:Template:Doc-apihelp-summary|doc-apihelp-summary]]|''module path''}}</code>
* <code>{{[[translatewiki:Template:Doc-apihelp-extended-description|doc-apihelp-extended-description]]|''modül yolu''}}</code>
* {{tl2|doc-apihelp-extended-description|sister=translatewiki|2=''modül yolu''}}
* <code>{{[[translatewiki:Template:Doc-apihelp-param|doc-apihelp-param]]|''module path''|''parameter name''}}</code>
* {{tl2|doc-apihelp-param|sister=translatewiki|2=''modül yolu''|3=''parametre adı''}}
* <code>{{[[translatewiki:Template:Doc-apihelp-paramvalue|doc-apihelp-paramvalue]]|''module path''|''parameter name''|''parameter value''}}</code>
* {{tl2|doc-apihelp-paramvalue|sister=translatewiki|2=''modül yolu''|3=''parametre adı''|4=''parametre değeri''}}
* {{tl2|doc-apihelp-paraminfo|sister=translatewiki|2=''<span lang="en" dir="ltr" class="mw-content-ltr">module path</span>''|3=''<span lang="en" dir="ltr" class="mw-content-ltr">parameter info tag name</span>''}}
* <code>{{[[translatewiki:Template:Doc-apihelp-example|doc-apihelp-example]]|''module path''}}</code>
* {{tl2|doc-apihelp-example|sister=translatewiki|2=''modül yolu''}}


=== Message formatting ===


<span id="Message_formatting"></span>
All messages should end with a period, and be grammatical sentences.
=== Mesaj biçimlendirme ===
For parameters passed to the messages by default, see the templates linked from [[#Message documentation|#Message documentation]].
Tüm mesajlar bir nokta ile bitmeli ve gramer cümleleri olmalıdır.
Varsayılan olarak iletilere iletilen parametreler için [[#Message documentation|#Mesaj belgesi]]'nden bağlanan şablonlara bakın.


İletilerde anlamsal vikimetin işaretlemesi kullanın:
Use semantic wikitext markup in messages:


* {{tag|var|o}} for mention of parameter keys, and also references to variables like <var>$wgMiserMode</var>.
* Parametre anahtarları için {{tag|var|o}} ve ayrıca <var>$wgMiserMode</var> 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 {{tag|kbd|o}}.
* {{tag|kbd|o}} 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.
* API çıkışındaki anahtarlardan veya değerlerden bahsetmek için {{tag|samp|o}}.
* {{tag|samp|o}} for mention of keys or values in the API output.
* {{tag|code|o}} for anything else that's computer code, e.g. "the <code>max-age</code> header" or "the page {{tag|head|open}}".
* Bilgisayar kodu olan herhangi bir şey için {{tag|code|o}}, ör. "<code>max-age</code> üstbilgisi" veya "{{tag|head|open}} sayfası".
* Anlamsal işaretleme kullanırken ek tırnak işaretlerine ihtiyacınız yoktur.
* You don't need additional quotation marks when using semantic markup.


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.
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, "<code><nowiki>[[Special:ApiHelp/query+tokens|action=query&meta=tokens]]</nowiki></code>" is used in the documentation for various <var>token</var> parameters.
Örneğin, belgelerde çeşitli <var>token</var> parametreleri için "<syntaxhighlight lang=moin inline>[[Special:ApiHelp/query+tokens|action=query&meta=tokens]]</syntaxhighlight>" kullanılır.
The Special:ApiHelp link properly renders as an in-page anchored link if it's on the same help page ([[Special:ApiHelp/rsub/main#edit|example]]).
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 ([[Special:ApiHelp/rsub/main#edit|örnek]]).
Similarly, reference to MediaWiki configuration variables such as <var>$wgMiserMode</var> should link to the documentation on mediawiki.org.
Benzer şekilde, <var>$wgMiserMode</var> 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.
Pages referenced in examples should generally not be linked, as these links are unlikely to exist on many wikis.


<span id="Errors_and_warnings"></span>
== Hata ve uyarılar ==
== Hata ve uyarılar ==
<span class="mw-translate-fuzzy">Hatalar <syntaxhighlight lang="php" inline>$this->dieWithError( $messageObjectOrKey );</syntaxhighlight> çağrılarak ortaya çıkar ve mesaj her zamanki gibi yerelleştirilebilir. Aynı şekilde $warning-snippet ile yapılan uyarılar için.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Likewise for warnings with <syntaxhighlight lang="php" inline>$this->addWarning( $messageObjectOrKey );</syntaxhighlight>.</span>
Ayrıntılar için {{ll|API:Errors and warnings}} sayfasına bakın.


Genellikle API hata mesajlarında <code>apierror-</code> ile başlayan mesaj anahtarları ve <code>apiwarn-</code> ile uyarı bulunur.
Errors are raised by calling <syntaxhighlight lang="php" inline>$this->dieWithError( $messageObjectOrKey );</syntaxhighlight> and the message can be localized in the usual way. Likewise for warnings with <syntaxhighlight lang="php" inline>$this->addWarning( $messageObjectOrKey );</syntaxhighlight>.
Mesaj belgelerinde {{tl2|doc-apierror|sister=translatewiki}} kullanabilirsiniz.
See {{ll|API:Errors and warnings}} for details.


<span id="Text_in_API_responses"></span>
Customarily API error messages have message keys starting with <code>apierror-</code> and warnings with <code>apiwarn-</code>.
== API yanıtlarındaki metin ==
<span class="mw-translate-fuzzy">ApiBase ve dolayısıyla tüm API modülleri de bağlam kaynaklarıdır. İletilere genellikle $code kullanılarak erişilmeli ve API modülünün kendisine genellikle bir IContextSource gerektiğinde iletilmelidir.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Messages should generally be accessed using {{phpi|$this->msg()}}, and the API module itself should generally be passed when an IContextSource is needed.</span>


Bir istemci yararlı bulabileceğinden, iletiler keyfi olarak çıkışa dahil edilmemelidir.
== Text in API responses ==


<span id="Improving_localisations_on_translatewiki"></span>
ApiBase, and thus all API modules, are also context sources. Messages should generally be accessed using <code>$this->msg()</code>, and the API module itself should generally be passed when an IContextSource is needed.
== Translatewiki'deki yerelleştirmeleri geliştirme ==
<span class="mw-translate-fuzzy">[[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:</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The relevant message groups include</span>


* [[translatewiki:Special:Translate/mediawiki-api|MediaWiki eylem API'si]]
Messages should not be arbitrarily included in the output because a client might find it useful.
* [[translatewiki:Special:Translate/ext-apifeatureusage|API özellik kullanımı]]


<span id="See_also"></span>
== Improving localisations on translatewiki ==
== Ayrıca bakınız ==

* {{ll|API/Architecture_work/i18n}} – Eski API modüllerini mevcut sisteme dönüştürmek için bilgi içeren 2014 tarihli taslak belge.
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

* [[translatewiki:Special:Translate/mediawiki-api|MediaWiki action API]]
* [[translatewiki:Special:Translate/ext-apifeatureusage|API feature usage]]

== See also ==

* [[API/Architecture_work/i18n]] – Draft document with information for converting old API modules to the new system.

Latest revision as of 00:19, 17 May 2026

MediaWiki sürümü:
1.25
Gerrit change 160798

Bu, MediaWiki eylem API'sinin (api.php) yerelleştirilmesine özgü şeyleri belgeler. See API:REST_API/Extensions/Modules for the REST API. 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, $1 yöntemi uygulanarak geçersiz kılındı, ancak bunun gerekli olduğu durumlar nadirdi. This was be overridden by implementing the getDescriptionMessage() method, but cases where that was needed were rare.
  • 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). These messages are by default apihelp-$path-paramvalue-$name-$value. If the messages are named according to the default, there is no need to map messages to values in the ApiBase::PARAM_HELP_MSG_PER_VALUE array (it still has to exist but can be left empty).
  • Tüm örneklerde açıklayıcı bir metin bulunmalıdır. Mesaj adları apihelp-$path-example-$arbitrarySuffix satırları boyunca olmalıdır. Message names should be along the lines of apihelp-$path-example-$arbitrarySuffix.

Mesaj belgesi

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


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 $warning-snippet ile yapılan uyarılar için. Likewise for warnings with $this->addWarning( $messageObjectOrKey );. 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. 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 $code kullanılarak erişilmeli ve API modülünün kendisine genellikle bir IContextSource gerektiğinde iletilmelidir. Messages should generally be accessed using $this->msg(), and the API module itself should generally be passed when an IContextSource is needed.

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: The relevant message groups include

Ayrıca bakınız