Template:ApiParam/tr

Şablon belgelemesi

Bu şablonun çağrılarını Special:ApiHelp eklemesi (T89318) ile değiştirmeyi düşünün, çünkü bu şablonu doldurmak kaynak kodundaki API parametre belgelerini gereksiz yere tekrarlar.

Kullanım

Bu şablon API parametrelerini belgelemek için kullanılabilir. Amacı, şablon parametrelerinin görünümünü tüm API sayfalarında uyumlaştırmaktır.

{{ApiParam
|name=
|description=
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}

ApiParam parametreleri
Parametre İsmi	Açıklama	Required?
name (veya ilk adsız)	Parametre adı (gerekli).	Gerekli
description (veya ikinci adsız)	Parametrenin açıklaması.	İsteğe bağlı
required	Parametre gerekliyse bir değer belirtin. Gerekli parametrenin adı kalınlaştırılır.	İsteğe bağlı
maxallowed	Borularla ayrılmış değerler veya sayısal miktarlar için izin verilen maksimum değer.	İsteğe bağlı
maxallowedbot	Yukarıdaki gibi, botlar için. maxallowed için 50 veya 500 kullanılırsa, varsayılan olarak 500 veya 5000 olur.	İsteğe bağlı
type	Parametrenin veri türü.	İsteğe bağlı
values	Parametre için olası değerlerin bir listesi.	İsteğe bağlı
default	Parametre için varsayılan değer.	İsteğe bağlı
version	Parametrenin tanıtıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın.	İsteğe bağlı
deprecated	Parametrenin kullanımdan kaldırıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın.	İsteğe bağlı
removed	Parametrenin kaldırıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın.	İsteğe bağlı

Örnekler

*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}}

• rcid: One or more recent changes IDs from which to add or remove the tag. 50 fazladan (botlar için 500) izin verilmez.

*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}

• siprop: Which properties to get (Varsayılan: general)
  • general: General site information
    • articlepath: $wgArticlePath 1.15+

Ayrıca bakınız

• {{Parameter }} – ApiParam eski sürümü

Kullanıcılar denemelerini bu şablonun deneme tahtası (oluştur | ayna) ve test senaryoları (oluştur) sayfalarında yapabilir.
Bu şablonun altsayfalarıdır.