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.

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

Parametry ApiParam
Název parametru	Popis	Povinné?
name (nebo první nejmenovaný)	Název parametru (povinný).	Požadované
description (nebo druhý nejmenovaný)	Popis parametru.	Volitelné
required	Pokud je parametr vyžadován, zadejte hodnotu. Název požadovaného parametru bude vyznačen tučně.	Volitelné
maxallowed	Maximální povolené hodnoty pro hodnoty oddělené svislou čarou nebo číselné veličiny.	Volitelné
maxallowedbot	Jak je uvedeno výše, pro roboty. Pokud je pro maxallowed použito 50 nebo 500, bude výchozí hodnota 500 nebo 5000.	Volitelné
type	Datový typ parametru.	Volitelné
values	Seznam možných hodnot pro parametr.	Volitelné
default	Výchozí hodnota parametru.	Volitelné
version	Verze, ve které byl parametr zaveden. Použijte pouze prosté číslo verze MediaWiki.	Volitelné
deprecated	Verze, od které byl parametr zastaralý. Použijte pouze prosté číslo verze MediaWiki.	Volitelné
removed	Verze, ve které byl parametr odstraněn. Použijte pouze prosté číslo verze MediaWiki.	Volitelné

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

S touto šablonou mohou editoři experimentovat na stránkách pískoviště (založit | kopie) a testovací případy (založit).
Podstránky této šablony.