Template:ApiParam/uk
Appearance
Документація шаблону
- Розгляньте можливість заміни викликів цього шаблону на переключення Special:ApiHelp (завдання T89318), оскільки заповнення цього шаблону надмірно повторює документацію параметрів API у вихідному коді.
Використання
Цей шаблон можна використовувати для документування параметрів API. Його мета — гармонізувати зовнішній вигляд параметрів шаблону на всіх сторінках API.
{{ApiParam |name= |description= |required= |maxallowed= |maxallowedbot= |type= |values= |default= |version= |deprecated= |removed= }}
Параметри ApiParam | |
---|---|
Назва параметру | Опис |
name (або перший неназваний) |
Ім'я параметра (обов'язково). |
description (або другий неназваний) |
Опис параметра. |
required |
Вкажіть значення, якщо параметр є обов’язковим. Назва необхідного параметра буде виділено жирним шрифтом. |
maxallowed |
Максимально дозволений для значень або числових величин, розділених трубою. |
maxallowedbot |
Як і вище, для ботів. Якщо 50 або 500 використовується для maxallowed , за замовчуванням буде 500 або 5000 відповідно.
|
type |
Тип даних параметра. |
values |
Список можливих значень для параметра. |
default |
Значення за замовчуванням для параметра. |
version |
Версія, в якій введено параметр. Використовуйте лише звичайний номер версії MediaWiki. |
deprecated |
Версія, в якій параметр не підтримується. Використовуйте лише звичайний номер версії MediaWiki. |
removed |
Версія, в якій було вилучено параметр. Використовуйте лише звичайний номер версії MediaWiki. |
Приклади
*{{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 (500 для ботів).
*{{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 (За замовчуванням: general)general
: General site informationarticlepath
: $wgArticlePath 1.15+
Див. також
- {{Parameter }} – старіша версія ApiParam