Template:ApiParam/cs
Dokumentace šablony
- Zvažte nahrazení vyvolání této šablony transkluzí Special:ApiHelp (T89318), protože vyplnění této šablony zbytečně opakuje dokumentaci parametrů API ve zdrojovém kódu.
Použití
Tuto šablonu lze použít k dokumentaci parametrů API. Jejím záměrem je harmonizovat vzhled parametrů šablony napříč všemi stránkami API.
{{#parsoid\0fragment:0}}''name=''{{#parsoid\0fragment:1}}''description=''{{#parsoid\0fragment:2}}
| Parametry ApiParam | |
|---|---|
| Název parametru | Popis |
name (nebo první nejmenovaný) | Název parametru (povinný). |
description (nebo druhý nejmenovaný) | Popis parametru. |
required | Pokud je parametr vyžadován, zadejte hodnotu. Název požadovaného parametru bude vyznačen tučně. |
maxallowed | Maximální povolené hodnoty pro hodnoty oddělené svislou čarou nebo číselné veličiny. |
maxallowedbot | Jak je uvedeno výše, pro roboty. Pokud je pro maxallowed použito 50 nebo 500, bude výchozí hodnota 500 nebo 5000. |
type | Datový typ parametru. |
values | Seznam možných hodnot pro parametr. |
default | Výchozí hodnota parametru. |
version | Verze, ve které byl parametr zaveden. Použijte pouze prosté číslo verze MediaWiki. |
deprecated | Verze, od které byl parametr zastaralý. Použijte pouze prosté číslo verze MediaWiki. |
removed | Verze, ve které byl parametr odstraněn. Použijte pouze prosté číslo verze MediaWiki. |
Příklady
*{{ApiParam|rcid|Jedna nebo více ID posledních změn, ze kterých lze přidat nebo odebrat značku.|maxallowed=50}}
rcid: Jedna nebo více ID posledních změn, ze kterých lze přidat nebo odebrat značku. Není povoleno více než 50 (pro roboty 500).
*{{ApiParam|siprop|Jaké vlastnosti získat|default=general}}
**{{ApiParam|general|Obecné informace o místě}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
siprop: Jaké vlastnosti získat (Výchozí: general)general: Obecné informace o místěarticlepath: $wgArticlePath 1.15+
Související odkazy
- {{Parameter}} – starší verze ApiParam