Template:Doc-apihelp-example/doc
This is the documentation subpage for the parent Template:Doc-apihelp-example page.
- Usage:
- Documentation for all messages like "apihelp-*-example-*".
- Parameters
- First parameter is the "module path" of the API module, e.g. "query+backlinks".
- 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-example|sample}}generates:
This is a MediaWiki Action API example description for the “sample” module. See API:Main page at MediaWiki.org for general information.
- Parameters :
- $1 – Module parameter prefix, e.g. "bl"
- $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 the summary description and additional descriptive text for this module
- MediaWiki:apihelp-sample-summary for the one-line summary for this module
- MediaWiki:apihelp-sample-extended-description for additional descriptive text for this module (optional, may not exist for all modules)
- Special:PrefixIndex/MediaWiki:apihelp-sample-param- for descriptions of parameters for this module (optional, may not exist for all modules)
{{Doc-apihelp-example|sample|paramstart = 2|params = * $1 - Extra first parameter}}generates:
This is a MediaWiki Action API example description for the “sample” module. See API:Main page at MediaWiki.org for general information.
- 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"
For other messages relating to this module, see :
- MediaWiki:apihelp-sample-description for the deprecated combination of the summary description and additional descriptive text for this module
- MediaWiki:apihelp-sample-summary for the one-line summary for this module
- MediaWiki:apihelp-sample-extended-description for additional descriptive text for this module (optional, may not exist for all modules)
- Special:PrefixIndex/MediaWiki:apihelp-sample-param- for descriptions of parameters for this module (optional, may not exist for all modules)
- Maintenance :
- See also :