Template:Doc-apihelp-paramvalue
This is a MediaWiki Action API parameter value description for the value “” of the “” parameter to the “” module. See API:Main page at MediaWiki.org for general information.
Parameters:
- $1 – Module parameter prefix, e.g. "bl"
- $2 – Parameter name (without prefix), e.g. "title"
- $3 – Module name, e.g. "backlinks"
- $4 – Module path, e.g. "query+backlinks"
- $5 – Parameter value
Documentation for all messages like "apihelp-*-paramvalue-*-*".
Parameters
- First parameter is the "module path" of the API module, e.g. "query+backlinks". Second parameter is the name of the API module parameter. Third parameter is the value of the API module parameter.
- Optional parameter
descriptionallows for adjusting the descriptive text output by the template. - Optional parameter
infowill be displayed after the standard description, before the parameters. - Optional parameters
paramsandparamstartallow 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
seealsowill be displayed at the beginning of the "see also" list.
Examples
{{Doc-apihelp-paramvalue|sample|sampleparam|samplevalue}} generates:
This is a MediaWiki Action API parameter value description for the value “samplevalue” of the “sampleparam” parameter to the “sample” module. See API:Main page at MediaWiki.org for general information.
Parameters:
- $1 – Module parameter prefix, e.g. "bl"
- $2 – Parameter name (without prefix), e.g. "title"
- $3 – Module name, e.g. "backlinks"
- $4 – Module path, e.g. "query+backlinks"
- $5 – Parameter value
For other messages relating to this “sample” module, see :
- Apihelp-sample-param-sampleparam (page does not exist) for the description of the “sampleparam” parameter for this module.
- Apihelp-sample-description (page does not exist) for the deprecated combination of the summary and extra description for this module. It is now preferable to move this message into:
- Apihelp-sample-summary (page does not exist) for the one-line summary for this module (recommended now in all modules), and place any additional descriptive text for this module (if needed) into:
- Apihelp-sample-extended-description (page does not exist) (optional, may not exist in all modules).
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions (optional, may not exist in all modules).
{{Doc-apihelp-paramvalue|sample|sampleparam|samplevalue|paramstart = 2|description = value 'foo' for any 'sampleparam' parameter|params = * $1 - Extra first parameter}} generates:
This is a MediaWiki Action API parameter value description for value 'foo' 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"
- $6 – Parameter value
For other messages relating to this “sample” module, see :
- Apihelp-sample-param-sampleparam (page does not exist) for the description of the “sampleparam” parameter for this module.
- Apihelp-sample-description (page does not exist) for the deprecated combination of the summary and extra description for this module. It is now preferable to move this message into:
- Apihelp-sample-summary (page does not exist) for the one-line summary for this module (recommended now in all modules), and place any additional descriptive text for this module (if needed) into:
- Apihelp-sample-extended-description (page does not exist) (optional, may not exist in all modules).
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions (optional, may not exist in all modules).