Template:Doc-apihelp-extended-description/doc
Appearance
This is the documentation subpage for the parent Template:Doc-apihelp-extended-description page.
- Usage:
- Documentation for all messages like "apihelp-*-extended-description".
- Parameters:
- First parameter is the "module path" of the API module, e.g. "query+backlinks".
- Optional parameter
description
allows for adjusting the descriptive text output by the template. - 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.
- Example:
{{Doc-apihelp-extended-description|1 = sample}}
generates:
- Usage:
- This is an extended description of the MediaWiki Action API for the “sample” module. See API:Main page at MediaWiki.org for general information. This message is typically displayed after the corresponding summary message.
- Parameters:
- $1 – Module parameter prefix, e.g. "bl".
- $2 – Module name, e.g. "backlinks".
- $3 – Module path, e.g. "query+backlinks".
- See also:
- For other messages relating to this module, see:
- Special:PrefixIndex/MediaWiki:apihelp-sample-param- for parameter descriptions.
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions.
{{Doc-apihelp-extended-description|1 = sample|params = * $1 – Extra first parameter|paramstart = 2}}
generates:
- Usage:
- This is an extended description of the MediaWiki Action API for the “sample” module. See API:Main page at MediaWiki.org for general information. This message is typically displayed after the corresponding summary message.
- Parameters:
- $1 – Extra first parameter
- $2 – Module parameter prefix, e.g. "bl".
- $3 – Module name, e.g. "backlinks".
- $4 – Module path, e.g. "query+backlinks".
- See also:
- For other messages relating to this module, see:
- Special:PrefixIndex/MediaWiki:apihelp-sample-param- for parameter descriptions.
- Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions.
- Maintenance:
- See also: