Template:ApiParam/cs

Template documentation

Zvažte nahrazení vyvolání této šablony transkluzí Special:ApiHelp (<translate> task <tvar name=1>T89318</tvar></translate>), 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=
}}

Parametery 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|One or more recent changes IDs from  which to add or remove the tag.|maxallowed=50}}

<translate> <tvar <translate> No more than <tvar

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

<translate> <tvar1>{{{maxallowed}}}</> (<tvar (<translate> Default:</translate> general)
- <translate> <tvar1>{{{maxallowed}}}</> (<tvar
  - <translate> <tvar1>{{{maxallowed}}}</> (<tvar 1.15+

Související odkazy

{{Parameter }} – starší verze ApiParam