Template:ApiParam/ko

틀 설명문서

Consider replacing invocations of this template with Special:ApiHelp transclusion (T89318), since filling in this template redundantly repeats API parameter documentation in source code.

사용법

This template can be used to document API parameters.

Its intent is to harmonize the appearance of template parameters across all of the API pages.

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

ApiParam 매개 변수
매개변수 이름	설명	Required?
name (or first unnamed)	The parameter name.	Required
description (or second unnamed)	A description of the parameter.	Optional
required	Specify a value if the parameter is required. The name of the required parameter will be bolded.	Optional
maxallowed	For pipe-separated values or numeric quantities, the maximum allowed.	Optional
maxallowedbot	As above, for bots. If 50 or 500 is used for maxallowed, this will default to 500 or 5000, respectively.	Optional
type	The data type of the parameter.	Optional
values	A list of possible values for the parameter.	Optional
default	The default value for the parameter.	Optional
version	The version the parameter was introduced in. Use the plain MediaWiki version number only.	Optional
deprecated	The version the parameter was deprecated in. Use the plain MediaWiki version number only.	Optional
removed	The version the parameter was removed in. Use the plain MediaWiki version number only.	Optional

예시

*{{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 information
    • articlepath: $wgArticlePath 1.15+

같이 보기

• {{Parameter }} – ApiParam의 이전 버전

편집자는 이 틀의 연습장 (만들기 | 미러)과 실험장 (만들기)에서 실험할 수 있습니다.
이 틀의 하위 문서