Template:ApiParam/tr
Şablon belgelemesi
- Bu şablonun çağrılarını Special:ApiHelp eklemesi (görev 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 |
name (veya ilk adsız) |
Parametre adı (gerekli). |
description (veya ikinci adsız) |
Parametrenin açıklaması. |
required |
Parametre gerekliyse bir değer belirtin. Gerekli parametrenin adı kalınlaştırılır. |
maxallowed |
Borularla ayrılmış değerler veya sayısal miktarlar için izin verilen maksimum değer. |
maxallowedbot |
Yukarıdaki gibi, botlar için. maxallowed için 50 veya 500 kullanılırsa, varsayılan olarak 500 veya 5000 olur.
|
type |
Parametrenin veri türü. |
values |
Parametre için olası değerlerin bir listesi. |
default |
Parametre için varsayılan değer. |
version |
Parametrenin tanıtıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın. |
deprecated |
Parametrenin kullanımdan kaldırıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın. |
removed |
Parametrenin kaldırıldığı sürüm. Yalnızca düz MediaWiki sürüm numarasını kullanın. |
Ö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 informationarticlepath: $wgArticlePath 1.15+
Ayrıca bakınız
- {{Parameter}} – ApiParam eski sürümü