跳转到内容

模板:ApiParam/ja:修订间差异

来自天灾之下:危险连接资料站
wiki>Dataer
Created page with "パラメータ名"
 
小 导入1个版本
 
(没有差异)

2025年12月16日 (二) 16:39的最新版本


模板文档
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 parameters
パラメータ名 説明
name (or first unnamed) The parameter name (required).
description (or second unnamed) A description of the parameter.
required Specify a value if the parameter is required. The name of the required parameter will be bolded.
maxallowed For pipe-separated values or numeric quantities, the maximum allowed.
maxallowedbot As above, for bots. If 50 or 500 is used for maxallowed, this will default to 500 or 5000, respectively.
type The data type of the parameter.
values A list of possible values for the parameter.
default The default value for the parameter.
version The version the parameter was introduced in. Use the plain MediaWiki version number only.
deprecated The version the parameter was deprecated in. Use the plain MediaWiki version number only.
removed The version the parameter was removed in. Use the plain MediaWiki version number only.

例

*{{ApiParam|rcid|One or more recent changes IDs from which to add or remove the tag.|maxallowed=50}}
  • <translate> <tvar name=1>rcid</tvar>:</translate> One or more recent changes IDs from which to add or remove the tag. <translate> No more than <tvar name=1>50</tvar> (<tvar name=2>500</tvar> for bots) allowed.</translate>
*{{ApiParam|siprop|Which properties to get|default=general}}
**{{ApiParam|general|General site information}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
  • <translate> <tvar name=1>siprop</tvar>:</translate> Which properties to get (<translate> Default:</translate> general)
    • <translate> <tvar name=1>general</tvar>:</translate> General site information
      • <translate> <tvar name=1>articlepath</tvar>:</translate> $wgArticlePath 1.15+

関連項目

  • {{Parameter }} – ApiParam のより古いバージョン