Template:Doc-apihelp-param/doc
Appearance
This is the documentation subpage for the parent Template:Doc-apihelp-param page.
- Usage:
- Documentation for all messages like "apihelp-*-param-*".
- First parameter is the "module path" of the API module, e.g. "query+backlinks". Second parameter is the name of the API module parameter.
- Optional parameter
description
allows for adjusting the descriptive text output by the template. - Optional parameter
paramvalues
indicates that this message uses separate messages to describe each possible value of the parameter. - Optional parameter
info
will be displayed after the standard description, before the parameters. - Optional parameters
params
andparamstart
allow for prepending additional parameters to the list of parameters passed to the message. The first gives the wikitext for the additional parameters, while the second gives the number of the first standard parameter. - Optional parameter
seealso
will be displayed at the beginning of the "see also" list. - Do not translate string in var, kbd, samp and code tags.
- Maintenance:
- List of uses of this template with wrong parameter
- List of of uses of this template with missing parameter
- Examples:
{{Doc-apihelp-param|1 = sample|2 = sampleparam}}
generates:
This is a MediaWiki Action API parameter description for the "sampleparam" parameter to the "sample" module. See API:Main page at MediaWiki.org for general information.
- Parameters:
- $0 - Module parameter prefix, e.g. "bl"
- $1 - Parameter name (without prefix), e.g. "title"
- $2 - Module name, e.g. "backlinks"
- $3 - Module path, e.g. "query+backlinks"
For other messages relating to this module, see:
- MediaWiki:apihelp-sample-description for the deprecated combination of summary and extra description
- MediaWiki:apihelp-sample-summary for the one-line summary
- MediaWiki:apihelp-sample-extended-description for additional descriptive text
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions
{{Doc-apihelp-param|1 = sample|2 = sampleparam|description = any 'sampleparam' parameter|params = * $1 - Extra first parameter|paramstart = 2}}
generates:
This is a MediaWiki Action API parameter description for any 'sampleparam' parameter. See API:Main page at MediaWiki.org for general information.
- Parameters:
- $1 - Extra first parameter
- $2 - Module parameter prefix, e.g. "bl"
- $3 - Parameter name (without prefix), e.g. "title"
- $4 - Module name, e.g. "backlinks"
- $5 - Module path, e.g. "query+backlinks"
For other messages relating to this module, see:
- MediaWiki:apihelp-sample-description for the deprecated combination of summary and extra description
- MediaWiki:apihelp-sample-summary for the one-line summary
- MediaWiki:apihelp-sample-extended-description for additional descriptive text
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions